moshpit-docs

MOSHPIT plugin suite documentation

Development instructions

The following sub-sections illustrate how to develop this documentation.

Create the development environment

To build this documentation locally for development purposes, first create your development environment.

conda env create -n moshpit-docs --file environment-files/readthedocs.yml
conda activate moshpit-docs
q2doc refresh-cache

Build the book

Generate the artifact/type references:

make autodoc

Next, build the book:

make html

(Alternatively, make preview or make fast-preview can speed up test builds.)

Serve the book locally

Finally, run the following to serve the built documentation locally:

make serve