This documentation resource is now built from Markdown source material, in a new repository.
Documentation for MGnify: the EBI Metagenomics resource
This repository contains the source of MGnify’s documentation.
The readable documentation is hosted on ReadTheDocs.
We welcome suggestions for and issues with the documentation as GitHub Issues.
For questions about MGnify itself, please contact us via the EBI Helpdesk.
Check out this repository.
You can use sphinx-autobuild to watch the docs/ folder for changes as you save files, rebuild the documentation, and serve it with a local web server.
# (optionally set up a virtual environment or conda environment)
pip install -r requirements-dev.txt
sphinx-autobuild docs docs/_build/htmlBrowse to the local webserver
The Sphinx RST Documentation is a good place to start if you are not familiar with RST syntax.