mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 01:20:42 +00:00
baldurk
6b8ce92d88
* Also added a script that can run as part of CI to verify that the docstring matches, by generating a regex from the docstring documented parameter types and return type and making sure we find a match within the C headers. This ensures all parameters are documented with the right types, no extra parameters are documented, and the return type is correct. * The script also checks proper scoping so that if qrenderdoc docstrings mention a renderdoc type, they need to scope it properly.
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.