Building the documentation¶
Requirements¶
To be able to build the documentation, the following libraries are required:
Installing all of these extensions can be easily done using the following command:
pip install sphinx sphinxcontrib-bibtex sphinx_rtd_theme
Creating HTML¶
To build the HTML documentation, execute:
cd docs
make html
This executes sphinx and the documentation will be generated in the docs/build directory. To open the documentation:
open build/html/index.html
Creating PDF¶
To build the PDF documentation, execute:
make latexpdf
This creates foamgen.pdf
in build/latex directory.
Documentation guidelines¶
Google style is followed in the documentation of the source code.