Skip to content

Files

This branch is 2 commits ahead of, 5299 commits behind baldurk/renderdoc:v1.x.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Jan 27, 2020
Jan 15, 2020
Feb 21, 2020
Aug 27, 2019
Jul 22, 2019
Mar 20, 2019
Apr 7, 2020
Apr 6, 2020
Mar 9, 2020
Feb 13, 2020
Sep 17, 2018
Oct 28, 2019
Aug 20, 2018
Dec 20, 2019
Oct 9, 2019
Mar 23, 2020
Jan 30, 2020
Jun 15, 2018
Feb 25, 2018
Jan 6, 2020
Sep 27, 2016
Mar 9, 2020
Sep 17, 2018
Mar 9, 2020
Mar 8, 2019

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.