Name: intermine-user-docs
Owner: InterMine
Description: Documentation for using an InterMine webapp.
Created: 2014-03-26 11:37:49.0
Updated: 2016-12-12 14:30:35.0
Pushed: 2017-05-10 11:06:15.0
Homepage: null
Size: 27205
Language: CSS
GitHub Committers
| User | Most Recent Commit | # Commits |
|---|
Other Committers
| User | Most Recent Commit | # Commits |
|---|
Documentation for using an InterMine webapp.
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.
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 are required, and we recommend using virtualenv to manage dependencies:
Setting up:
ocs
ualenv .
ce ./bin/activate
install -r requirements.txt
Building the docs:
the docs directory
html
The source for the Sphinx documentation theme can be found in the intermine/design-materials repo.