Sphinx Documentation

Generating the documentation

• To generate the documentation files, you will need to install Sphinx using

  sudo apt install python-sphinx
  

  Then you can generate the documentation files with the following command

cd GEOSX/build-your-platform-release
make geosx_docs

• That will create a new folder

  GEOSX/build-your-platform-release/html/docs/sphinx
  

which contains all the html files generated.

Documenting the code

The documentation is generated from restructured text files (.rst). Most files can be found in src/docs/sphinx. Files which are specific to parts of the code, like those describing a specific class, can instead be found in docs subdirectory in the folder containing the source code.

Information about how to write rst files can be found here .