Skip to content

autodoc2_module_summary = False should still print non-summary API #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

autodoc2_module_summary = False should still print non-summary API #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/autodoc2/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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",
},
Expand Down
6 changes: 3 additions & 3 deletions src/autodoc2/render/myst_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."""
Expand Down
6 changes: 3 additions & 3 deletions src/autodoc2/render/rst_.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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."""
Expand Down