docs: Update documenting.md

This commit is contained in:
Jeremy Bradley-Silverio Donato
2022-01-06 17:40:12 +01:00
committed by Benoit Chevallier
parent db3e922ba2
commit 1a52183f10

View File

@@ -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