mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-05 09:30:44 +00:00

Files

T

baldurk 8b851679a8 Fix remove_lines.py script to explicitly read input as cp1252

* The output from sphinx is in cp1252 for CHM builds, which is the only place
  this script is used. Trying to read it as UTF-8 will fail on non-ASCII
  characters.

2020-01-08 19:10:52 +00:00

behind_scenes

Explicitly report sparse features as unsupported on vulkan

2019-12-11 15:28:38 +00:00

CONTRIBUTING

Add note to CONTRIBUTING guidelines about avoiding STL use

2019-12-16 18:10:32 +00:00

getting_started

Update Vulkan features with VK_EXT_debug_utils

2019-10-25 16:53:29 +01:00

how

Add documentation for replay options

2019-08-27 18:51:57 +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

Ensure only one sphinx module:: directive exists

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

sphinx_exts/sphinx_paramlinks

Fix sphinx-paramlinks to work with older versions of sphinx

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

sphinx_rtd_theme_chm_friendly

Add trailing / needed on the end of canonical_url for docs

2019-02-07 16:56:19 +00:00

window

Fix xuint -> xint typo in documentation

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

CODE_OF_CONDUCT.md

Move CODE_OF_CONDUCT.md file into docs/ subfolder

2018-09-17 16:50:47 +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 mention of Stadia support to README and docs

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

in_application_api.rst

Add experimental wayland support. Refs #853

2019-09-02 15:02:27 +01:00

index.rst

Tidy up python documentation and add examples

2018-06-15 19:44:37 +01:00

introduction.rst

…

issue_template.md

Tweak issue template for clarity

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

make.bat

…

make.sh

Improve docs build script to work on Windows 10 WSL

2018-08-20 11:57:01 +01:00

Makefile

Improve docs build script to work on Windows 10 WSL

2018-08-20 11:57:01 +01:00

pull_request_template.md

Split up CONTRIBUTING.md and move it under docs/

2018-09-17 17:31:05 +01:00

README.md

Add tests for viewing depth with ClearBeforeDraw.

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

remove_lines.py

Fix remove_lines.py script to explicitly read input as cp1252

2020-01-08 19:10:52 +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.