Building MGET’s documentation

MGET uses Sphinx to automate the production of HTML documentation with the Read the Docs theme. After building MGET as a Python wheel and installing it, using the same virtual environment you used to build MGET, make sure you’re in the MGET repo’s root directory and then execute:

cd doc/GeoEco
make html

Assuming no errors occur, the root page of the documentation will be _build/html/Index.html. Open it in your browser to view the documentation.

If you make a code change and want to build the documentation again, just run make html again. This should rebuild only the files necessary to account for your change. However, Sphinx often cannot determine all of the documentation files that need to rebuilt, necessitating a rebuild from scratch in order for your change to be picked up. To rebuild from scratch, first run make clean prior to running make html.