Add page titles and header texts for all python API ref documentation

* Try to guide people looking for an introduction away from API references and towards actual explanations and documentation.
baldurk · Dec 17, 2024 · 8634d8f · 8634d8f
1 parent b76bb49
commit 8634d8f
Show file tree

Hide file tree

Showing 23 changed files with 130 additions and 64 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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