Automatic Documentation

To compile the docs yourself you have to install:

• Sphinx (pip install sphinx)
• the ReadTheDocs theme (pip install sphinx_rtd_theme)
• Napoleon (for Numpy like doc-string: pip install sphinxcontrib-napoleon)

Then:

• cd into ./docs
• call: make clean html

This will generate new html pages in _build

If you want to add a new file you have to add a .rst file or edit an existing .rst file in the doc-folder with the following content:

evcouplings\.<folder-name> package
==================================


evcouplings\.<folder-name>\.<file-name> module
----------------------------------------------
.. automodule:: evcouplings.<folder-name>.<file-name>
    :members:
    :undoc-members:
    :show-inheritance:

You also have to manually add the new .rst file in evcouplings.rst