advanced-python-homework-2023/README.md

35 lines
793 B
Markdown
Raw Normal View History

2023-09-19 12:27:43 +03:00
# advanced-python-homework-2023
2023-09-29 07:18:26 +03:00
## Materials
- [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html)
2023-09-28 22:04:57 +03:00
2023-09-29 07:18:26 +03:00
## Controls (1st homework)
2023-09-28 22:04:57 +03:00
### Venv creation:
```
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
```
### Documentation
2023-09-29 07:18:26 +03:00
#### From scratch
2023-09-28 22:04:57 +03:00
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',
]
```
2023-09-29 07:18:26 +03:00
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`