|
3 | 3 |
|
4 | 4 | """Utilities to build noxfiles. |
5 | 5 |
|
6 | | -The main entry point is the [`configure()`][frequenz.repo.config.nox.configure] function, which will |
7 | | -configure all nox sessions according to some configuration. |
| 6 | +The main entry point is the [`configure()`][frequenz.repo.config.nox.configure] |
| 7 | +function, which will configure all nox sessions according to some configuration. |
8 | 8 |
|
9 | 9 | To use the default options, you should call `configure()` using one of the [repository |
10 | 10 | types][frequenz.repo.config.RepositoryType]. For example: |
|
15 | 15 | nox.configure(RepositoryType.LIB) |
16 | 16 | ``` |
17 | 17 |
|
18 | | -Again, make sure to pick the correct project typedefault configuration based on the type of your |
19 | | -project (`actor_config`, `api_config`, `app_config`, `lib_config`, `model_config`). |
| 18 | +Again, make sure to pick the correct project typedefault configuration based on the type |
| 19 | +of your project (`actor_config`, `api_config`, `app_config`, `lib_config`, |
| 20 | +`model_config`). |
20 | 21 |
|
21 | 22 | If you need to use some custom configuration, you can start from the default settings in |
22 | 23 | the [`frequenz.repo.config.nox.default`][] module, |
|
32 | 33 | nox.configure(config) |
33 | 34 | ``` |
34 | 35 |
|
35 | | -If you need further customization or to define new sessions, you can use the |
36 | | -following modules: |
| 36 | +If you need further customization or to define new sessions, you can use the following |
| 37 | +modules: |
37 | 38 |
|
38 | | -- [`frequenz.repo.config.nox.config`][]: Low-level utilities to configure nox sessions. It defines the |
39 | | - `Config` and CommandsOptions` classes and the actual implementation of the |
40 | | - `configure()` function. It also defines the `get()` function, which can be |
41 | | - used to get the currently used configuration object. |
| 39 | +- [`frequenz.repo.config.nox.config`][]: Low-level utilities to configure nox sessions. |
| 40 | + It defines the `Config` and CommandsOptions` classes and the actual implementation of |
| 41 | + the `configure()` function. It also defines the `get()` function, which can be used to |
| 42 | + get the currently used configuration object. |
42 | 43 |
|
43 | | -- [`frequenz.repo.config.nox.session`][]: Predefined nox sessions. These are the sessions that are used |
44 | | - by default. |
| 44 | +- [`frequenz.repo.config.nox.session`][]: Predefined nox sessions. These are the |
| 45 | + sessions that are used by default. |
45 | 46 |
|
46 | 47 | - [`frequenz.repo.config.nox.util`][]: General purpose utility functions. |
47 | 48 | """ |
|
0 commit comments