28 lines
569 B
Markdown
28 lines
569 B
Markdown
|
# Controls
|
||
|
|
|
||
|
|
## Venv creation:
|
||
|
|
```
|
||
|
|
python -m venv .venv
|
||
|
|
source .venv/bin/activate
|
||
|
|
pip install -r requirements.txt
|
||
|
|
```
|
||
|
|
|
||
|
|
## Documentation
|
||
|
|
1. run sphinx initialization: `sphinx-quickstart docs`
|
||
|
|
2. add project packages: `sphinx-apidoc -o docs/source .`
|
||
|
|
3. edit `conf.py`
|
||
|
|
```py
|
||
|
|
import sys
|
||
|
|
import os
|
||
|
|
sys.path.insert(0, os.path.abspath("../../"))
|
||
|
|
|
||
|
|
extensions = [
|
||
|
|
'sphinx.ext.duration',
|
||
|
|
'sphinx.ext.doctest',
|
||
|
|
'sphinx.ext.autodoc',
|
||
|
|
'sphinx.ext.autosummary',
|
||
|
|
]
|
||
|
|
```
|
||
|
|
4. build docs `sphinx-build -M html docs/source/ docs/build/`
|
||
|
|
5. docs are now in `docs/build/html`
|