chore: lowercase for filenames

This commit is contained in:
Benoit Chevallier-Mames
2021-12-09 16:25:57 +01:00
committed by Benoit Chevallier
parent 6b3adc217f
commit bdb1140bee
36 changed files with 59 additions and 59 deletions

View File

@@ -0,0 +1,27 @@
# Documenting
## Using Sphinx
One can simply create docs with Sphinx and open them, by doing:
```shell
make docs
```
Remark 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
```shell
make open_docs
```
On other systems, simply open `docs/_build/html/index.html`