From d986168c906bfcf169a17bf919fbd99d32806ff2 Mon Sep 17 00:00:00 2001 From: patnr Date: Mon, 4 Nov 2024 18:34:30 +0100 Subject: [PATCH] Minor notes --- docs/dev_guide.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/dev_guide.md b/docs/dev_guide.md index d49a9915..25140259 100644 --- a/docs/dev_guide.md +++ b/docs/dev_guide.md @@ -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 @@ -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.