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

Files

T

baldurk e05224753c Adopt v2.0 of the contributor covenant

* This better details the inclusionary community desired and has more specific
  additional language on how the code of conduct will be enforced as needed.
* In addition the file is copied to the .github folder for additional
  visibility.

2020-06-12 13:40:02 +01:00

behind_scenes

Update docs about D3D12 shader debugging support

2020-05-15 19:03:00 +01:00

CONTRIBUTING

Switch from travis/appveyor to github actions for CI

2020-06-11 22:42:44 +01:00

getting_started

Update docs about D3D12 shader debugging support

2020-05-15 19:03:00 +01:00

how

Update docs about D3D12 shader debugging support

2020-05-15 19:03:00 +01:00

imgs

Explain the background colour for view-important pipeline state bindings

2019-07-22 14:52:42 +01:00

include

Add mention of Stadia support to README and docs

2019-03-20 05:32:53 +00:00

python_api

Update examples to latest python API

2020-05-20 11:51:52 +01:00

sphinx_exts/sphinx_paramlinks

Add sphinx_paramlinks fixes for sphinx 3.1

2020-06-08 18:26:12 +01:00

sphinx_rtd_theme_chm_friendly

Fix search in chm-friendly RTD theme

2020-06-05 12:24:33 +01:00

window

Add a global font scale option in settings window

2020-02-13 11:01:45 +00:00

CODE_OF_CONDUCT.md

Adopt v2.0 of the contributor covenant

2020-06-12 13:40:02 +01:00

conf.py

Ensure PersistantConfig member functions are documented

2019-10-09 10:25:49 +01:00

CONTRIBUTING.md

Add guidance on filing good issues, and update issue template

2019-10-28 18:00:25 +00:00

credits_acknowledgements.rst

Add Steve Karolewics to credits document

2020-05-12 19:04:57 +01:00

in_application_api.rst

Rename Shutdown to RemoveHooks in in-application API. Version is 1.4.1

2020-01-30 13:02:23 +00:00

index.rst

…

introduction.rst

…

issue_template.md

Tweak issue template for clarity

2020-01-06 16:20:44 +00:00

make.bat

…

make.sh

Fix some encoding issues with sphinx docs in htmlhelp builder

2020-03-09 10:57:05 +00:00

Makefile

…

pull_request_template.md

…

README.md

Add tests for viewing depth with ClearBeforeDraw.

2019-12-20 20:11:53 +00:00

remove_lines.py

Fix some encoding issues with sphinx docs in htmlhelp builder

2020-03-09 10:57:05 +00:00

renderdoc.hhk

Rename Mesh Output panel to Mesh Viewer, since it displays inputs too

2019-03-08 15:40:11 +00: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.