Skip to content

Commit 4bf6c6f

Browse files
committed
Fix broken docs cross-references
Signed-off-by: Leandro Lucarella <[email protected]>
1 parent c6688a7 commit 4bf6c6f

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/frequenz/repo/config/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@
166166
### API reference generation
167167
168168
The API documnentation can be automatically generated from the source files using the
169-
[`freq.repo.config.mkdocs`][] package as when run as a
169+
[`frequenz.repo.config.mkdocs`][] package as when run as a
170170
[`mkdocs-gen-files`](https://oprypin.github.io/mkdocs-gen-files/) plugin script.
171171
172172
To enable it you just need to make sure the `mkdocs-gen-files`, `mkdocs-literate-nav`

src/frequenz/repo/config/nox/__init__.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
"""Utilities to build noxfiles.
55
6-
The main entry point is the [`configure()`][configure] function, which will
6+
The main entry point is the [`configure()`][frequenz.repo.config.nox.configure] function, which will
77
configure all nox sessions according to some configuration.
88
99
To use the default options, you should call `configure()` using one of the [repository
@@ -35,15 +35,15 @@
3535
If you need further customization or to define new sessions, you can use the
3636
following modules:
3737
38-
- [`config`][]: Low-level utilities to configure nox sessions. It defines the
38+
- [`frequenz.repo.config.nox.config`][]: Low-level utilities to configure nox sessions. It defines the
3939
`Config` and CommandsOptions` classes and the actual implementation of the
4040
`configure()` function. It also defines the `get()` function, which can be
4141
used to get the currently used configuration object.
4242
43-
- [`session`][]: Predefined nox sessions. These are the sessions that are used
43+
- [`frequenz.repo.config.nox.session`][]: Predefined nox sessions. These are the sessions that are used
4444
by default.
4545
46-
- [`util`][]: General purpose utility functions.
46+
- [`frequenz.repo.config.nox.util`][]: General purpose utility functions.
4747
"""
4848

4949
from .config import configure

0 commit comments

Comments
 (0)