Skip to content

Commit 292254c

Browse files
committed
docs: Remove broken refs and duplicate module directive
why: Sphinx warned about undefined labels and duplicate module objects. what: - replace pytest fixture ref with direct link and drop redundant {module} directive in pytest-plugin - switch vcspull ref to external link and remove unused footnote in url guide
1 parent ed24bb2 commit 292254c

2 files changed

Lines changed: 4 additions & 11 deletions

File tree

docs/pytest-plugin.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,6 @@ Looking for more flexibility, correctness, or power? Need different defaults? [C
1111
[connect with us]: https://github.com/vcs-python/libvcs/discussions
1212
```
1313

14-
```{module} libvcs.pytest_plugin
15-
16-
```
17-
1814
[pytest]: https://docs.pytest.org/
1915

2016
## Usage
@@ -29,7 +25,7 @@ Pytest will automatically detect the plugin, and its fixtures will be available.
2925

3026
## Fixtures
3127

32-
This pytest plugin works by providing {ref}`pytest fixtures <pytest:fixtures-api>`. The plugin's fixtures ensure that a fresh Git, Subversion, or Mercurial repository is available for each test. It utilizes [session-scoped fixtures] to cache initial repositories, improving performance across tests.
28+
This pytest plugin works by providing [pytest fixtures](https://docs.pytest.org/en/stable/how-to/fixtures.html). The plugin's fixtures ensure that a fresh Git, Subversion, or Mercurial repository is available for each test. It utilizes [session-scoped fixtures] to cache initial repositories, improving performance across tests.
3329

3430
[session-scoped fixtures]: https://docs.pytest.org/en/8.3.x/how-to/fixtures.html#fixture-scopes
3531

docs/url/index.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -243,8 +243,9 @@ in {mod}`urlparse` (undocumented).
243243

244244
From there, `GitURL` can be used downstream directly by other projects.
245245

246-
In our case, `libvcs`s' own {ref}`cmd` and {ref}`projects`, as well as a {ref}`vcspull:index`
247-
configuration, will be able to detect and accept various URL patterns.
246+
In our case, `libvcs`s' own {ref}`cmd` and {ref}`projects`, as well as a
247+
[vcspull configuration](https://vcspull.git-pull.com/), will be able to detect and accept various
248+
URL patterns.
248249

249250
### Matchers: Defaults
250251

@@ -255,10 +256,6 @@ When a match occurs, its `defaults` will fill in non-matched groups.
255256
When registering new matchers, higher `weight`s are checked first. If it's a valid regex grouping,
256257
it will be picked.
257258

258-
[^api-unstable]: Provisional API only
259-
260-
It's not determined if Location will be mutable or if modifications will return a new object.
261-
262259
## Explore
263260

264261
```{toctree}

0 commit comments

Comments
 (0)