feat/OPS-61: added auto documentation for haiku.py, main.py and store_manager.py

At the moment it works by converting senju into a python package. This causes the html docu to start with a link 'senju package' which lists all three moduls and their documentation. I will try now to make it so all three moduls have a docu link of their own.

The method foobar in each modul is for testing purposes and should be deleted once full functionality is confirmed.
This commit is contained in:
Joscha Dierks 2025-03-15 19:40:35 +01:00
parent 39369a65d6
commit b9c4091299
12 changed files with 250 additions and 44 deletions

View file

@ -1,7 +0,0 @@
haiku module
============
.. automodule:: haiku
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,7 +0,0 @@
main module
===========
.. automodule:: main
:members:
:undoc-members:
:show-inheritance:

View file

@ -1,9 +0,0 @@
senju
=====
.. toctree::
:maxdepth: 4
haiku
main
store_manager

View file

@ -1,7 +0,0 @@
store\_manager module
=====================
.. automodule:: store_manager
:members:
:undoc-members:
:show-inheritance:

View file

@ -9,7 +9,8 @@ import os
import sys
from pathlib import Path
sys.path.insert(0, os.path.abspath("../../senju"))
senju_path = os.path.abspath("../../")
print("FFFFFFFFFFFFFFFFFFFFFFFFFF", senju_path, sys.path)
project = 'senju'
copyright = '2025, senju hashirama'
author = 'senju hashirama'

View file

@ -4,7 +4,7 @@
contain the root `toctree` directive.
Welcome senju documentation
===================
===========================
Add your content using ``reStructuredText`` syntax. See the
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_