Installation ************ Local ===== Contribute to documentation =========================== Installation ------------ :: source activate ENV_NAME pip install -U Sphinx pip install sphinx_bootstrap_theme Build ----- To build the documentation you just need to be in the ``deephyper/doc`` folder and run ``make html`` assuming you have MakeFile installed on your computer. Then you can see the build documentation inside the ``doc/_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 : ============= ============= Extensions --------------------------- 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.