From dd4009c588a73452b35e4f5a441a0cd0bfdfd162 Mon Sep 17 00:00:00 2001 From: baldurk Date: Tue, 7 Apr 2020 09:55:17 +0100 Subject: [PATCH] Remove undoc-members attributes from autoclass docs builds --- docs/python_api/qrenderdoc/config.rst | 6 ------ docs/python_api/qrenderdoc/extensions.rst | 5 ----- docs/python_api/qrenderdoc/main.rst | 8 -------- docs/python_api/qrenderdoc/windows.rst | 17 ----------------- docs/python_api/renderdoc/enums_data.rst | 1 - docs/python_api/renderdoc/main_ifaces.rst | 7 ------- docs/python_api/renderdoc/pipelines/common.rst | 11 ----------- docs/python_api/renderdoc/pipelines/d3d11.rst | 2 -- docs/python_api/renderdoc/pipelines/d3d12.rst | 2 -- docs/python_api/renderdoc/pipelines/gl.rst | 2 -- docs/python_api/renderdoc/pipelines/vulkan.rst | 2 -- 11 files changed, 63 deletions(-) diff --git a/docs/python_api/qrenderdoc/config.rst b/docs/python_api/qrenderdoc/config.rst index d2d73d4b8..8a8859191 100644 --- a/docs/python_api/qrenderdoc/config.rst +++ b/docs/python_api/qrenderdoc/config.rst @@ -10,24 +10,19 @@ Config .. autoclass:: qrenderdoc.PersistantConfig :members: - :undoc-members: :exclude-members: enum_constants__,properties__ .. autoclass:: qrenderdoc.ShaderProcessingTool :members: - :undoc-members: .. autoclass:: qrenderdoc.ShaderToolOutput :members: - :undoc-members: .. autoclass:: qrenderdoc.BugReport :members: - :undoc-members: .. autoclass:: qrenderdoc.TimeUnit :members: - :undoc-members: :exclude-members: enum_constants__, Remote Host @@ -35,4 +30,3 @@ Remote Host .. autoclass:: qrenderdoc.RemoteHost :members: - :undoc-members: diff --git a/docs/python_api/qrenderdoc/extensions.rst b/docs/python_api/qrenderdoc/extensions.rst index 9b04234dd..9d0e045eb 100644 --- a/docs/python_api/qrenderdoc/extensions.rst +++ b/docs/python_api/qrenderdoc/extensions.rst @@ -10,27 +10,22 @@ Extension Manager .. autoclass:: qrenderdoc.ExtensionManager :members: - :undoc-members: Helpers ------- .. autoclass:: qrenderdoc.ExtensionMetadata :members: - :undoc-members: .. autoclass:: qrenderdoc.WindowMenu :members: - :undoc-members: :exclude-members: enum_constants__, .. autoclass:: qrenderdoc.PanelMenu :members: - :undoc-members: :exclude-members: enum_constants__, .. autoclass:: qrenderdoc.ContextMenu :members: - :undoc-members: :exclude-members: enum_constants__, diff --git a/docs/python_api/qrenderdoc/main.rst b/docs/python_api/qrenderdoc/main.rst index bdd8c467b..6a6ea6c1c 100644 --- a/docs/python_api/qrenderdoc/main.rst +++ b/docs/python_api/qrenderdoc/main.rst @@ -10,21 +10,18 @@ Context .. autoclass:: qrenderdoc.CaptureContext :members: - :undoc-members: Replay Manager -------------- .. autoclass:: qrenderdoc.ReplayManager :members: - :undoc-members: RGP Interop Control ------------------- .. autoclass:: qrenderdoc.RGPInterop :members: - :undoc-members: CaptureViewer Interface @@ -32,26 +29,21 @@ CaptureViewer Interface .. autoclass:: qrenderdoc.CaptureViewer :members: - :undoc-members: Utilities --------- .. autoclass:: qrenderdoc.DockReference :members: - :undoc-members: :exclude-members: enum_constants__, .. autoclass:: qrenderdoc.CaptureModifications :members: - :undoc-members: :exclude-members: enum_constants__, .. autoclass:: qrenderdoc.CaptureSettings :members: - :undoc-members: .. autoclass:: qrenderdoc.EventBookmark :members: - :undoc-members: diff --git a/docs/python_api/qrenderdoc/windows.rst b/docs/python_api/qrenderdoc/windows.rst index 3fb192f78..62a55397d 100644 --- a/docs/python_api/qrenderdoc/windows.rst +++ b/docs/python_api/qrenderdoc/windows.rst @@ -10,117 +10,100 @@ Main Window .. autoclass:: qrenderdoc.MainWindow :members: - :undoc-members: Event Browser ------------- .. autoclass:: qrenderdoc.EventBrowser :members: - :undoc-members: API Inspector ------------- .. autoclass:: qrenderdoc.APIInspector :members: - :undoc-members: Pipeline State -------------- .. autoclass:: qrenderdoc.PipelineStateViewer :members: - :undoc-members: Texture Viewer -------------- .. autoclass:: qrenderdoc.TextureViewer :members: - :undoc-members: Buffer Viewer ------------- .. autoclass:: qrenderdoc.BufferViewer :members: - :undoc-members: Resource Inspector ------------------ .. autoclass:: qrenderdoc.ResourceInspector :members: - :undoc-members: Capture Dialog -------------- .. autoclass:: qrenderdoc.CaptureDialog :members: - :undoc-members: Debug Messages -------------- .. autoclass:: qrenderdoc.DebugMessageView :members: - :undoc-members: Comment View ------------ .. autoclass:: qrenderdoc.CommentView :members: - :undoc-members: Statistics Viewer ----------------- .. autoclass:: qrenderdoc.StatisticsViewer :members: - :undoc-members: Timeline Bar ------------ .. autoclass:: qrenderdoc.TimelineBar :members: - :undoc-members: Performance Counter Viewer -------------------------- .. autoclass:: qrenderdoc.PerformanceCounterViewer :members: - :undoc-members: Python Shell ------------ .. autoclass:: qrenderdoc.PythonShell :members: - :undoc-members: Shader Viewer ------------- .. autoclass:: qrenderdoc.ShaderViewer :members: - :undoc-members: Constant Buffer Previewer ------------------------- .. autoclass:: qrenderdoc.ConstantBufferPreviewer :members: - :undoc-members: Pixel History ------------- .. autoclass:: qrenderdoc.PixelHistoryView :members: - :undoc-members: diff --git a/docs/python_api/renderdoc/enums_data.rst b/docs/python_api/renderdoc/enums_data.rst index 1006ce904..9b0776bad 100644 --- a/docs/python_api/renderdoc/enums_data.rst +++ b/docs/python_api/renderdoc/enums_data.rst @@ -6,6 +6,5 @@ Enums and Data Structures .. automodule:: renderdoc :noindex: :members: - :undoc-members: :imported-members: :exclude-members: free_functions__, enum_constants__, name_match__startswith__D3D11, name_match__startswith__D3D12, name_match__startswith__VK, name_match__startswith__GL, name_match__startswith__rdcarray_of, rdcstr, bytebuf, ReplayController, ReplayOutput, TargetControl, RemoteServer, DeviceProtocolController, CaptureFile, Viewport, Scissor, BlendEquation, ColorBlend, StencilFace, BoundResource, BoundResourceArray, BoundVBuffer, BoundCBuffer, VertexInputAttribute, PipeState, StructuredBufferList, StructuredObjectList diff --git a/docs/python_api/renderdoc/main_ifaces.rst b/docs/python_api/renderdoc/main_ifaces.rst index a99954270..c32b5bbb8 100644 --- a/docs/python_api/renderdoc/main_ifaces.rst +++ b/docs/python_api/renderdoc/main_ifaces.rst @@ -10,46 +10,39 @@ ReplayController .. autoclass:: renderdoc.ReplayController :members: - :undoc-members: ReplayOutput ------------ .. autoclass:: renderdoc.ReplayOutput :members: - :undoc-members: TargetControl ------------- .. autoclass:: renderdoc.TargetControl :members: - :undoc-members: RemoteServer ------------ .. autoclass:: renderdoc.RemoteServer :members: - :undoc-members: DeviceProtocolController ------------------------ .. autoclass:: renderdoc.DeviceProtocolController :members: - :undoc-members: CaptureFile ----------- .. autoclass:: renderdoc.CaptureFile :members: - :undoc-members: GlobalEnvironment ----------------- .. autoclass:: renderdoc.GlobalEnvironment :members: - :undoc-members: diff --git a/docs/python_api/renderdoc/pipelines/common.rst b/docs/python_api/renderdoc/pipelines/common.rst index 2c5829111..fb90ef243 100644 --- a/docs/python_api/renderdoc/pipelines/common.rst +++ b/docs/python_api/renderdoc/pipelines/common.rst @@ -5,75 +5,64 @@ Common Pipeline State Abstraction .. autoclass:: PipeState :members: - :undoc-members: Viewport -------- .. autoclass:: renderdoc.Viewport :members: - :undoc-members: Scissor ------- .. autoclass:: renderdoc.Scissor :members: - :undoc-members: BlendEquation ------------- .. autoclass:: renderdoc.BlendEquation :members: - :undoc-members: ColorBlend ---------- .. autoclass:: renderdoc.ColorBlend :members: - :undoc-members: StencilFace ----------- .. autoclass:: renderdoc.StencilFace :members: - :undoc-members: BoundResource ------------- .. autoclass:: renderdoc.BoundResource :members: - :undoc-members: BoundResourceArray ------------------ .. autoclass:: renderdoc.BoundResourceArray :members: - :undoc-members: BoundVBuffer ------------ .. autoclass:: renderdoc.BoundVBuffer :members: - :undoc-members: BoundCBuffer ------------ .. autoclass:: renderdoc.BoundCBuffer :members: - :undoc-members: VertexInputAttribute -------------------- .. autoclass:: renderdoc.VertexInputAttribute :members: - :undoc-members: \ No newline at end of file diff --git a/docs/python_api/renderdoc/pipelines/d3d11.rst b/docs/python_api/renderdoc/pipelines/d3d11.rst index 4ef1f735f..8814a1739 100644 --- a/docs/python_api/renderdoc/pipelines/d3d11.rst +++ b/docs/python_api/renderdoc/pipelines/d3d11.rst @@ -5,11 +5,9 @@ D3D11 Pipeline State .. autoclass:: D3D11State :members: - :undoc-members: .. automodule:: renderdoc :noindex: :members: - :undoc-members: :imported-members: :exclude-members: D3D11State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D11 diff --git a/docs/python_api/renderdoc/pipelines/d3d12.rst b/docs/python_api/renderdoc/pipelines/d3d12.rst index 38ff1c87a..1ef90b10c 100644 --- a/docs/python_api/renderdoc/pipelines/d3d12.rst +++ b/docs/python_api/renderdoc/pipelines/d3d12.rst @@ -5,11 +5,9 @@ D3D12 Pipeline State .. autoclass:: D3D12State :members: - :undoc-members: .. automodule:: renderdoc :noindex: :members: - :undoc-members: :imported-members: :exclude-members: D3D12State, free_functions__, enum_constants__, name_match__include_only__startswith__D3D12 diff --git a/docs/python_api/renderdoc/pipelines/gl.rst b/docs/python_api/renderdoc/pipelines/gl.rst index d227cb6d1..0da3c500d 100644 --- a/docs/python_api/renderdoc/pipelines/gl.rst +++ b/docs/python_api/renderdoc/pipelines/gl.rst @@ -5,11 +5,9 @@ OpenGL Pipeline State .. autoclass:: GLState :members: - :undoc-members: .. automodule:: renderdoc :noindex: :members: - :undoc-members: :imported-members: :exclude-members: GLState, free_functions__, enum_constants__, name_match__include_only__startswith__GL diff --git a/docs/python_api/renderdoc/pipelines/vulkan.rst b/docs/python_api/renderdoc/pipelines/vulkan.rst index 17c82bb64..abffcd5fb 100644 --- a/docs/python_api/renderdoc/pipelines/vulkan.rst +++ b/docs/python_api/renderdoc/pipelines/vulkan.rst @@ -5,11 +5,9 @@ Vulkan Pipeline State .. autoclass:: VKState :members: - :undoc-members: .. automodule:: renderdoc :noindex: :members: - :undoc-members: :imported-members: :exclude-members: VKState, free_functions__, enum_constants__, name_match__include_only__startswith__VK