intermine.org

Documentation for the InterMine project.

Documentation

The HTML documentation is generated from RST source, using a Python static site generator called Sphinx. RST stands for reStructuredText (see reference). When you push to the GitHub repo for these docs, this triggers a new build of the documentation site, where the changes will be visible within a few minutes. This process is managed by ReadTheDocs, an online service for maintaining documentation.

Building locally

You should build locally before you push, to make sure your changes are correct. You will need the Sphinx environment for this. Make and Python 2.7 are required, and we recommend using Conda to manage dependencies:

Setting up:

cd docs
conda create -n im-docs python=2.7
conda activate im-docs
pip install -r requirements.txt
conda install sphinx

Building the docs:

# In the docs directory
make html

Theming

The source for the Sphinx documentation theme can be found in the intermine/design-materials repo.