mirror of
https://github.com/zama-ai/concrete.git
synced 2026-02-09 03:55:04 -05:00
32 lines
755 B
Markdown
32 lines
755 B
Markdown
# Documentation
|
|
|
|
## Setup doc environment
|
|
|
|
Create a local python virtual environment in the `docs` directory and install dependencies.
|
|
|
|
```shell
|
|
$ virtualenv .venv
|
|
$ source .venv/bin/activate
|
|
$ pip install -r requirements.txt
|
|
```
|
|
|
|
then in the `docs` directory, compile documentation:
|
|
|
|
```
|
|
$ make html
|
|
````
|
|
|
|
and open the html file `_build/html/index.html`
|
|
|
|
### Automatic rebuild on change
|
|
|
|
If you want to have an automatic preview on every changes you could install the `sphinx-autobuild`
|
|
python package and launch a local server, inside the `docs` directory do the following:
|
|
|
|
```shell
|
|
$ pip install sphinx-autobuild
|
|
$ python -m sphinx_autobuild . _build
|
|
```
|
|
|
|
The documentation is available at [http://127.0.0.1:8000/](http://127.0.0.1:8000/) by default.
|