feat/OPS-61: fix - documentation works without converting senju into a python package.

Important: It seems the sphinx commands only work by entering the virtual environment of senju by copying the command/output of
```poetry env activate```
Inside the env install/update the poetry packages to ensure that you use the correct version of sphinx. Afterward cd into the senju/docs folder and execute auto_docu.sh
You can open the docu with
```firefox build/html/index.html```
This commit is contained in:
Joscha Dierks 2025-03-15 19:55:10 +01:00
parent b9c4091299
commit 20855b2117
7 changed files with 35 additions and 3 deletions

4
docs/auto_docu.sh Normal file
View file

@ -0,0 +1,4 @@
#!/bin/bash
sphinx-apidoc -o source/_modules ../senju
poetry run make clean
poetry run make html

View file

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

View file

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

View file

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

View file

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

View file

@ -7,10 +7,8 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
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