Skip to content

Commit 4f2bb48

Browse files
committed
Document the hack for suppressing logging
1 parent 380b394 commit 4f2bb48

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

docs/configuration.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -64,23 +64,13 @@ You can disable this behavior by setting the following config:
6464
jupyterlite_bind_ipynb_suffix = False
6565
```
6666

67+
### Suppressing jupyterlite logging
6768

68-
## Build logging levels
69+
`jupyterlite` can produce large amounts of output to the terminal when docs are building.
70+
To silence this output, you can set
6971

70-
Jupyterlite-sphinx exposes jupyterlite debug and logging flags thought the
71-
following configuration options.
72-
73-
74-
- `jupyterlite_debug`, boolean (`False`|`True`), passes the `--debug` flag to
75-
`jupyterlite build`
76-
77-
It also has the following configuration options:
78-
79-
- `jupyterlite_log_level`, a `str` (defaults to `"WARN"`) or `None`
80-
- `jupyterlite_verbosity`, a `str` (defaults to `"0"`) or `None`
81-
- `jupyterlite_reporter`, a `str` (defaults to `"zero"`) or `None`
82-
83-
Jupyterlite-sphinx uses low verbosity by default. Setting these parameters to `None` restores the `jupyterlite build` defaults.
72+
```python
73+
jupyterlite_silence = True
74+
```
8475

85-
See the `jupyterlite build` documentation for info on `log-level`. `verbosity` and `reporter` control the configuration
86-
of [doit](https://smarie.github.io/python-doit-api/api_reference/), which is used internally in `jupyterlite`.
76+
in your `conf.py`.

0 commit comments

Comments
 (0)