mirror of
https://github.com/senju1337/senju.git
synced 2025-12-24 07:39:29 +00:00
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:
parent
b9c4091299
commit
20855b2117
7 changed files with 35 additions and 3 deletions
7
docs/source/_modules/haiku.rst
Normal file
7
docs/source/_modules/haiku.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
haiku module
|
||||
============
|
||||
|
||||
.. automodule:: haiku
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
7
docs/source/_modules/main.rst
Normal file
7
docs/source/_modules/main.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
main module
|
||||
===========
|
||||
|
||||
.. automodule:: main
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
9
docs/source/_modules/modules.rst
Normal file
9
docs/source/_modules/modules.rst
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
senju
|
||||
=====
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
haiku
|
||||
main
|
||||
store_manager
|
||||
7
docs/source/_modules/store_manager.rst
Normal file
7
docs/source/_modules/store_manager.rst
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
store\_manager module
|
||||
=====================
|
||||
|
||||
.. automodule:: store_manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -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'
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue