mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 17:40:39 +00:00
baldurk
df6fec13f9
* One automodule in a file for our modules is way too much, so we split it into files. Unfortunately this means that only one file can have those classes and functions be linkable from elsewhere. * Instead we bite the bullet and manually curate the items into pages, and at the same time subdivide the 'enums and data' page more which is a general readability and usability win as well. * We also add some previously not-included functions, and add a doc-build time check to ensure that functions and classes aren't omitted from the documentation in future
RenderDoc documentation
This readme only covers the documentation. For general information about renderdoc check out the main github repository.
Generating documentation
Generating the documentation requires the same python version as was used to build the version of RenderDoc you are testing. On windows this is likely python 3.6 as that's what comes with the repository.
The documentation uses restructured text with Sphinx. Sphinx can be acquired via pip install Sphinx
To generate the documentation, run make.bat or make.sh found in this folder. Run make help to see all options, but make html is a likely place to start.
License
RenderDoc is released under the MIT license, see the main github repository for full details.
The documentation uses Sphinx, which is BSD licensed.