adding sphinx documentation

2025-12-22 13:05:45 +00:00 · 2020-01-13 00:14:08 +00:00
parent 9808fcb692
commit 5a2a65b4d1
21 changed files with 656 additions and 14 deletions
--- a/docs/source/modules/modules.rst
+++ b/docs/source/modules/modules.rst
@@ -0,0 +1,7 @@
+panaetius
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   panaetius
--- a/docs/source/modules/panaetius.config.rst
+++ b/docs/source/modules/panaetius.config.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.config`
+-------------------------------------
+
+.. automodule:: panaetius.config
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.config_inst.rst
+++ b/docs/source/modules/panaetius.config_inst.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.config_inst`
+---------------------------------------
+
+.. automodule:: panaetius.config_inst
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.db.rst
+++ b/docs/source/modules/panaetius.db.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.db`
+-------------------------------------
+
+.. automodule:: panaetius.db
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.header.rst
+++ b/docs/source/modules/panaetius.header.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.header`
+-------------------------------------
+
+.. automodule:: panaetius.header
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.library.rst
+++ b/docs/source/modules/panaetius.library.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.library`
+-------------------------------------
+
+.. automodule:: panaetius.library
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.logging.rst
+++ b/docs/source/modules/panaetius.logging.rst
@@ -0,0 +1,9 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius.logging`
+-------------------------------------
+
+.. automodule:: panaetius.logging
+   :members:
+   :undoc-members:
+   :show-inheritance:
--- a/docs/source/modules/panaetius.rst
+++ b/docs/source/modules/panaetius.rst
@@ -0,0 +1,21 @@
+.. include:: ../global.rst
+
+Config :modname:`panaetius`
+-------------------------------------
+
+.. automodule:: panaetius
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+
+   panaetius.config
+   panaetius.config_inst
+   panaetius.db
+   panaetius.header
+   panaetius.library
+   panaetius.logging