mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
28 lines
445 B
Markdown
28 lines
445 B
Markdown
|
|
# 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`
|
|
|
|
|
|
|