Skip to content

Commit 0122b58

Browse files
chrisjsewellchrisjsewell
authored
‼️ autodoc2_packages dict now only for analysis (#8)
1 parent 6738b64 commit 0122b58

File tree

11 files changed

+52
-399
lines changed

11 files changed

+52
-399
lines changed

‎docs/apidocs/autodoc2/autodoc2.config.rst

Lines changed: 2 additions & 206 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,6 @@ Classes
1616
:class: autosummary longtable
1717
:align: left
1818

19-
* - :py:obj:`RenderConfig <autodoc2.config.RenderConfig>`
20-
- .. autodoc2-docstring:: autodoc2.config.RenderConfig
21-
:summary:
2219
* - :py:obj:`PackageConfig <autodoc2.config.PackageConfig>`
2320
- .. autodoc2-docstring:: autodoc2.config.PackageConfig
2421
:summary:
@@ -36,9 +33,6 @@ Functions
3633
* - :py:obj:`_coerce_packages <autodoc2.config._coerce_packages>`
3734
- .. autodoc2-docstring:: autodoc2.config._coerce_packages
3835
:summary:
39-
* - :py:obj:`_validate_string_list <autodoc2.config._validate_string_list>`
40-
- .. autodoc2-docstring:: autodoc2.config._validate_string_list
41-
:summary:
4236
* - :py:obj:`_validate_replace_list <autodoc2.config._validate_replace_list>`
4337
- .. autodoc2-docstring:: autodoc2.config._validate_replace_list
4438
:summary:
@@ -89,109 +83,6 @@ API
8983

9084
.. autodoc2-docstring:: autodoc2.config.CONFIG_PREFIX
9185

92-
.. py:class:: RenderConfig
93-
:canonical: autodoc2.config.RenderConfig
94-
95-
.. autodoc2-docstring:: autodoc2.config.RenderConfig
96-
97-
.. py:attribute:: module_all_regexes
98-
:canonical: autodoc2.config.RenderConfig.module_all_regexes
99-
:type: list[typing.Pattern[str]]
100-
:value: None
101-
102-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.module_all_regexes
103-
104-
.. py:attribute:: skip_module_regexes
105-
:canonical: autodoc2.config.RenderConfig.skip_module_regexes
106-
:type: list[typing.Pattern[str]]
107-
:value: None
108-
109-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.skip_module_regexes
110-
111-
.. py:attribute:: hidden_objects
112-
:canonical: autodoc2.config.RenderConfig.hidden_objects
113-
:type: set[typing.Literal[undoc, dunder, private, inherited]]
114-
:value: None
115-
116-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.hidden_objects
117-
118-
.. py:attribute:: hidden_regexes
119-
:canonical: autodoc2.config.RenderConfig.hidden_regexes
120-
:type: list[typing.Pattern[str]]
121-
:value: None
122-
123-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.hidden_regexes
124-
125-
.. py:attribute:: deprecated_module_regexes
126-
:canonical: autodoc2.config.RenderConfig.deprecated_module_regexes
127-
:type: list[typing.Pattern[str]]
128-
:value: None
129-
130-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.deprecated_module_regexes
131-
132-
.. py:attribute:: no_index
133-
:canonical: autodoc2.config.RenderConfig.no_index
134-
:type: bool
135-
:value: None
136-
137-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.no_index
138-
139-
.. py:attribute:: module_summary
140-
:canonical: autodoc2.config.RenderConfig.module_summary
141-
:type: bool
142-
:value: None
143-
144-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.module_summary
145-
146-
.. py:attribute:: class_docstring
147-
:canonical: autodoc2.config.RenderConfig.class_docstring
148-
:type: typing.Literal[merge, both]
149-
:value: None
150-
151-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.class_docstring
152-
153-
.. py:attribute:: class_inheritance
154-
:canonical: autodoc2.config.RenderConfig.class_inheritance
155-
:type: bool
156-
:value: None
157-
158-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.class_inheritance
159-
160-
.. py:attribute:: annotations
161-
:canonical: autodoc2.config.RenderConfig.annotations
162-
:type: bool
163-
:value: None
164-
165-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.annotations
166-
167-
.. py:attribute:: sort_names
168-
:canonical: autodoc2.config.RenderConfig.sort_names
169-
:type: bool
170-
:value: None
171-
172-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.sort_names
173-
174-
.. py:attribute:: replace_annotations
175-
:canonical: autodoc2.config.RenderConfig.replace_annotations
176-
:type: list[tuple[str, str]]
177-
:value: None
178-
179-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.replace_annotations
180-
181-
.. py:attribute:: replace_bases
182-
:canonical: autodoc2.config.RenderConfig.replace_bases
183-
:type: list[tuple[str, str]]
184-
:value: None
185-
186-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.replace_bases
187-
188-
.. py:attribute:: docstring_parser_regexes
189-
:canonical: autodoc2.config.RenderConfig.docstring_parser_regexes
190-
:type: list[tuple[typing.Pattern[str], str]]
191-
:value: None
192-
193-
.. autodoc2-docstring:: autodoc2.config.RenderConfig.docstring_parser_regexes
194-
19586
.. py:class:: PackageConfig
19687
:canonical: autodoc2.config.PackageConfig
19788

@@ -220,88 +111,18 @@ API
220111

221112
.. py:attribute:: exclude_dirs
222113
:canonical: autodoc2.config.PackageConfig.exclude_dirs
223-
:type: list[str] | None
114+
:type: list[str]
224115
:value: None
225116

226117
.. autodoc2-docstring:: autodoc2.config.PackageConfig.exclude_dirs
227118

228119
.. py:attribute:: exclude_files
229120
:canonical: autodoc2.config.PackageConfig.exclude_files
230-
:type: list[str] | None
121+
:type: list[str]
231122
:value: None
232123

233124
.. autodoc2-docstring:: autodoc2.config.PackageConfig.exclude_files
234125

235-
.. py:attribute:: module_all_regexes
236-
:canonical: autodoc2.config.PackageConfig.module_all_regexes
237-
:type: list[typing.Pattern[str]] | None
238-
:value: None
239-
240-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.module_all_regexes
241-
242-
.. py:attribute:: skip_module_regexes
243-
:canonical: autodoc2.config.PackageConfig.skip_module_regexes
244-
:type: list[typing.Pattern[str]] | None
245-
:value: None
246-
247-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.skip_module_regexes
248-
249-
.. py:attribute:: hidden_objects
250-
:canonical: autodoc2.config.PackageConfig.hidden_objects
251-
:type: set[typing.Literal[undoc, dunder, private, inherited]] | None
252-
:value: None
253-
254-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.hidden_objects
255-
256-
.. py:attribute:: hidden_regexes
257-
:canonical: autodoc2.config.PackageConfig.hidden_regexes
258-
:type: list[typing.Pattern[str]] | None
259-
:value: None
260-
261-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.hidden_regexes
262-
263-
.. py:attribute:: deprecated_module_regexes
264-
:canonical: autodoc2.config.PackageConfig.deprecated_module_regexes
265-
:type: list[typing.Pattern[str]] | None
266-
:value: None
267-
268-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.deprecated_module_regexes
269-
270-
.. py:attribute:: module_summary
271-
:canonical: autodoc2.config.PackageConfig.module_summary
272-
:type: bool | None
273-
:value: None
274-
275-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.module_summary
276-
277-
.. py:attribute:: class_inheritance
278-
:canonical: autodoc2.config.PackageConfig.class_inheritance
279-
:type: bool | None
280-
:value: None
281-
282-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.class_inheritance
283-
284-
.. py:attribute:: class_docstring
285-
:canonical: autodoc2.config.PackageConfig.class_docstring
286-
:type: typing.Literal[merge, both] | None
287-
:value: None
288-
289-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.class_docstring
290-
291-
.. py:attribute:: annotations
292-
:canonical: autodoc2.config.PackageConfig.annotations
293-
:type: bool | None
294-
:value: None
295-
296-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.annotations
297-
298-
.. py:attribute:: sort_names
299-
:canonical: autodoc2.config.PackageConfig.sort_names
300-
:type: bool | None
301-
:value: None
302-
303-
.. autodoc2-docstring:: autodoc2.config.PackageConfig.sort_names
304-
305126
.. py:method:: as_triple() -> typing.Iterable[tuple[str, typing.Any, dataclasses.Field]]
306127
:canonical: autodoc2.config.PackageConfig.as_triple
307128

@@ -313,12 +134,6 @@ API
313134
.. autodoc2-docstring:: autodoc2.config._coerce_packages
314135
:parser:
315136

316-
.. py:function:: _validate_string_list(name: str, item: typing.Any) -> list[str]
317-
:canonical: autodoc2.config._validate_string_list
318-
319-
.. autodoc2-docstring:: autodoc2.config._validate_string_list
320-
:parser:
321-
322137
.. py:function:: _validate_replace_list(name: str, item: typing.Any) -> list[typing.Tuple[str, str]]
323138
:canonical: autodoc2.config._validate_replace_list
324139

@@ -374,20 +189,6 @@ API
374189

375190
.. autodoc2-docstring:: autodoc2.config.Config.output_dir
376191

377-
.. py:attribute:: exclude_dirs
378-
:canonical: autodoc2.config.Config.exclude_dirs
379-
:type: list[str]
380-
:value: None
381-
382-
.. autodoc2-docstring:: autodoc2.config.Config.exclude_dirs
383-
384-
.. py:attribute:: exclude_files
385-
:canonical: autodoc2.config.Config.exclude_files
386-
:type: list[str]
387-
:value: None
388-
389-
.. autodoc2-docstring:: autodoc2.config.Config.exclude_files
390-
391192
.. py:attribute:: render_plugin
392193
:canonical: autodoc2.config.Config.render_plugin
393194
:type: type[autodoc2.render.base.RendererBase]
@@ -511,8 +312,3 @@ API
511312
:canonical: autodoc2.config.Config.as_triple
512313

513314
.. autodoc2-docstring:: autodoc2.config.Config.as_triple
514-
515-
.. py:method:: to_render_config(pkg_index: int | None) -> autodoc2.config.RenderConfig
516-
:canonical: autodoc2.config.Config.to_render_config
517-
518-
.. autodoc2-docstring:: autodoc2.config.Config.to_render_config

‎docs/apidocs/autodoc2/autodoc2.render.base.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Classes
2323
API
2424
~~~
2525

26-
.. py:class:: RendererBase(db: autodoc2.db.Database, config: autodoc2.config.RenderConfig, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
26+
.. py:class:: RendererBase(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
2727
:canonical: autodoc2.render.base.RendererBase
2828

2929
Bases: :py:obj:`abc.ABC`
@@ -57,7 +57,7 @@ API
5757

5858
.. py:property:: config
5959
:canonical: autodoc2.render.base.RendererBase.config
60-
:type: autodoc2.config.RenderConfig
60+
:type: autodoc2.config.Config
6161

6262
.. autodoc2-docstring:: autodoc2.render.base.RendererBase.config
6363
:parser:

‎docs/apidocs/autodoc2/autodoc2.render.myst_.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ API
4040

4141
.. autodoc2-docstring:: autodoc2.render.myst_._RE_DELIMS
4242

43-
.. py:class:: MystRenderer(db: autodoc2.db.Database, config: autodoc2.config.RenderConfig, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
43+
.. py:class:: MystRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
4444
:canonical: autodoc2.render.myst_.MystRenderer
4545

4646
Bases: :py:obj:`autodoc2.render.base.RendererBase`

‎docs/apidocs/autodoc2/autodoc2.render.rst_.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ API
4040

4141
.. autodoc2-docstring:: autodoc2.render.rst_._RE_DELIMS
4242

43-
.. py:class:: RstRenderer(db: autodoc2.db.Database, config: autodoc2.config.RenderConfig, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
43+
.. py:class:: RstRenderer(db: autodoc2.db.Database, config: autodoc2.config.Config, warn: typing.Callable[[str, autodoc2.utils.WarningSubtypes], None] | None = None, resolved_all: dict[str, autodoc2.utils.ResolvedDict] | None = None)
4444
:canonical: autodoc2.render.rst_.RstRenderer
4545

4646
Bases: :py:obj:`autodoc2.render.base.RendererBase`

‎docs/conf.py

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,16 +50,6 @@
5050
"https://github.com/aiidateam/aiida-core.git",
5151
"v2.2.2",
5252
),
53-
"skip_module_regexes": [
54-
r"aiida\.[^\.]+\..*",
55-
r"aiida\.(__main__|calculations|restapi|sphinxext|storage|workflows)",
56-
],
57-
"module_all_regexes": [
58-
r"aiida\.[^\.]+",
59-
],
60-
"deprecated_module_regexes": [
61-
r"aiida\.parsers\.parser",
62-
],
6353
"exclude_dirs": [
6454
"__pycache__",
6555
# "migrations",
@@ -73,6 +63,14 @@
7363
autodoc2_docstring_parser_regexes = [
7464
(r"autodoc2\.sphinx\.docstring\._example", "myst"),
7565
]
66+
autodoc2_deprecated_module_regexes = [
67+
r"aiida\.parsers\.parser",
68+
]
69+
autodoc2_module_all_regexes = [r"aiida\.[^\.]+"]
70+
autodoc2_skip_module_regexes = [
71+
r"aiida\.[^\.]+\..*",
72+
r"aiida\.(__main__|calculations|restapi|sphinxext|storage|workflows)",
73+
]
7674

7775
nitpick_ignore_regex = [
7876
(r"py:.*", r"typing_extensions.*"),

‎docs/config.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This section describes the configuration options for `sphinx-autodoc2`, that you
99
```
1010

1111
(config:package)=
12-
## By package
12+
## Package analysis
1313

1414
In the `autodoc2_packages` configuration option, an item can be a string, or a dictionary such as:
1515

‎docs/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ def my_function(): ...
138138
The [Python import documentation](https://docs.python.org/3/reference/simple_stmts.html#import)
139139
```
140140

141-
To enable this feature, set the {confval}`autodoc2_module_all_regexes` (or {confval}`autodoc2_packages[module_all_regexes]`) configuration option in your `conf.py`:
141+
To enable this feature, set the {confval}`autodoc2_module_all_regexes` configuration option in your `conf.py`:
142142

143143
```python
144144
autodoc2_module_all_regexes = [

‎src/autodoc2/cli.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,9 +254,7 @@ def _warn(msg: str, type_: WarningSubtypes) -> None:
254254
for mod_name in to_write:
255255
progress.update(task, advance=1, description=mod_name)
256256
content = "\n".join(
257-
config.render_plugin(
258-
db, config.to_render_config(None), _warn
259-
).render_item(mod_name)
257+
config.render_plugin(db, config, _warn).render_item(mod_name)
260258
)
261259
out_path = output / (mod_name + config.render_plugin.EXTENSION)
262260
paths.append(out_path)

0 commit comments

Comments
 (0)