diff --git a/docs/python_api/qrenderdoc/config.rst b/docs/python_api/qrenderdoc/config.rst index 2b2e5d0258..912704f7bb 100644 --- a/docs/python_api/qrenderdoc/config.rst +++ b/docs/python_api/qrenderdoc/config.rst @@ -1,7 +1,10 @@ -Persistant Config -================= +API Reference: qrenderdoc Persistant Config +=========================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``qrenderdoc`` module which represents the UI-specific interface for integrating with the UI and writing UI extensions. For more high-level information and instructions on using the python API, see :doc:`../index` and :doc:`../ui_extensions`. + +.. contents:: Sections + :local: .. currentmodule:: qrenderdoc diff --git a/docs/python_api/qrenderdoc/extensions.rst b/docs/python_api/qrenderdoc/extensions.rst index b446d6d045..b9e18ec41e 100644 --- a/docs/python_api/qrenderdoc/extensions.rst +++ b/docs/python_api/qrenderdoc/extensions.rst @@ -1,7 +1,10 @@ -UI Extensions -============= +API Reference: qrenderdoc UI Extensions +======================================= -.. contents:: +This is the API reference for the functions, classes, and enums in the ``qrenderdoc`` module which represents the UI-specific interface for integrating with the UI and writing UI extensions. For more high-level information and instructions on using the python API, see :doc:`../index` and :doc:`../ui_extensions`. + +.. contents:: Sections + :local: .. currentmodule:: qrenderdoc diff --git a/docs/python_api/qrenderdoc/index.rst b/docs/python_api/qrenderdoc/index.rst index 4e5417125d..2789a9df77 100644 --- a/docs/python_api/qrenderdoc/index.rst +++ b/docs/python_api/qrenderdoc/index.rst @@ -1,6 +1,8 @@ -qrenderdoc API Reference +qrenderdoc python module ======================== +This is the API reference for the functions, classes, and enums in the ``qrenderdoc`` module which represents the UI-specific interface for integrating with the UI and writing UI extensions. For more high-level information and instructions on using the python API, see :doc:`../index` and :doc:`../ui_extensions`. + .. toctree:: :hidden: diff --git a/docs/python_api/qrenderdoc/main.rst b/docs/python_api/qrenderdoc/main.rst index 6a6ea6c1c2..61749c7e2b 100644 --- a/docs/python_api/qrenderdoc/main.rst +++ b/docs/python_api/qrenderdoc/main.rst @@ -1,7 +1,10 @@ -Main Interfaces -=============== +API Reference: qrenderdoc Main Interfaces +========================================= -.. contents:: +This is the API reference for the functions, classes, and enums in the ``qrenderdoc`` module which represents the UI-specific interface for integrating with the UI and writing UI extensions. For more high-level information and instructions on using the python API, see :doc:`../index` and :doc:`../ui_extensions`. + +.. contents:: Sections + :local: .. module:: qrenderdoc diff --git a/docs/python_api/qrenderdoc/windows.rst b/docs/python_api/qrenderdoc/windows.rst index a33835fae7..a47757e904 100644 --- a/docs/python_api/qrenderdoc/windows.rst +++ b/docs/python_api/qrenderdoc/windows.rst @@ -1,7 +1,10 @@ -Windows -======= +API Reference: qrenderdoc Windows +================================= -.. contents:: +This is the API reference for the functions, classes, and enums in the ``qrenderdoc`` module which represents the UI-specific interface for integrating with the UI and writing UI extensions. For more high-level information and instructions on using the python API, see :doc:`../index` and :doc:`../ui_extensions`. + +.. contents:: Sections + :local: .. currentmodule:: qrenderdoc diff --git a/docs/python_api/renderdoc/analysis.rst b/docs/python_api/renderdoc/analysis.rst index 727c12d584..05e52f49a5 100644 --- a/docs/python_api/renderdoc/analysis.rst +++ b/docs/python_api/renderdoc/analysis.rst @@ -1,7 +1,10 @@ -Replay Analysis -=============== +API Reference: Replay Analysis +============================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/capturing.rst b/docs/python_api/renderdoc/capturing.rst index 24d847d825..0d5d5ce0e2 100644 --- a/docs/python_api/renderdoc/capturing.rst +++ b/docs/python_api/renderdoc/capturing.rst @@ -1,7 +1,10 @@ -Capturing -========= +API Reference: Capturing +======================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/counters.rst b/docs/python_api/renderdoc/counters.rst index b877004544..2291498b40 100644 --- a/docs/python_api/renderdoc/counters.rst +++ b/docs/python_api/renderdoc/counters.rst @@ -1,7 +1,10 @@ -Performance Counters -==================== +API Reference: Performance Counters +=================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/formats.rst b/docs/python_api/renderdoc/formats.rst index 1dca87df8f..1bdc8b775a 100644 --- a/docs/python_api/renderdoc/formats.rst +++ b/docs/python_api/renderdoc/formats.rst @@ -1,7 +1,10 @@ -Formats -======= +API Reference: Formats +====================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/frame_stats.rst b/docs/python_api/renderdoc/frame_stats.rst index 01cf13b6da..2be4b5fa55 100644 --- a/docs/python_api/renderdoc/frame_stats.rst +++ b/docs/python_api/renderdoc/frame_stats.rst @@ -1,7 +1,10 @@ -Frame Statistics -================ +API Reference: Frame Statistics +=============================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/index.rst b/docs/python_api/renderdoc/index.rst index bb63a45817..75c55bdbde 100644 --- a/docs/python_api/renderdoc/index.rst +++ b/docs/python_api/renderdoc/index.rst @@ -1,6 +1,8 @@ -renderdoc API Reference +renderdoc python module ======================= +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + .. toctree:: :hidden: diff --git a/docs/python_api/renderdoc/outputs.rst b/docs/python_api/renderdoc/outputs.rst index 2e88874e0e..75d5582004 100644 --- a/docs/python_api/renderdoc/outputs.rst +++ b/docs/python_api/renderdoc/outputs.rst @@ -1,7 +1,10 @@ -Replay Outputs -============== +API Reference: Replay Outputs +============================= -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/pipelines/common.rst b/docs/python_api/renderdoc/pipelines/common.rst index 31023e1935..03475a8dd5 100644 --- a/docs/python_api/renderdoc/pipelines/common.rst +++ b/docs/python_api/renderdoc/pipelines/common.rst @@ -1,7 +1,10 @@ -Common Pipeline State Abstraction -================================= +API Reference: Common Pipeline State Abstraction +================================================ -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/pipelines/d3d11.rst b/docs/python_api/renderdoc/pipelines/d3d11.rst index 5eaad814fc..45704ff138 100644 --- a/docs/python_api/renderdoc/pipelines/d3d11.rst +++ b/docs/python_api/renderdoc/pipelines/d3d11.rst @@ -1,7 +1,10 @@ -D3D11 Pipeline State -==================== +API Reference: D3D11 Pipeline State +==================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/pipelines/d3d12.rst b/docs/python_api/renderdoc/pipelines/d3d12.rst index 0fd305bd2c..c84e9b25a3 100644 --- a/docs/python_api/renderdoc/pipelines/d3d12.rst +++ b/docs/python_api/renderdoc/pipelines/d3d12.rst @@ -1,7 +1,10 @@ -D3D12 Pipeline State -==================== +API Reference: D3D12 Pipeline State +==================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/pipelines/gl.rst b/docs/python_api/renderdoc/pipelines/gl.rst index b5fddb9a54..34ace99008 100644 --- a/docs/python_api/renderdoc/pipelines/gl.rst +++ b/docs/python_api/renderdoc/pipelines/gl.rst @@ -1,7 +1,10 @@ -OpenGL Pipeline State -===================== +API Reference: OpenGL Pipeline State +===================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/pipelines/index.rst b/docs/python_api/renderdoc/pipelines/index.rst index 859da7c20f..7923f9ef72 100644 --- a/docs/python_api/renderdoc/pipelines/index.rst +++ b/docs/python_api/renderdoc/pipelines/index.rst @@ -1,5 +1,7 @@ -Pipeline State Objects -====================== +API Reference: Pipeline State Objects +====================================== + +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. .. toctree:: :maxdepth: 1 diff --git a/docs/python_api/renderdoc/pipelines/vulkan.rst b/docs/python_api/renderdoc/pipelines/vulkan.rst index b002393030..10984fc284 100644 --- a/docs/python_api/renderdoc/pipelines/vulkan.rst +++ b/docs/python_api/renderdoc/pipelines/vulkan.rst @@ -1,7 +1,10 @@ -Vulkan Pipeline State -===================== +API Reference: Vulkan Pipeline State +===================================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/replay.rst b/docs/python_api/renderdoc/replay.rst index 57ca5970a9..eeecae544e 100644 --- a/docs/python_api/renderdoc/replay.rst +++ b/docs/python_api/renderdoc/replay.rst @@ -1,7 +1,10 @@ -Replay Control -============== +API Reference: Replay Control +============================= -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/resources.rst b/docs/python_api/renderdoc/resources.rst index f016f0077f..f9ecad351f 100644 --- a/docs/python_api/renderdoc/resources.rst +++ b/docs/python_api/renderdoc/resources.rst @@ -1,7 +1,10 @@ -Resources -========= +API Reference: Resources +======================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/shaders.rst b/docs/python_api/renderdoc/shaders.rst index 18a6deb534..15fdf78195 100644 --- a/docs/python_api/renderdoc/shaders.rst +++ b/docs/python_api/renderdoc/shaders.rst @@ -1,7 +1,10 @@ -Shaders -======= +API Reference: Shaders +====================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/structured_data.rst b/docs/python_api/renderdoc/structured_data.rst index 7ee1c19ad4..3c5b623557 100644 --- a/docs/python_api/renderdoc/structured_data.rst +++ b/docs/python_api/renderdoc/structured_data.rst @@ -1,7 +1,10 @@ -Structured Data -=============== +API Reference: Structured Data +============================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc diff --git a/docs/python_api/renderdoc/utils.rst b/docs/python_api/renderdoc/utils.rst index c14ca21ea2..a2a35d14a2 100644 --- a/docs/python_api/renderdoc/utils.rst +++ b/docs/python_api/renderdoc/utils.rst @@ -1,7 +1,10 @@ -Utilities -========= +API Reference: Utilities +======================== -.. contents:: +This is the API reference for the functions, classes, and enums in the ``renderdoc`` module which represents the underlying interface that the UI is built on top of. For more high-level information and instructions on using the python API, see :doc:`../index`. + +.. contents:: Sections + :local: .. currentmodule:: renderdoc