From f49271986f06112163c61c2df9ad9152949f4237 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sat, 4 Sep 2021 22:07:28 +0900 Subject: [PATCH] Fix #9608: apidoc: module is not described if implicit namespace package To make implicit namespace packages referencable, this outputs empty module definitions for them. --- CHANGES | 2 ++ sphinx/templates/apidoc/package.rst_t | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/CHANGES b/CHANGES index c7e781de868..5d31ebcefc6 100644 --- 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 index b7380e8a04c..2229c311b4c 100644 --- 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 %}