tambovtsev.io/advanced-python-homework-2023
1
0
Fork 0
forked from Advanced_Python/advanced-python-homework-2023
Code Pull Requests Activity

edit readme

Browse Source
This commit is contained in:
ilia 2023-09-28 22:04:57 +03:00
parent 9cbb7ba909
commit 0c48a5fc16
2 changed files with 28 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -1 +1,29 @@
# advanced-python-homework-2023 # advanced-python-homework-2023
## 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`

27
controls/README.md
View File

@ -1,27 +0,0 @@
# 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`