setup.py
setup.cfg
docs/
example_package/
# No __init__.py here.
middle_package/
# No __init__.py here.
subpackage_a/
# Sub-packages have __init__.py.
__init__.py
test_a.py
When running:
sphinx-apidoc --implicit-namespaces --force -o docs/ ./example_package/
$(MAKE) -C docs html
sphinx-apidox is not putting the packages into the toc in the docs as expected.
Giving a consistency fault in the sphinx-builder:
checking consistency... ./example_pkg/docs/example_package.middle_package.rst: WARNING: document isn't included in any toctree
The output from sphinx-apidoc to example_package.rst:
Describe the bug
When using a python project with native namespace, as per documentation https://packaging.python.org/namespace_packages, but with an extra namespace level like:
When running:
sphinx-apidox is not putting the packages into the toc in the docs as expected. Giving a consistency fault in the sphinx-builder:
checking consistency... ./example_pkg/docs/example_package.middle_package.rst: WARNING: document isn't included in any toctree
The output from sphinx-apidoc to
example_package.rst
:where the expected output is:
How to Reproduce
get project from github
create and setup virtual environment
generate documentation
Expected behavior
No response
Your project
https://github.com/michiel007/example_pkg
Screenshots
No response
OS
ubuntu 20.04 LTS
Python version
3.8
Sphinx version
4.2.0
Sphinx extensions
sphinx.ext.autodoc
Extra tools
browser (optional)
Additional context
No response