BioContainers Documentation

The BioContainers documentation is generated using readthedocs and sphinx. The final version of the documentation is deployed in: https://biocontainers-edu.readthedocs.io/en/latest/

If you want to contribute with the documentation please do a Pull Request (PR) in the branch read_docs.

The documentation source files .rst are stored in the docs folder.

If you want to build the project locally, you need to follow these steps:

First Steps with Sphinx

Install Sphinx, either from a distribution package or from PyPI with

$ pip install Sphinx

To build HTML docs in the build directory you chose. Execute make without an argument to see which targets are available.

$ make html