Skip to content

Commit db8e3d5

Browse files
committed
docs(pytest-plugin[types]): Register GitCommitEnvVars for cross-referencing
why: The fixture summary table rendered by sphinx-autodoc-pytest-fixtures emits :class: cross-references for every fixture's return type. For GitCommitEnvVars (now a py:data entry after gaining a docstring) to resolve as a clickable link in that table, it must appear in the autodata directive that populates the ## Types section — the same pattern used for CreateRepoFn and CreateRepoPostInitFn. what: - Add .. autodata:: libvcs.pytest_plugin.GitCommitEnvVars at the top of the ## Types block so the type is both documented and reachable as an anchor from the fixture table link
1 parent db71ed3 commit db8e3d5

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

docs/api/pytest-plugin.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ def setup(
4545
## Types
4646

4747
```{eval-rst}
48+
.. autodata:: libvcs.pytest_plugin.GitCommitEnvVars
49+
4850
.. autoclass:: libvcs.pytest_plugin.CreateRepoFn
4951
:special-members: __call__
5052
:exclude-members: __init__, _abc_impl, _is_protocol

0 commit comments

Comments
 (0)