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 entries in sphinx documentation to generate correct API autodocs

Browse Source
This commit is contained in:
baldurk
2017-03-24 15:47:31 +00:00
parent 83f769a2cd
commit 99063c2401
9 changed files with 88 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_api/enums_data.rst
+1 -2
View File
@@ -5,5 +5,4 @@ Enums and Data Structures
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, str
:exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11_, name_match__startswith__D3D12_, name_match__startswith__VK_, name_match__startswith__GL_, str, ReplayRenderer, ReplayOutput, TargetControl, RemoteServer
docs/python_api/funcs.rst
+30
View File
@@ -1,3 +1,33 @@
Functions
=========
.. module:: renderdoc
.. autofunction:: renderdoc.Maths_FloatToHalf
.. autofunction:: renderdoc.Maths_HalfToFloat
.. autofunction:: renderdoc.Topology_NumVerticesPerPrimitive
.. autofunction:: renderdoc.Topology_VertexOffset
.. autofunction:: renderdoc.SupportLocalReplay
.. autofunction:: renderdoc.CreateReplayRenderer
.. autofunction:: renderdoc.CreateTargetControl
.. autofunction:: renderdoc.EnumerateRemoteTargets
.. autofunction:: renderdoc.GetDefaultRemoteServerPort
.. autofunction:: renderdoc.CreateRemoteServerConnection
.. autofunction:: renderdoc.BecomeRemoteServer
.. autofunction:: renderdoc.GetDefaultCaptureOptions
.. autofunction:: renderdoc.StartGlobalHook
.. autofunction:: renderdoc.ExecuteAndInject
.. autofunction:: renderdoc.InjectIntoProcess
.. autofunction:: renderdoc.StartSelfHostCapture
.. autofunction:: renderdoc.EndSelfHostCapture
.. autofunction:: renderdoc.SetDebugLogFile
.. autofunction:: renderdoc.GetLogFile
.. autofunction:: renderdoc.GetThumbnail
.. autofunction:: renderdoc.GetVersionString
.. autofunction:: renderdoc.GetCommitHash
.. autofunction:: renderdoc.IsD3D
.. autofunction:: renderdoc.PatchList_Count
.. autofunction:: renderdoc.PatchList_Topology
.. autofunction:: renderdoc.MaskForStage
docs/python_api/index.rst
+1
View File
@@ -5,4 +5,5 @@ Python API
main_ifaces
funcs
enums_data
pipelines/index
qrenderdoc
docs/python_api/main_ifaces.rst
+16
View File
@@ -1,4 +1,20 @@
Primary Interfaces
==================
.. module:: renderdoc
.. autoclass:: renderdoc.ReplayRenderer
:members:
:undoc-members:
.. autoclass:: renderdoc.ReplayOutput
:members:
:undoc-members:
.. autoclass:: renderdoc.TargetControl
:members:
:undoc-members:
.. autoclass:: renderdoc.RemoteServer
:members:
:undoc-members:
docs/python_api/pipelines/d3d11.rst
+8
View File
@@ -0,0 +1,8 @@
D3D11 Pipeline State
====================
.. automodule:: renderdoc
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D11_
docs/python_api/pipelines/d3d12.rst
+8
View File
@@ -0,0 +1,8 @@
D3D12 Pipeline State
====================
.. automodule:: renderdoc
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D12_
docs/python_api/pipelines/gl.rst
+8
View File
@@ -0,0 +1,8 @@
OpenGL Pipeline State
=====================
.. automodule:: renderdoc
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__GL_
docs/python_api/pipelines/index.rst
+8
View File
@@ -0,0 +1,8 @@
Pipeline State Objects
======================
.. toctree::
d3d11
d3d12
gl
vulkan
docs/python_api/pipelines/vulkan.rst
+8
View File
@@ -0,0 +1,8 @@
Vulkan Pipeline State
=====================
.. automodule:: renderdoc
:members:
:undoc-members:
:imported-members:
:exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__VK_