mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-08-29 01:46:38 +00:00
baldurk
5b90b75b79
* The docs now explicitly tell people how to write UI scripts, then UI extensions, with as quick a start as possible, and go into detail in later documents. Use of the python module directly is also not featured prominently as this is a rare use-case for casual scripting needs.
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.