Skip to content

Commit

Permalink
Minor notes
Browse files Browse the repository at this point in the history
  • Loading branch information
patnr committed Nov 4, 2024
1 parent d53c967 commit d986168
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/dev_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,8 @@ You may also want to display linting issues in your editor as you code.

## Writing documentation

The documentation is built with `mkdocs`. Try it with
The documentation is built with `mkdocs` and should be written in [markdown syntax](https://www.markdownguide.org/cheat-sheet/).
You can preview the rendered html docs by running

```sh
mkdocs serve
Expand All @@ -98,6 +99,9 @@ mkdocs serve
- Temporarily disable `mkdocs-jupyter` in `mkdocs.yml` to speed up build reloads.
- Set `validation: unrecognized_links: warn` to get warnings about linking issues.

Docstrings should be written in the [style of numpy](https://mkdocstrings.github.io/griffe/reference/docstrings/#numpydoc-style).
Additional details on the documentation system are collected in the following subsection.

### Linking to pages

You should use relative page links, including the `.md` extension.
Expand Down

0 comments on commit d986168

Please sign in to comment.