lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-05-05 01:20:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/qrenderdoc/config.rst
+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
docs/python_api/qrenderdoc/extensions.rst
+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
docs/python_api/qrenderdoc/index.rst
+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:
docs/python_api/qrenderdoc/main.rst
+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
docs/python_api/qrenderdoc/windows.rst
+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