Public repository for misc experiments
The build script runs python tests and matlab tests each time when someone pushes new code to this repository. See .travis.yml script for build configuration.
The online documentation for this repository is written in reST (reStructuredText) [1] using Sphinx documentation system [2] and Read the Docs [3].
To create an HTML version of the docs:
-
Install Sphinx (using
sudo pip install Sphinx
or some other method) -
Install readthedocs theme (using
sudo pip install sphinx_rtd_theme
or some other method) -
From
docs/
directory, typemake html
The documentation in docs/_build/html/index.html
can then be viewed in a web browser.