mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 17:10:47 +00:00
baldurk
d0accc409b
* This is a deliberate break of compatibility since the field is now often empty, for non-markers. This means code will get a more explicit error when the name is being referenced, so it can be updated to fetch the name it needs as needed.
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.