PyXOpto documentation

This is Sphinx-based documentation. Follow these steps to build the documentation from source.

Full build / rebuild of the HTML documentation

First, render the documentation templates by running the following command from the root documentation directory (the one that includes the conf.py and render.py files):

python render.py

The next step will process the python source files of the PyXOpto project.

Linux OS

Run custom_build.sh from the root directory of documentation (the one with the custom_build.sh file).

./custom_build.sh

Windows OS

Run custom_build.bat from the root directory of documentation (the one with the custom_build.bat file).

custom_build.bat

This will build / extract the documentation from the Python source code and create a number of .rst files in the apidoc directory and finally build the HTML documentation.

Rebuilding after changing documents in the source directory

When rebuilding the documentation due to changes of documents in the source directory, it is sufficient to run make html.

make html

This will take the existing files from the apidoc directory and updated the HTML in a fraction of time required by the full build. Note that any changes to the documentation in the source code of PyXOpto will not be visible in the HTML.

If any of the documentation template files listed in :py:mod:`render.py` are changed, the templates need to be reprocessed and the HTML rebuild:

python render.py
make html