Name		Name	Last commit message	Last commit date
parent directory ..
_static		_static
_templates		_templates
doctests		doctests
images		images
LICENCE.txt		LICENCE.txt
Makefile		Makefile
README.md		README.md
amazons3.rst		amazons3.rst
aws.rst		aws.rst
azure.rst		azure.rst
basic.rst		basic.rst
channel.rst		channel.rst
cli.rst		cli.rst
conda.rst		conda.rst
conf.py		conf.py
config.rst		config.rst
container.rst		container.rst
dnanexus.rst		dnanexus.rst
dsl2.rst		dsl2.rst
example.rst		example.rst
executor.rst		executor.rst
faq.rst		faq.rst
getstarted.rst		getstarted.rst
google.rst		google.rst
ignite.rst		ignite.rst
index.rst		index.rst
kubernetes.rst		kubernetes.rst
mail.rst		mail.rst
metadata.rst		metadata.rst
metrics.rst		metrics.rst
operator.rst		operator.rst
plugins.rst		plugins.rst
process.rst		process.rst
script.rst		script.rst
secrets.rst		secrets.rst
sharing.rst		sharing.rst
sync-doc.sh		sync-doc.sh
tracing.rst		tracing.rst

README.md

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 clean html

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

Dependencies

Sphinx can be installed either with

pip install -U sphinx==3.5.4

or

conda install sphinx==3.5.4

Theme

Nextflow documentation uses the Read The Docs theme for Sphinx theme.

In order to build the document install the Read The Docs theme using the command:

pip install sphinx_rtd_theme

License

Nextflow documentation is distributed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.