mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-04 17:10:47 +00:00

Files

T

baldurk 81b4d3d804 Add public domain md5 library and implement modified DXBC container hash

* This allows us to disabled any requirement for "experimental shaders".

2021-07-07 19:18:32 +01:00

behind_scenes

Rename 'draw' or 'drawcall' to action

2021-07-01 15:15:05 +01:00

CONTRIBUTING

Update IRC details to point to OFTC

2021-06-15 11:26:58 +01:00

getting_started

Update documentation for event browser changes

2021-07-01 19:27:34 +01:00

how

Update documentation for event browser changes

2021-07-01 19:27:34 +01:00

imgs

Update documentation for event browser changes

2021-07-01 19:27:34 +01:00

include

…

pycharm_helpers

Add documentation on setting up python dev environment

2021-01-27 16:05:03 +00:00

python_api

Rename 'name' member of ActionDescription to 'customName'

2021-07-01 15:15:05 +01:00

sphinx_exts/sphinx_paramlinks

Fix sphinx-paramlinks for sphinx 4.0.0

2021-05-10 17:02:48 +01:00

sphinx_rtd_theme_chm_friendly

Remove navigation elements on embedded help builds (like htmlhelp)

2021-05-10 17:02:49 +01:00

window

Fix mistaken reference in documentation

2021-07-01 20:29:37 +01:00

CODE_OF_CONDUCT.md

…

conf.py

Print renderdoc and qrenderdoc module locations

2021-02-14 15:45:57 +00:00

CONTRIBUTING.md

Clarify acceptable use for issues and support even further

2021-01-22 13:23:53 +00:00

credits_acknowledgements.rst

Add public domain md5 library and implement modified DXBC container hash

2021-07-07 19:18:32 +01:00

in_application_api.rst

Rename 'draw' or 'drawcall' to action

2021-07-01 15:15:05 +01:00

index.rst

…

introduction.rst

Make some misc tweaks and updates to the docs

2021-06-29 16:55:53 +01:00

make.bat

…

make.sh

…

Makefile

…

README.md

…

remove_lines.py

…

renderdoc.hhk

Rename 'draw' or 'drawcall' to action

2021-07-01 15:15:05 +01:00

verify-docstrings.py

Handle rdcstrpair or rdcstrpairs in function return types for docstrings

2021-05-17 15:05:13 +01:00

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.