Skip to content

Some general formatting fixes (punctuation, backticks, etc.) #172

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 30, 2024
Merged

Some general formatting fixes (punctuation, backticks, etc.) #172

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
925c328
Some general fixes (punctuation, backticks, etc.)
agriyakhetarpal Apr 29, 2024
68818d4
Merge changes from main
agriyakhetarpal Apr 30, 2024
c4d60bc
Fix subject-verb agreement
agriyakhetarpal Apr 30, 2024
366a875
Update subject-verb agreement, add missing word "rules"
agriyakhetarpal Apr 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ You would need `jupyterlite-xeus` installed in your docs build environment.

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`.

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.
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.

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

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

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

You can disable this behavior by setting the following config:

```python
jupyterlite_bind_ipynb_suffix = False
```

### Suppressing jupyterlite logging
### Suppressing JupyterLite logging

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

```python
jupyterlite_silence = False
Expand Down Expand Up @@ -99,6 +99,6 @@ the [`jupyterlite_contents`](#jupyterlite-content) and the[`jupyterlite_dir`](#j
options described above.

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