Commit 8070809
committed
docs(pytest-plugin[types]): Register CreateRepoFn and CreateRepoPostInitFn for cross-referencing
why: The fixture summary table rendered return types like `CreateRepoFn`
as plain text instead of hyperlinks. sphinx_autodoc_pytest_fixtures
emits :class:`~libvcs.pytest_plugin.CreateRepoFn` for every fixture
returning that type, but Sphinx silently degrades to plain text when
the name is absent from the Python domain's object index — which it
was, since the Protocol classes had no autoclass directive anywhere.
what:
- Add a "Types" section to docs/api/pytest-plugin.md with autoclass
directives for CreateRepoFn and CreateRepoPostInitFn
- Use :special-members: __call__ to expose the callback contract
- Use :exclude-members: __init__, _abc_impl, _is_protocol to suppress
Protocol internals surfaced by gp-sphinx's global autodoc defaults
(private-members: True, autodoc_class_signature: "separated")1 parent 0e3f63c commit 8070809
1 file changed
+12
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
41 | 41 | | |
42 | 42 | | |
43 | 43 | | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
0 commit comments