jamie/pycmx
1
0
Fork 0
mirror of https://github.com/iluvcapra/pycmx.git synced 2025-12-31 08:50:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fixed doc generation

Browse Source
This commit is contained in:
Jamie Hardt
2022-11-16 19:00:17 -08:00
parent d3cf5fa5f2
commit 770e7f45a4
4 changed files with 19 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/source/classes.rst
View File

@@ -12,3 +12,13 @@ pycmx Classes
.. autoclass:: pycmx.edit.Edit .. autoclass:: pycmx.edit.Edit
:members: :members:
.. autoclass:: pycmx.transition.Transition
:members:
.. autoclass:: pycmx.channel_map.ChannelMap
:members:

7
docs/source/function.rst Normal file
View File

@@ -0,0 +1,7 @@
Parse Function
==============
.. autofunction:: pycmx.parse_cmx_events.parse_cmx3600

2
docs/source/index.rst
View File

@@ -10,11 +10,11 @@ Welcome to pycmx's documentation!
:maxdepth: 5 :maxdepth: 5
:caption: API Reference: :caption: API Reference:
function
classes classes
Indices and tables Indices and tables
================== ==================
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex`
* :ref:`search` * :ref:`search`

2
pycmx/parse_cmx_events.py
View File

@@ -14,7 +14,7 @@ def parse_cmx3600(f):
f : a file-like object, anything that's readlines-able. f : a file-like object, anything that's readlines-able.
Returns: Returns:
An :class:`EditList`. An :class:`pycmx.edit_list.EditList`.
""" """
statements = parse_cmx3600_statements(f) statements = parse_cmx3600_statements(f)
return EditList(statements) return EditList(statements)