From f4760585670c1606b57d01cbf420bd74f4109535 Mon Sep 17 00:00:00 2001 From: baldurk Date: Thu, 6 Apr 2017 00:39:42 +0100 Subject: [PATCH] Pull the ultimate parent pipeline object to the top of any docs page --- docs/python_api/pipelines/d3d11.rst | 11 +++++++++-- docs/python_api/pipelines/d3d12.rst | 11 +++++++++-- docs/python_api/pipelines/gl.rst | 11 +++++++++-- docs/python_api/pipelines/vulkan.rst | 11 +++++++++-- qrenderdoc/Code/pyrenderdoc/renderdoc.i | 2 +- 5 files changed, 37 insertions(+), 9 deletions(-) diff --git a/docs/python_api/pipelines/d3d11.rst b/docs/python_api/pipelines/d3d11.rst index dd6843f61..25ec9305f 100644 --- a/docs/python_api/pipelines/d3d11.rst +++ b/docs/python_api/pipelines/d3d11.rst @@ -1,8 +1,15 @@ D3D11 Pipeline State ==================== -.. automodule:: renderdoc +.. module:: renderdoc + +.. autoclass:: D3D11_State :members: :undoc-members: + +.. automodule:: renderdoc + :members: + :noindex: + :undoc-members: :imported-members: - :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D11_ + :exclude-members: D3D11_State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11_ diff --git a/docs/python_api/pipelines/d3d12.rst b/docs/python_api/pipelines/d3d12.rst index aff4df66b..24f52e48e 100644 --- a/docs/python_api/pipelines/d3d12.rst +++ b/docs/python_api/pipelines/d3d12.rst @@ -1,8 +1,15 @@ D3D12 Pipeline State ==================== -.. automodule:: renderdoc +.. module:: renderdoc + +.. autoclass:: D3D12_State :members: :undoc-members: + +.. automodule:: renderdoc + :members: + :noindex: + :undoc-members: :imported-members: - :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__D3D12_ + :exclude-members: D3D12_State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12_ diff --git a/docs/python_api/pipelines/gl.rst b/docs/python_api/pipelines/gl.rst index 01f90e051..642cde531 100644 --- a/docs/python_api/pipelines/gl.rst +++ b/docs/python_api/pipelines/gl.rst @@ -1,8 +1,15 @@ OpenGL Pipeline State ===================== -.. automodule:: renderdoc +.. module:: renderdoc + +.. autoclass:: GL_State :members: :undoc-members: + +.. automodule:: renderdoc + :members: + :noindex: + :undoc-members: :imported-members: - :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__GL_ + :exclude-members: GL_State, free_functions__, enum_constants__, name_match__include_only__startswith__GL_ diff --git a/docs/python_api/pipelines/vulkan.rst b/docs/python_api/pipelines/vulkan.rst index f98a0942c..ee7da370d 100644 --- a/docs/python_api/pipelines/vulkan.rst +++ b/docs/python_api/pipelines/vulkan.rst @@ -1,8 +1,15 @@ Vulkan Pipeline State ===================== -.. automodule:: renderdoc +.. module:: renderdoc + +.. autoclass:: VK_State :members: :undoc-members: + +.. automodule:: renderdoc + :members: + :noindex: + :undoc-members: :imported-members: - :exclude-members: free_functions__, enum_constants__, name_match__include_only__startswith__VK_ + :exclude-members: VK_State, free_functions__, enum_constants__, name_match__include_only__startswith__VK_ diff --git a/qrenderdoc/Code/pyrenderdoc/renderdoc.i b/qrenderdoc/Code/pyrenderdoc/renderdoc.i index 16ade6b82..bcc9d1f18 100644 --- a/qrenderdoc/Code/pyrenderdoc/renderdoc.i +++ b/qrenderdoc/Code/pyrenderdoc/renderdoc.i @@ -1,4 +1,4 @@ -%module(docstring="This is the API to RenderDoc's internals.") renderdoc +%module renderdoc %feature("autodoc", "0");