Gut-to-soil microbiome axis tutorial source 💩🌱

The built documentation can be found at https://gut-to-soil-tutorial.readthedocs.io/en/latest/.

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.

cd gut-to-soil-tutorial
conda env create -n gut-to-soil-tutorial --file environment-files/readthedocs.yml
conda activate gut-to-soil-tutorial
q2doc refresh-cache

Build the book

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

Have fun!