Skip to content

Commit 388c319

Browse files
style: pre-commit fixes
1 parent aa67de9 commit 388c319

File tree

1 file changed

+10
-14
lines changed

1 file changed

+10
-14
lines changed

docs/pages/guides/docs.md

Lines changed: 10 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,15 @@ and Mkdocs, and uses the modern MyST plugin to get Markdown support.
4343
> collection of notebooks using Sphinx internally. Can also be used for docs,
4444
> though, see [echopype](https://echopype.readthedocs.io).
4545
46-
4746
{: .warning-title }
4847

4948
> The Future of MkDocs
5049
>
51-
> The creators of `mkdocs-material` and `mkdocstrings` have come together
52-
> to create a new documentation package called [Zensical](https://zensical.org/about/).
53-
> The framework is still in alpha development, but aims to simplify the
54-
> documentation process, be blazing fast, and move away from the limitations
55-
> of MkDocs.
50+
> The creators of `mkdocs-material` and `mkdocstrings` have come together to
51+
> create a new documentation package called
52+
> [Zensical](https://zensical.org/about/). The framework is still in alpha
53+
> development, but aims to simplify the documentation process, be blazing fast,
54+
> and move away from the limitations of MkDocs.
5655
5756
## What to include
5857

@@ -109,9 +108,8 @@ docs = [
109108
]
110109
```
111110

112-
You should include the docs group via `--group=docs` when using uv or pip to install,
113-
or install all groups, such as by running `uv sync --all-groups`.
114-
111+
You should include the docs group via `--group=docs` when using uv or pip to
112+
install, or install all groups, such as by running `uv sync --all-groups`.
115113

116114
There is a sphinx-quickstart tool, but it creates unnecessary files (make/bat,
117115
we recommend a cross-platform noxfile instead), and uses rST instead of
@@ -278,13 +276,12 @@ to mark where you want the docs portion to start.
278276

279277
You can add the standard indices and tables at the end.
280278

281-
282279
{% endtab %} {% tab mkdocs MkDocs %}
283280

284281
While the cookie cutter creates a basic structure for your MkDocs (a top level
285282
`mkdocs.yml` file and the `docs` directory), you can also follow the official
286283
[Getting started](https://squidfunk.github.io/mkdocs-material/getting-started/)
287-
guide instead.
284+
guide instead.
288285

289286
If you selected the `mkdocs` option when using the template cookie-cutter
290287
repository, you will already have this group. Otherwise, add to your
@@ -302,9 +299,8 @@ docs = [
302299
]
303300
```
304301

305-
You should include the docs group via `--group=docs` when using uv or pip to install,
306-
or install all groups, such as by running `uv sync --all-groups`.
307-
302+
You should include the docs group via `--group=docs` when using uv or pip to
303+
install, or install all groups, such as by running `uv sync --all-groups`.
308304

309305
These dependencies include several common plugins---such as generating reference
310306
API documentation from docstrings---to make life easier.

0 commit comments

Comments
 (0)