From 1fbb754bde543d3d359f2c25cb947929cc3900e2 Mon Sep 17 00:00:00 2001 From: ilia Date: Fri, 29 Sep 2023 17:46:34 +0300 Subject: [PATCH] fix readme and pyproject --- README.md | 14 +++++++++++--- pyproject.toml | 8 +++----- 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 7a75e93..56e045d 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # advanced-python-homework-2023 +## Student: +[Ilia Tambovtsev](https://t.me/hyperpopa) + ## Materials - [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html) @@ -12,10 +15,17 @@ pip install -r requirements.txt ``` ### Documentation +#### Build +``` +cd docs +make.bat +``` + #### 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 @@ -29,6 +39,4 @@ extensions = [ ] ``` 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` +5. run `make.bat` diff --git a/pyproject.toml b/pyproject.toml index 4ea05b7..b6cf403 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,8 +1,8 @@ [project] name = "spam" -version = "2020.0.0" +version = "2023.0.0" description = "Lovely Spam! Wonderful Spam!" -readme = "README.rst" +readme = "README.md" requires-python = ">=3.7" license = {file = "LICENSE.txt"} keywords = ["SCADA", "mipt"] @@ -26,6 +26,4 @@ test = [ ] [project.urls] -homepage = "https://example.com" -documentation = "https://readthedocs.org" -repository = "https://github.com" +repository = "https://git.sciprog.center/tambovtsev.io/advanced-python-homework-2023"