From 76c2e240845aa35d2d9e8ce53f21ff37c768335b Mon Sep 17 00:00:00 2001 From: Jamie Hardt Date: Fri, 18 Nov 2022 19:32:00 -0800 Subject: [PATCH] Developer documentation --- docs/source/conf.py | 7 +++++++ docs/source/dev/classes.rst | 8 +++++++- docs/source/dev/modules.rst | 23 +++++++++++++++++++++++ docs/source/index.rst | 2 +- 4 files changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index f250a5c..c8e0947 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -3,6 +3,13 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html +import sys +import os + +sys.path.insert(0, os.path.abspath("../..")) +print(sys.path) + + # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information diff --git a/docs/source/dev/classes.rst b/docs/source/dev/classes.rst index 0efb46e..a3b0099 100644 --- a/docs/source/dev/classes.rst +++ b/docs/source/dev/classes.rst @@ -1,2 +1,8 @@ ptulsconv Classes -================= \ No newline at end of file +================= + +Docparser Classes +----------------- + +.. automodule:: ptulsconv.docparser.adr_entity + :members: \ No newline at end of file diff --git a/docs/source/dev/modules.rst b/docs/source/dev/modules.rst index 237bb15..27d6611 100644 --- a/docs/source/dev/modules.rst +++ b/docs/source/dev/modules.rst @@ -1,3 +1,26 @@ ptulsconv Modules ================= +Broadcast Timecode Module +------------------------- + +.. automodule:: ptulsconv.broadcast_timecode + :members: + :undoc-members: + + +Footage Module +-------------- + +.. automodule:: ptulsconv.footage + :members: + :undoc-members: + +.. automodule:: ptulsconv.reporting + :members: + :undoc-members: + +.. automodule:: ptulsconv.validations + :members: + :undoc-members: + diff --git a/docs/source/index.rst b/docs/source/index.rst index 38e805f..b515c8a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,7 +22,7 @@ exports into JSON documents for processing by other applications. .. toctree:: :numbered: - :maxdepth: 2 + :maxdepth: 1 :caption: Developer Documentation dev/contributing