ytopt can be installed on your local machine using conda.

conda create -n ytopt -c anaconda python=3.6 source activate ytopt git clone cd ytopt/ pip install -e .

Contribute to documentation


source activate ENV_NAME pip install -U Sphinx pip install sphinx_bootstrap_theme


To build the documentation you just need to be in the ytopt/docs directory and run make html assuming you have MakeFile installed on your computer. Then you can see the build documentation inside the docs/_build folder just by opening the index.html file with your web browser.

Useful informations

The documentation is made with Sphinx and the following extensions are used:

Name Description
autodoc automatically insert docstrings from modules
napoleon inline code documentation
doctest automatically test code snippets in doctest blocks
intersphinx link between Sphinx documentation of different projects
todo write “todo” entries that can be shown or hidden on build
coverage checks for documentation coverage
mathjax include math, rendered in the browser by MathJax
ifconfig conditional inclusion of content based on config values
viewcode include links to the source code of documented Python objects
githubpages create .nojekyll file to publish the document on GitHub pages

Sphinx uses reStructuredText files, click on this link if you want to have an overview of the corresponding syntax and mechanism.

Our documentation try to take part of the inline documentation in the code to auto-generate documentation from it. For that reason we highly recommend you to follow specific rules when writing inline documentation :