Jasen Documentation

Nextflow documentation is written using Sphinx, MyST which is an extended version of Markdown for Sphinx, and the Read The Docs theme for Sphinx.

Dependencies

The most convenient approach is to create a Conda environment with Python 3.11 (other versions may work but haven't been tested).

The build dependencies can be installed with pip:

cd docs
pip install -r requirements.txt

Alternatively, you can use the Dockerfile to build the docs in a container (see below).

To edit and contribute to the documentation, you only need a text editor to change the appropriate .md files in this directory.

Once you have made your changes, run the following command to build the HTML files:

make clean html

Then start up a local http server and open localhost:8080 in your browser to verify the changes:

python -m http.server 8080 --directory build/html/