0

I have multiple small projects that are somewhat related to eachother so i want them to be in single sphinx documentation.

Each handler.py module have different docstring but when i build documentation both modules reference handler.py from App1.

Each App is single project but containing similar file names:

/
├─ conf.py
├─ index.rst
├─ App1/
│  ├─ handler.py
│  ├─ errors.py
│  ├─ DOCS/
│  │  ├─ modules.rst
│  │  ├─ handler.rst
│  │  ├─ errors.rst
├─ App2/
│  ├─ DOCS/
│  │  ├─ modules.rst
│  │  ├─ handler.rst
│  ├─ handler.py

in root "conf.py" i insert paths for them:

sys.path.insert(0, os.path.abspath("App1/"))
sys.path.insert(0, os.path.abspath("App2/"))

in root "index.rst" i include them in toctree:

.. toctree::
   :maxdepth: 12
   :caption: Content:

   
   app1/docs/modules
   app2/docs/modules

each hander.rst contains:

handler module
================

.. automodule:: handler
   :members:
   :undoc-members:
   :show-inheritance:

How should i structure or reference python files so that each App.handler page contains docstring only from that app handler.py?

Fryger
  • 1
  • 1

0 Answers0