mirror of
https://github.com/iluvcapra/ptulsconv.git
synced 2025-12-31 08:50:48 +00:00
Developer documentation
This commit is contained in:
@@ -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
|
||||
|
||||
|
||||
@@ -1,2 +1,8 @@
|
||||
ptulsconv Classes
|
||||
=================
|
||||
=================
|
||||
|
||||
Docparser Classes
|
||||
-----------------
|
||||
|
||||
.. automodule:: ptulsconv.docparser.adr_entity
|
||||
:members:
|
||||
@@ -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:
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ exports into JSON documents for processing by other applications.
|
||||
|
||||
.. toctree::
|
||||
:numbered:
|
||||
:maxdepth: 2
|
||||
:maxdepth: 1
|
||||
:caption: Developer Documentation
|
||||
|
||||
dev/contributing
|
||||
|
||||
Reference in New Issue
Block a user