diff --git a/docs/python_api/enums_data.rst b/docs/python_api/base/enums_data.rst similarity index 59% rename from docs/python_api/enums_data.rst rename to docs/python_api/base/enums_data.rst index 6fc7f44a7..2483880ad 100644 --- a/docs/python_api/enums_data.rst +++ b/docs/python_api/base/enums_data.rst @@ -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 diff --git a/docs/python_api/funcs.rst b/docs/python_api/base/funcs.rst similarity index 98% rename from docs/python_api/funcs.rst rename to docs/python_api/base/funcs.rst index 05faca923..cc64c4d52 100644 --- a/docs/python_api/funcs.rst +++ b/docs/python_api/base/funcs.rst @@ -34,7 +34,7 @@ Local Execution & Injection .. autofunction:: renderdoc.IsGlobalHookActive .. autofunction:: renderdoc.CanGlobalHook -Logging & Versioning +Logging & Versioning -------------------- .. autofunction:: renderdoc.SetDebugLogFile diff --git a/docs/python_api/base/index.rst b/docs/python_api/base/index.rst new file mode 100644 index 000000000..6cabc635b --- /dev/null +++ b/docs/python_api/base/index.rst @@ -0,0 +1,9 @@ +Base API +======== + +.. toctree:: + main_ifaces + funcs + enums_data + pipelines/index + diff --git a/docs/python_api/main_ifaces.rst b/docs/python_api/base/main_ifaces.rst similarity index 100% rename from docs/python_api/main_ifaces.rst rename to docs/python_api/base/main_ifaces.rst diff --git a/docs/python_api/pipelines/d3d11.rst b/docs/python_api/base/pipelines/d3d11.rst similarity index 100% rename from docs/python_api/pipelines/d3d11.rst rename to docs/python_api/base/pipelines/d3d11.rst diff --git a/docs/python_api/pipelines/d3d12.rst b/docs/python_api/base/pipelines/d3d12.rst similarity index 100% rename from docs/python_api/pipelines/d3d12.rst rename to docs/python_api/base/pipelines/d3d12.rst diff --git a/docs/python_api/pipelines/gl.rst b/docs/python_api/base/pipelines/gl.rst similarity index 100% rename from docs/python_api/pipelines/gl.rst rename to docs/python_api/base/pipelines/gl.rst diff --git a/docs/python_api/pipelines/index.rst b/docs/python_api/base/pipelines/index.rst similarity index 100% rename from docs/python_api/pipelines/index.rst rename to docs/python_api/base/pipelines/index.rst diff --git a/docs/python_api/pipelines/vulkan.rst b/docs/python_api/base/pipelines/vulkan.rst similarity index 100% rename from docs/python_api/pipelines/vulkan.rst rename to docs/python_api/base/pipelines/vulkan.rst diff --git a/docs/python_api/index.rst b/docs/python_api/index.rst index aaf794d4b..25cf56b9d 100644 --- a/docs/python_api/index.rst +++ b/docs/python_api/index.rst @@ -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 isn’t 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 diff --git a/docs/python_api/qrenderdoc/index.rst b/docs/python_api/qrenderdoc/index.rst index 3b2393252..2e091e535 100644 --- a/docs/python_api/qrenderdoc/index.rst +++ b/docs/python_api/qrenderdoc/index.rst @@ -2,7 +2,7 @@ QRenderDoc ========== .. toctree:: - main - windows - config - pipeline + main + windows + config + pipeline