Skip to content

Files

Latest commit

6de0787 · Jan 30, 2024

History

History
This branch is 1800 commits behind baldurk/renderdoc:v1.x.

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 13, 2023
Mar 31, 2023
Dec 9, 2023
Nov 16, 2023
Dec 9, 2023
Oct 28, 2022
Jan 27, 2021
Jan 30, 2024
May 10, 2021
May 1, 2023
Jan 26, 2024
Jun 12, 2020
Sep 5, 2023
Aug 20, 2018
Dec 20, 2019
Feb 2, 2023
Sep 28, 2023
Nov 21, 2022
Jun 15, 2018
Jun 29, 2021
Sep 27, 2016
Mar 9, 2020
Mar 9, 2020
May 20, 2022
May 17, 2021

README.md

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.