From 1a52183f10945b597e42220a636ffc814b9133b4 Mon Sep 17 00:00:00 2001 From: Jeremy Bradley-Silverio Donato Date: Thu, 6 Jan 2022 17:40:12 +0100 Subject: [PATCH] docs: Update documenting.md --- docs/dev/howto/documenting.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/dev/howto/documenting.md b/docs/dev/howto/documenting.md index cd955691a..53965b09a 100644 --- a/docs/dev/howto/documenting.md +++ b/docs/dev/howto/documenting.md @@ -9,13 +9,13 @@ One can simply create docs with Sphinx and open them, by doing: make docs ``` -Remark that this needs to be done in docker. +Reminder that this needs to be done in docker. The documentation contains both files written by hand by developers (the .md files) and files automatically created by parsing the source files. ### Opening doc -On macOS, one can do +On macOS, you can do ```shell make open_docs