Advanced_Python/advanced-python-homework-2023
1
0
Fork 9
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix readme and pyproject

Browse Source
This commit is contained in:
ilia 2023-09-29 17:46:34 +03:00
parent a03f5c41d9
commit 1fbb754bde
2 changed files with 14 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -1,4 +1,7 @@
# advanced-python-homework-2023 # advanced-python-homework-2023
## Student:
[Ilia Tambovtsev](https://t.me/hyperpopa)
## Materials ## Materials
- [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html) - [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html)
@ -12,10 +15,17 @@ pip install -r requirements.txt
``` ```
### Documentation ### Documentation
#### Build
```
cd docs
make.bat
```
#### From scratch #### 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`
```py ```py
import sys import sys
import os import os
@ -29,6 +39,4 @@ extensions = [
] ]
``` ```
4. add `modules` after `Contents:` in `index.rst` 4. add `modules` after `Contents:` in `index.rst`
#### Build 5. run `make.bat`
1. build docs `sphinx-build -M html docs/source/ docs/build/`
1. docs are now in `docs/build/html`

8
pyproject.toml
View File

@ -1,8 +1,8 @@
[project] [project]
name = "spam" name = "spam"
version = "2020.0.0" version = "2023.0.0"
description = "Lovely Spam! Wonderful Spam!" description = "Lovely Spam! Wonderful Spam!"
readme = "README.rst" readme = "README.md"
requires-python = ">=3.7" requires-python = ">=3.7"
license = {file = "LICENSE.txt"} license = {file = "LICENSE.txt"}
keywords = ["SCADA", "mipt"] keywords = ["SCADA", "mipt"]
@ -26,6 +26,4 @@ test = [
] ]
[project.urls] [project.urls]
homepage = "https://example.com" repository = "https://git.sciprog.center/tambovtsev.io/advanced-python-homework-2023"
documentation = "https://readthedocs.org"
repository = "https://github.com"