--include-undocumented should not apply to modules, fix #724 (#728)

mitmproxy · Aug 13, 2024 · 22503d1 · 22503d1
1 parent bff06ef
commit 22503d1
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,10 @@
 
 ## Unreleased: pdoc next
 
+- Fix a bug where entire modules would be excluded by `--no-include-undocumented`.
+  To exclude modules, see https://pdoc.dev/docs/pdoc.html#exclude-submodules-from-being-documented.
+  ([#728](https://github.com/mitmproxy/pdoc/pull/728), @mhils)
+
 ## 2024-07-24: pdoc 14.6.0
 
 - If `example.data.Data` is also exposed as `example.Data`, pdoc now links to `example.Data` in documentation.

diff --git a/pdoc/templates/default/module.html.jinja2 b/pdoc/templates/default/module.html.jinja2
@@ -244,7 +244,7 @@ See https://pdoc.dev/docs/pdoc/render_helpers.html#DefaultMacroExtension for an
     {% elif "@public" in doc.docstring %}
         {# show members explicitly marked as @public #}
         true
-    {% elif not include_undocumented and not doc.docstring %}
+    {% elif not include_undocumented and not doc.docstring and doc.kind != "module" %}
         {# hide members that are undocumented if include_undocumented has been toggled off. #}
     {% elif doc.name == "__init__" and (doc.docstring or (doc.kind == "function" and doc.signature_without_self.parameters)) %}
         {# show constructors that have a docstring or at least one extra argument #}