forked from Advanced_Python/advanced-python-homework-2023
35 lines
793 B
Markdown
35 lines
793 B
Markdown
# advanced-python-homework-2023
|
|
## Materials
|
|
- [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html)
|
|
|
|
## Controls (1st homework)
|
|
|
|
### Venv creation:
|
|
```
|
|
python -m venv .venv
|
|
source .venv/bin/activate
|
|
pip install -r requirements.txt
|
|
```
|
|
|
|
### Documentation
|
|
#### From scratch
|
|
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. add `modules` after `Contents:` in `index.rst`
|
|
#### Build
|
|
1. build docs `sphinx-build -M html docs/source/ docs/build/`
|
|
1. docs are now in `docs/build/html`
|