From a03f5c41d97ca313d9db99bf6953d1082acad837 Mon Sep 17 00:00:00 2001 From: ilia Date: Fri, 29 Sep 2023 07:18:26 +0300 Subject: [PATCH] fix structure --- controls/Licence.txt => Licence.txt | 0 README.md | 11 ++++++++--- controls/pyproject.toml => pyproject.toml | 0 controls/requirements.txt => requirements.txt | 0 4 files changed, 8 insertions(+), 3 deletions(-) rename controls/Licence.txt => Licence.txt (100%) rename controls/pyproject.toml => pyproject.toml (100%) rename controls/requirements.txt => requirements.txt (100%) diff --git a/controls/Licence.txt b/Licence.txt similarity index 100% rename from controls/Licence.txt rename to Licence.txt diff --git a/README.md b/README.md index 6118636..7a75e93 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # advanced-python-homework-2023 +## Materials +- [Homework](https://sciprogcentre.github.io/green-courses/advanced_python.html) -## Controls +## Controls (1st homework) ### Venv creation: ``` @@ -10,6 +12,7 @@ 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` @@ -25,5 +28,7 @@ extensions = [ 'sphinx.ext.autosummary', ] ``` -4. build docs `sphinx-build -M html docs/source/ docs/build/` -5. docs are now in `docs/build/html` +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` diff --git a/controls/pyproject.toml b/pyproject.toml similarity index 100% rename from controls/pyproject.toml rename to pyproject.toml diff --git a/controls/requirements.txt b/requirements.txt similarity index 100% rename from controls/requirements.txt rename to requirements.txt