Fixed doc generation

2025-12-31 17:00:53 +00:00 · 2022-11-16 19:00:17 -08:00
parent d3cf5fa5f2
commit 770e7f45a4
4 changed files with 19 additions and 2 deletions
--- a/docs/source/classes.rst
+++ b/docs/source/classes.rst
@@ -12,3 +12,13 @@ pycmx Classes
 .. autoclass:: pycmx.edit.Edit  
   :members:

+
+.. autoclass:: pycmx.transition.Transition
+   :members:
+
+
+.. autoclass:: pycmx.channel_map.ChannelMap
+   :members:
+
+
+
--- a/docs/source/function.rst
+++ b/docs/source/function.rst
@@ -0,0 +1,7 @@
+Parse Function
+==============
+
+
+.. autofunction:: pycmx.parse_cmx_events.parse_cmx3600
+
+
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -10,11 +10,11 @@ Welcome to pycmx's documentation!
   :maxdepth: 5
   :caption: API Reference:

+   function
   classes

 Indices and tables
 ==================

 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
--- a/pycmx/parse_cmx_events.py
+++ b/pycmx/parse_cmx_events.py
@@ -14,7 +14,7 @@ def parse_cmx3600(f):
        f : a file-like object, anything that's readlines-able.

    Returns:
-        An :class:`EditList`.
+        An :class:`pycmx.edit_list.EditList`.
    """
    statements = parse_cmx3600_statements(f)
    return EditList(statements)