Re-organise and tidy python API documentation

This commit is contained in:
baldurk
2017-12-22 12:00:42 +00:00
parent 417a811fad
commit 691f91c9aa
11 changed files with 20 additions and 10 deletions
@@ -5,4 +5,4 @@ Enums and Data Structures
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11, name_match__startswith__D3D12, name_match__startswith__VK, name_match__startswith__GL, str, ReplayController, ReplayOutput, TargetControl, RemoteServer, CaptureFile
:exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11, name_match__startswith__D3D12, name_match__startswith__VK, name_match__startswith__GL, name_match__startswith__rdcarray_of, rdcstr, bytebuf, ReplayController, ReplayOutput, TargetControl, RemoteServer, CaptureFile
@@ -34,7 +34,7 @@ Local Execution & Injection
.. autofunction:: renderdoc.IsGlobalHookActive
.. autofunction:: renderdoc.CanGlobalHook
Logging & Versioning
Logging & Versioning
--------------------
.. autofunction:: renderdoc.SetDebugLogFile
+9
View File
@@ -0,0 +1,9 @@
Base API
========
.. toctree::
main_ifaces
funcs
enums_data
pipelines/index
+5 -4
View File
@@ -1,9 +1,10 @@
Python API
==========
The python API is accessible via scripting in the QRenderDoc tool. This gives access to both the base replay API that the UI is built on top of, as well as scripting ability for the UI itself and some higher level utility functionality.
It is also possible to build a standalone module of just the base API which can be loaded into python and used for scripting directly without the UI. Due to the inherent difficulty of distributing C python modules this isnt included by default in distributed builds at the time of writing, but is generated by default in source builds - ``renderdoc.py`` and ``_renderdoc.dll`` or ``_renderdoc.so`` make up this module.
.. toctree::
main_ifaces
funcs
enums_data
pipelines/index
base/index
qrenderdoc/index
+4 -4
View File
@@ -2,7 +2,7 @@ QRenderDoc
==========
.. toctree::
main
windows
config
pipeline
main
windows
config
pipeline