Fix sphinx-doc#9608: apidoc: module is not described if implicit name…

…space package To make implicit namespace packages referencable, this outputs empty module definitions for them.
tk0miya · Sep 4, 2021 · f492719 · f492719
1 parent 6c38f68
commit f492719
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -25,6 +25,8 @@ Features added
 Bugs fixed
 ----------
 
+* #9608: apidoc: apidoc does not generate a module definition for implicit
+  namespace package
 * #9487: autodoc: typehint for cached_property is not shown
 * #9509: autodoc: AttributeError is raised on failed resolving typehints
 * #9518: autodoc: autodoc_docstring_signature does not effect to ``__init__()``

diff --git a/sphinx/templates/apidoc/package.rst_t b/sphinx/templates/apidoc/package.rst_t
@@ -19,6 +19,10 @@
 {{- [pkgname, "package"] | join(" ") | e | heading }}
 {% endif %}
 
+{%- if is_namespace %}
+.. py:module:: {{ pkgname }}
+{% endif %}
+
 {%- if modulefirst and not is_namespace %}
 {{ automodule(pkgname, automodule_options) }}
 {% endif %}