From 770e7f45a41bb8275501861e2ff1a314ae841feb Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Wed, 16 Nov 2022 19:00:17 -0800 Subject: [PATCH] Fixed doc generation --- docs/source/classes.rst | 10 ++++++++++ docs/source/function.rst | 7 +++++++ docs/source/index.rst | 2 +- pycmx/parse_cmx_events.py | 2 +- 4 files changed, 19 insertions(+), 2 deletions(-) create mode 100644 docs/source/function.rst diff --git a/docs/source/classes.rst b/docs/source/classes.rst index bba93ad..26d9f2c 100644 --- 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: + + + diff --git a/docs/source/function.rst b/docs/source/function.rst new file mode 100644 index 0000000..25137be --- /dev/null +++ b/docs/source/function.rst @@ -0,0 +1,7 @@ +Parse Function +============== + + +.. autofunction:: pycmx.parse_cmx_events.parse_cmx3600 + + diff --git a/docs/source/index.rst b/docs/source/index.rst index f504f15..e04804a 100644 --- 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` diff --git a/pycmx/parse_cmx_events.py b/pycmx/parse_cmx_events.py index f5c6549..211e2ad 100644 --- 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)