Files
docs_src
Folders and files
Name | Name | Last commit date | ||
---|---|---|---|---|
parent directory.. | ||||
# How to generate the documentation ## Installation Install python libraries: ``` pip install sphinx pip install sphinx_rtd_theme ``` In the current package library directory (for which we want to generate the python documentation), load the package in development mode: ``` pip install -e . ``` ## Generate the documentation ``` make autogen html ``` Copy the files in `_build/html` in the `docs` directory at the root of the project. Make sure you have an empty file named `.nojekyll` in the `docs` directory ## Update copyright year and version number Version number is defined in `conf.py` file Copyright year is to be updated in `conf.py` and `license.rst`