16.2.3. Developing Documentation
16.2.3.1. Setting Up Sphinx
The Sundials documentation is generated by Sphinx. To set up Sphinx locally, run the following commands:
$ cd doc
$ pip install -r requirements.txt
Running the above will install the necessary Sphinx version. A Python virtual environment can also be used by activating the environment before running the above commands.
16.2.3.2. Building and Running Documentation Locally
To build the general documentation (also viewable from here), run the following:
$ cd doc/superbuild
$ make html
To build the developer documentation, run the following:
$ cd doc/sundials_developers
$ make html
To run documentation locally, open build/html/index.html.
On Windows, use the following command:
$ start build/html/index.html
On Mac, use the following command:
$ open build/html/index.html
On Linux, use the following:
$ xdg-open build/html/index.html