forked from Advanced_Python/advanced-python-homework-2023
fix structure
This commit is contained in:
parent
0c48a5fc16
commit
a03f5c41d9
11
README.md
11
README.md
@ -1,6 +1,8 @@
|
|||||||
# advanced-python-homework-2023
|
# advanced-python-homework-2023
|
||||||
|
## Materials
|
||||||
|
- [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html)
|
||||||
|
|
||||||
## Controls
|
## Controls (1st homework)
|
||||||
|
|
||||||
### Venv creation:
|
### Venv creation:
|
||||||
```
|
```
|
||||||
@ -10,6 +12,7 @@ pip install -r requirements.txt
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Documentation
|
### Documentation
|
||||||
|
#### From scratch
|
||||||
1. run sphinx initialization: `sphinx-quickstart docs`
|
1. run sphinx initialization: `sphinx-quickstart docs`
|
||||||
2. add project packages: `sphinx-apidoc -o docs/source .`
|
2. add project packages: `sphinx-apidoc -o docs/source .`
|
||||||
3. edit `conf.py`
|
3. edit `conf.py`
|
||||||
@ -25,5 +28,7 @@ extensions = [
|
|||||||
'sphinx.ext.autosummary',
|
'sphinx.ext.autosummary',
|
||||||
]
|
]
|
||||||
```
|
```
|
||||||
4. build docs `sphinx-build -M html docs/source/ docs/build/`
|
4. add `modules` after `Contents:` in `index.rst`
|
||||||
5. docs are now in `docs/build/html`
|
#### Build
|
||||||
|
1. build docs `sphinx-build -M html docs/source/ docs/build/`
|
||||||
|
1. docs are now in `docs/build/html`
|
||||||
|
Loading…
Reference in New Issue
Block a user