Skip to content

Commit 37eb104

Browse files
Make grammar and formatting fixes in configuration documentation (#172)
* Some general fixes (punctuation, backticks, etc.) * Fix subject-verb agreement * Update subject-verb agreement, add missing word "rules"
1 parent 9d59522 commit 37eb104

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/configuration.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,9 @@ You would need `jupyterlite-xeus` installed in your docs build environment.
2929

3030
You can pre-install packages by adding an `environment.yml` file in the docs directory, with `xeus-python` defined as one of the dependencies. It will pre-build the environment when running the `jupyter lite build`.
3131

32-
Furthermore, this automatically installs any labextension that it founds, for example installing ipyleaflet will make ipyleaflet work without the need to manually install the jupyter-leaflet labextension.
32+
Furthermore, this automatically installs any labextension that it finds, for example, installing `ipyleaflet` will make `ipyleaflet` work without the need to manually install the `jupyter-leaflet` labextension.
3333

34-
Say you want to install NumPy, Matplotlib and ipycanvas, it can be done by creating the environment.yml file with the following content:
34+
Say you want to install NumPy, Matplotlib and ipycanvas, it can be done by creating an `environment.yml` file with the following content:
3535

3636
```yaml
3737
name: xeus-python-kernel
@@ -56,19 +56,19 @@ jupyterlite_config = "jupyterlite_config.json"
5656
## Disable the `.ipynb` docs source binding
5757

5858
By default, jupyterlite-sphinx binds the `.ipynb` source suffix so that it renders Notebooks included in the doctree with JupyterLite.
59-
This is known to bring warnings with plugins like sphinx-gallery, or to conflict with nbsphinx.
59+
This is known to bring warnings with plugins like `sphinx-gallery`, or to conflict with `nbsphinx`.
6060

6161
You can disable this behavior by setting the following config:
6262

6363
```python
6464
jupyterlite_bind_ipynb_suffix = False
6565
```
6666

67-
### Suppressing jupyterlite logging
67+
### Suppressing JupyterLite logging
6868

6969
`jupyterlite` can produce large amounts of output to the terminal when docs are building.
7070
By default, this output is silenced, but will still be printed if the invocation of
71-
`jupyterlite build` fails. To unsilence this output, set
71+
`jupyter lite build` fails. To unsilence this output, set
7272

7373
```python
7474
jupyterlite_silence = False
@@ -99,6 +99,6 @@ the [`jupyterlite_contents`](#jupyterlite-content) and the[`jupyterlite_dir`](#j
9999
options described above.
100100

101101
This is an advanced feature and users are responsible for providing sensible command line options.
102-
The standard precedence between `jupyter lite build` CLI options and other means of configuration apply.
102+
The standard precedence rules between `jupyter lite build` CLI options and other means of configuration apply.
103103
See the [jupyter lite CLI](https://jupyterlite.readthedocs.io/en/latest/reference/cli.html) documentation
104104
for more info.

0 commit comments

Comments
 (0)