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 · c113e96 · c113e96
1 parent ed3cc81
commit c113e96
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGES b/CHANGES
@@ -35,6 +35,8 @@ Bugs fixed
 * #9568: autosummary: summarise overlined sectioned headings correctly
 * #9600: autosummary: Type annotations which contain commas in autosummary table
   are not removed completely
+* #9608: apidoc: apidoc does not generate a module definition for implicit
+  namespace package
 * #9481: c domain: some warnings contain non-existing filenames
 * #9481: cpp domain: some warnings contain non-existing filenames
 * #9456: html search: abbreation marks are inserted to the search result if

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 %}