Edit Question - KnowledgeHub

Title Body

I'm trying to auto-generate basic documentation for my codebase using Sphinx. However, I'm having difficulty instructing Sphinx to recursively scan my files. I have a Python codebase with a folder structure like: <workspace> └── src └── mypackage ├── __init__.py │ ├── subpackageA │ ├── __init__.py │ ├── submoduleA1 │ └── submoduleA2 │ └── subpackageB ├── __init__.py ├── submoduleB1 └── submoduleB2 I ran sphinx-quickstart in <workspace> , so now my structure looks like: <workspace> ├── src │ └── mypackage │ ├── __init__.py │ │ │ ├── subpackageA │ │ ├── __init__.py │ │ ├── submoduleA1 │ │ └── submoduleA2 │ │ │ └── subpackageB │ ├── __init__.py │ ├── submoduleB1 │ └── ubmoduleB2 │ ├── index.rst ├── _build ├── _static └── _templates I've read the quickstart tutorial , and although I'm still trying to understand the docs, the way it's worded makes me concerned that Sphinx assumes I'm going to manually create documentation files for every single module/class/function in my codebase. However, I did notice the "automodule" statement, and I enabled autodoc during quickstart, so I'm hoping most of the documentation can be automatically generated. I modified my conf.py to add my src folder to sys.path and then modified my index.rst to use automodule. So now my index.rst looks like: Contents: .. toctree:: :maxdepth: 2 Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` .. automodule:: alphabuyer :members: I have dozens of classes and functions defined in the subpackages. Yet, when I run: <

Tags (comma-separated) Cancel