Documentation

Documentation#

We use Doxygen for generating the C++ documentation and Sphinx for the remaining parts. Thus, if you would like to contribute here, we recommend to do a local build of the documentation on your computer and to see how your changes will look like in the end.

For building, the following tools along with their versions are required:

Doxygen 1.9.6, which will be automatically built from source if that exact version is not found on your system (requires Bison and Flex utilites)
Sphinx including some extensions, which can all be installed by
```
pip install -r docs/requirements.txt
```

When these documenation dependencies are installed, you can build the documentation using the following command/script:

Direct Command

cmake --build build --target stdgpu_doc --parallel 8

Provided Script

bash tools/dev/build_documentation.sh

Note

The STDGPU_BUILD_DOCUMENTATION option must be enabled for this purpose, e.g. via -D<option>=<value>, see Configuration Options.

Afterwards, you can view the generated documentation by opening the build/docs/html/index.html file in your browser.