Other

Generating the Documentation

The documentation for pygeostat requires Sphinx and Sphinx readthedocs theme. The advanced plotting and data management sections additionally require Pandoc. Pandoc can be installed from http://pandoc.org/installing.html.

In line documentation from modules are used and require special formating. Examples of this formating can be found within pygeostat modules or at: https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google

The final documents can be built using the makefile by calling:

$ cd pygeostat/doc
$ make html