Skip to content

Commit d61709a

Browse files
Samreayhenryiii
authored andcommitted
Updating mkdocs
1 parent 8e3ebf1 commit d61709a

2 files changed

Lines changed: 13 additions & 11 deletions

File tree

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ scientists and research software engineers. The repository contains:
1111
## Contributing to the documentation
1212

1313
To build locally, install rbenv (remember to run `rbenv init` after installing,
14-
and `rbenv install 3.1.2`). Then:
14+
and `rbenv install 3.4.1`). Then:
1515

1616
```bash
1717
bundle install

docs/pages/guides/docs.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,19 +24,21 @@ and uses the modern MyST plugin to get Markdown support.
2424
>
2525
> - [Sphinx](https://www.sphinx-doc.org/en/master/): A popular documentation
2626
> framework for scientific libraries with a history of close usage with scientific
27-
> tools like LaTeX.
28-
> - [JupyterBook](https://jupyterbook.org): A powerful system for rendering a
29-
> collection of notebooks using Sphinx internally. Can also be used for docs,
30-
> though, see [echopype](https://echopype.readthedocs.io).
27+
> tools like LaTeX. Examples include [astropy](https://docs.astropy.org/en/stable/index_user_docs.html)
28+
> and [corner](https://docs.astropy.org/en/stable/index_user_docs.html).
3129
> - [MkDocs](https://www.mkdocs.org): A from-scratch new documentation system
3230
> based on markdown and HTML. Less support for man pages & PDFs than Sphinx,
3331
> since it doesn't use docutils. Has over
3432
> [200 plugins](https://github.com/mkdocs/catalog) - they are much easier to
3533
> write than Sphinx. Example sites include [hatch](https://hatch.pypa.io),
3634
> [PDM](https://pdm.fming.dev),
3735
> [cibuildwheel](https://cibuildwheel.readthedocs.io),
38-
> [Textual](https://textual.textualize.io), and
39-
> [pipx](https://pypa.github.io/pipx/).
36+
> [Textual](https://textual.textualize.io),
37+
> [pipx](https://pypa.github.io/pipx/), [Pydantic](https://docs.pydantic.dev/latest/),
38+
> [Polars](https://docs.pola.rs/), and [FastAPI](https://fastapi.tiangolo.com/)
39+
> - [JupyterBook](https://jupyterbook.org): A powerful system for rendering a
40+
> collection of notebooks using Sphinx internally. Can also be used for docs,
41+
> though, see [echopype](https://echopype.readthedocs.io).
4042
4143
## What to include
4244

@@ -69,16 +71,16 @@ with render_cookie() as package:
6971

7072
## Hand-written docs
7173

72-
Create `docs/` directory within your project (i.e. next to `src/`). From here,
74+
Create `docs/` directory within your project (next to `src/`). From here,
7375
Sphinx and MkDocs diverge.
7476

75-
{% tabs %} {% tab sphinx Sphinx %}
76-
77+
{% tabs %}{% tab sphinx Sphinx %}
7778

7879
There is a sphinx-quickstart tool, but it creates unnecessary files (make/bat, we recommend
7980
a cross-platform noxfile instead), and uses rST instead of Markdown. Instead,
8081
this is our recommended starting point for `conf.py`:
8182

83+
8284
### conf.py
8385

8486
<!-- [[[cog
@@ -265,7 +267,7 @@ If you selected the `mkdocs` option when using the template cookie-cutter reposi
265267

266268
```toml
267269
[dependency-groups]
268-
docs = docs = [
270+
docs = [
269271
"Markdown>=3.9",
270272
"mkdocs>=1.1.2,<2",
271273
"mkdocs-material>=9.1.19,<10",

0 commit comments

Comments
 (0)