mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-05 01:20:42 +00:00
follower
3471e64c8f
The current link appears to be an accidental duplication of the URL from the project listed immediately above. This commit appears to be the origin of the duplicated URL: https://github.com/baldurk/renderdoc/commit/b5c7944038572eebffde32e1279c45c4f6d84153#diff-4673a3aba01813b595de187a7a6e9e63a3491d55821606fecd9f13a10c188a1dL98 Note: This "correct" link is to the original repository URL which appears to no longer exist. For reference: * Original commit with the inclusion of `include-bin`: https://github.com/baldurk/renderdoc/commit/864fdbe179b6c1f20cae7c753fb018bec74b5738 * Original issue which lead to the inclusion: https://github.com/baldurk/renderdoc/issues/314#issuecomment-238204556
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.