Nextflow Documentation

Nextflow documentation is written using Sphinx which uses the reStructuredText file format.

A quick intro to reStructuredText is available at this link.

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

Once you have edited the documentation files verify the your changes are correctly applied using the command below to generate the HTML files:

make html

Then open the _build/html/index.html file with your browser and navigate the documentation you have modified.

Sphinx can be installed either with

pip install -U Sphinx

or

conda install sphinx

Provide feedback