diff --git a/src/autodoc2/config.py b/src/autodoc2/config.py index 0970e6e..f0ce8e7 100644 --- a/src/autodoc2/config.py +++ b/src/autodoc2/config.py @@ -365,7 +365,7 @@ class Config: module_summary: bool = dc.field( default=True, metadata={ - "help": "Whether to include a per-module summary.", + "help": "Whether to include tables at the top of each module with the one line summary of each item", "sphinx_type": bool, "category": "render", }, diff --git a/src/autodoc2/render/myst_.py b/src/autodoc2/render/myst_.py index 39b1623..54b4e28 100644 --- a/src/autodoc2/render/myst_.py +++ b/src/autodoc2/render/myst_.py @@ -166,9 +166,9 @@ def render_package(self, item: ItemData) -> t.Iterable[str]: ) yield "" - yield from ["### API", ""] - for name in visible_children: - yield from self.render_item(name) + yield from ["### API", ""] + for name in visible_children: + yield from self.render_item(name) def render_module(self, item: ItemData) -> t.Iterable[str]: """Create the content for a module.""" diff --git a/src/autodoc2/render/rst_.py b/src/autodoc2/render/rst_.py index 1a196f9..17b4b2e 100644 --- a/src/autodoc2/render/rst_.py +++ b/src/autodoc2/render/rst_.py @@ -159,9 +159,9 @@ def render_package(self, item: ItemData) -> t.Iterable[str]: ) yield "" - yield from ["API", "~~~", ""] - for name in visible_children: - yield from self.render_item(name) + yield from ["API", "~~~", ""] + for name in visible_children: + yield from self.render_item(name) def render_module(self, item: ItemData) -> t.Iterable[str]: """Create the content for a module."""