From 35d095030233a95ff2fd9ba80bc50db5aadf1d1f Mon Sep 17 00:00:00 2001 From: mm21 Date: Sun, 20 Aug 2023 19:55:12 -0700 Subject: [PATCH 1/2] Add API to manually update database before writing files --- src/autodoc2/config.py | 8 ++++++++ src/autodoc2/sphinx/extension.py | 4 ++++ 2 files changed, 12 insertions(+) diff --git a/src/autodoc2/config.py b/src/autodoc2/config.py index 79fe011..b0255de 100644 --- a/src/autodoc2/config.py +++ b/src/autodoc2/config.py @@ -485,6 +485,14 @@ class Config: }, ) + db_fixup: t.Callable = dc.field( + default = None, + metadata={ + "help": "Callback to fixup database, e.g. manually set 'all' if __all__ is dynamic", + "category": "render", + }, + ) + # TODO regexes # module_summary: bool | None = None # class_inheritance: bool | None = None diff --git a/src/autodoc2/sphinx/extension.py b/src/autodoc2/sphinx/extension.py index 2feb88c..75162a8 100644 --- a/src/autodoc2/sphinx/extension.py +++ b/src/autodoc2/sphinx/extension.py @@ -196,6 +196,10 @@ def run_autodoc_package(app: Sphinx, config: Config, pkg_index: int) -> str | No def _warn_render(msg: str, type_: WarningSubtypes) -> None: warn_sphinx(msg, type_) + # invoke user-provided fixups + if config.db_fixup: + config.db_fixup(autodoc2_db) + # write the files output.mkdir(parents=True, exist_ok=True) paths = [] From 0db23c3b7f600403184e65b75b754c6c4c50a799 Mon Sep 17 00:00:00 2001 From: "pre-commit-ci[bot]" <66853113+pre-commit-ci[bot]@users.noreply.github.com> Date: Wed, 17 Jan 2024 16:17:08 +0000 Subject: [PATCH 2/2] [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --- src/autodoc2/config.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/autodoc2/config.py b/src/autodoc2/config.py index b0255de..da43466 100644 --- a/src/autodoc2/config.py +++ b/src/autodoc2/config.py @@ -486,7 +486,7 @@ class Config: ) db_fixup: t.Callable = dc.field( - default = None, + default=None, metadata={ "help": "Callback to fixup database, e.g. manually set 'all' if __all__ is dynamic", "category": "render",