Skip to content

Commit

Permalink
Add render rst stubs
Browse files Browse the repository at this point in the history
  • Loading branch information
e10harvey committed Feb 28, 2025
1 parent c1306ef commit 8aeb38f
Show file tree
Hide file tree
Showing 3 changed files with 173 additions and 0 deletions.
163 changes: 163 additions & 0 deletions doc/source/library_reference/common/lib/render/config.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,163 @@
Color
=====

.. currentmodule:: opencsp.common.lib.render.Color

.. automodule:: opencsp.common.lib.render.Color
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

View
====
.. currentmodule:: opencsp.common.lib.render.View3d

.. automodule:: opencsp.common.lib.render.View3d
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.lib.PowerpointImage

.. automodule:: opencsp.common.lib.render.lib.PowerpointImage
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.view_spec

.. automodule:: opencsp.common.lib.render.view_spec
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

Axis
====

.. currentmodule:: opencsp.common.lib.render.axis_3d

.. automodule:: opencsp.common.lib.render.axis_3d
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

Image
=====

.. currentmodule:: opencsp.common.lib.render.ImageAttributeParser

.. automodule:: opencsp.common.lib.render.ImageAttributeParser
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.figure_management

.. automodule:: opencsp.common.lib.render.figure_management
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

Video
=====

.. currentmodule:: opencsp.common.lib.render.VideoHandler

.. automodule:: opencsp.common.lib.render.VideoHandler
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

Plot
====

.. currentmodule:: opencsp.common.lib.render.PlotAnnotation

.. automodule:: opencsp.common.lib.render.PlotAnnotation
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.lib.AbstractPlotHandler

.. automodule:: opencsp.common.lib.render.lib.AbstractPlotHandler
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.general_plot

.. automodule:: opencsp.common.lib.render.general_plot
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.image_plot

.. automodule:: opencsp.common.lib.render.image_plot
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.pandas_plot

.. automodule:: opencsp.common.lib.render.pandas_plot
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

Powerpoint
==========

.. currentmodule:: opencsp.common.lib.render.PowerpointSlide

.. automodule:: opencsp.common.lib.render.PowerpointSlide
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.lib.PowerpointShape

.. automodule:: opencsp.common.lib.render.lib.PowerpointShape
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise

.. currentmodule:: opencsp.common.lib.render.lib.PowerpointText

.. automodule:: opencsp.common.lib.render.lib.PowerpointText
:members:
:special-members: __init__
:undoc-members:
:show-inheritance:
:member-order: groupwise
9 changes: 9 additions & 0 deletions doc/source/library_reference/common/lib/render/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Render Utilities
=================

This is a collection of render utilities for OpenCSP

.. toctree::
:maxdepth: 1

config.rst
1 change: 1 addition & 0 deletions doc/source/library_reference/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ This section describes the OpenCSP classes and interfaces.
common/lib/opencsp_path/index.rst
common/lib/process/index.rst
common/lib/photogrammetry/index.rst
common/lib/render/index.rst

0 comments on commit 8aeb38f

Please sign in to comment.