The syntax in the text pages is ReStructured Text
format.
see this page for examples of the syntax, and this one for a more comprehensive explanation of
the syntax.
The syntax chosen for the auto-documentation of the Python module is Google Docstring
syntax.
see the google Docstring example in the Sphinx-napoleon package.
- Install
sphinx
package and the requirements written in the filesource/requirements.txt
of provided with the sources ofPyBigDFT
.- Copy the quick build file
Makefile-sphinxbuild
of thePyBigDFT
source directory intoMakefile
- Run the command
make html
- The documentation of the package can be explored starting from the file
build/html/index.html
.