mirror of
https://github.com/baldurk/renderdoc.git
synced 2026-05-04 09:00:44 +00:00
baldurk
99adcc614f
* When a port is specified (with the usual :12345 suffix on the hostname) we use that for remote replay connections. We disable target control enumeration since that requires a port _range_ and captured applications self-assign those ports. Those can still be accessed via a normal unsuffixed remote specifier - even if there is no remote server running on the default port.
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.