mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
chore: lowercase for filenames
This commit is contained in:
committed by
Benoit Chevallier
parent
6b3adc217f
commit
bdb1140bee
27
docs/dev/howto/documenting.md
Normal file
27
docs/dev/howto/documenting.md
Normal 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`
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user