1. Building the Sphinx documentation

To build a local version of sw2d’s HTML documentation, you first need to install sphinx and the RTD theme. It will be automatically installed if you are on sw2d environment.

On Linux or Mac, open a shell prompt go to the build folder (typically sw2d/build/) and type:

$ conda activate sw2d
$ cmake -DBUILD_DOC=TRUE -DCMAKE_PREFIX_PATH=$CONDA_PREFIX ..
$ make doc

On windows, you can do:

$ conda activate sw2d
$ cmake .. -G "Visual Studio 15 2017 Win64" -DCMAKE_PREFIX_PATH=$CONDA_PREFIX -DBUILD_DOC=TRUE
$ cmake --build . --target doc

Warning

This will also generate the various figures included in this documentation! This may take some time and resources.

1.1. View the Generated documentation

To view the generated documentation, open the file: sw2d/build/doc/html/index.html