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.
This commit is contained in:
baldurk
2024-12-17 14:32:25 +00:00
parent b76bb49994
commit 8634d8ff22
23 changed files with 130 additions and 64 deletions
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+3 -1
View File
@@ -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:
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+3 -1
View File
@@ -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:
+6 -3
View File
@@ -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
@@ -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
@@ -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
@@ -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
+6 -3
View File
@@ -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
@@ -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
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
+6 -3
View File
@@ -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
@@ -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
+6 -3
View File
@@ -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