From 20855b211770a1c15ed437a4ecc94cc9158afb48 Mon Sep 17 00:00:00 2001 From: Joscha Dierks Date: Sat, 15 Mar 2025 19:55:10 +0100 Subject: [PATCH] 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``` --- docs/auto_docu.sh | 4 ++++ docs/source/_modules/haiku.rst | 7 +++++++ docs/source/_modules/main.rst | 7 +++++++ docs/source/_modules/modules.rst | 9 +++++++++ docs/source/_modules/store_manager.rst | 7 +++++++ docs/source/conf.py | 4 +--- senju/__init__.py | 0 7 files changed, 35 insertions(+), 3 deletions(-) create mode 100644 docs/auto_docu.sh create mode 100644 docs/source/_modules/haiku.rst create mode 100644 docs/source/_modules/main.rst create mode 100644 docs/source/_modules/modules.rst create mode 100644 docs/source/_modules/store_manager.rst delete mode 100644 senju/__init__.py diff --git a/docs/auto_docu.sh b/docs/auto_docu.sh new file mode 100644 index 0000000..7188fe5 --- /dev/null +++ b/docs/auto_docu.sh @@ -0,0 +1,4 @@ +#!/bin/bash +sphinx-apidoc -o source/_modules ../senju +poetry run make clean +poetry run make html \ No newline at end of file diff --git a/docs/source/_modules/haiku.rst b/docs/source/_modules/haiku.rst new file mode 100644 index 0000000..6e6e926 --- /dev/null +++ b/docs/source/_modules/haiku.rst @@ -0,0 +1,7 @@ +haiku module +============ + +.. automodule:: haiku + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/_modules/main.rst b/docs/source/_modules/main.rst new file mode 100644 index 0000000..eace87b --- /dev/null +++ b/docs/source/_modules/main.rst @@ -0,0 +1,7 @@ +main module +=========== + +.. automodule:: main + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/_modules/modules.rst b/docs/source/_modules/modules.rst new file mode 100644 index 0000000..d024233 --- /dev/null +++ b/docs/source/_modules/modules.rst @@ -0,0 +1,9 @@ +senju +===== + +.. toctree:: + :maxdepth: 4 + + haiku + main + store_manager diff --git a/docs/source/_modules/store_manager.rst b/docs/source/_modules/store_manager.rst new file mode 100644 index 0000000..aa5fa7f --- /dev/null +++ b/docs/source/_modules/store_manager.rst @@ -0,0 +1,7 @@ +store\_manager module +===================== + +.. automodule:: store_manager + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/conf.py b/docs/source/conf.py index bf51d33..0cdb291 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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' diff --git a/senju/__init__.py b/senju/__init__.py deleted file mode 100644 index e69de29..0000000