lee/renderdoc
1
0
Fork 0
mirror of https://github.com/baldurk/renderdoc.git synced 2026-07-14 19:47:03 +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/renderdoc/pipelines/common.rst
+6 -3
View File
@@ -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
docs/python_api/renderdoc/pipelines/d3d11.rst
+6 -3
View File
@@ -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
docs/python_api/renderdoc/pipelines/d3d12.rst
+6 -3
View File
@@ -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
docs/python_api/renderdoc/pipelines/gl.rst
+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
docs/python_api/renderdoc/pipelines/index.rst
+4 -2
View File
@@ -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
docs/python_api/renderdoc/pipelines/vulkan.rst
+6 -3
View File
@@ -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