diff --git a/README.md b/README.md index c203314..6118636 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ # advanced-python-homework-2023 + +## Controls + +### Venv creation: +``` +python -m venv .venv +source .venv/bin/activate +pip install -r requirements.txt +``` + +### Documentation +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', +] +``` +4. build docs `sphinx-build -M html docs/source/ docs/build/` +5. docs are now in `docs/build/html` diff --git a/controls/README.md b/controls/README.md deleted file mode 100644 index cba49b5..0000000 --- a/controls/README.md +++ /dev/null @@ -1,27 +0,0 @@ -# Controls - -## Venv creation: -``` -python -m venv .venv -source .venv/bin/activate -pip install -r requirements.txt -``` - -## Documentation -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', -] -``` -4. build docs `sphinx-build -M html docs/source/ docs/build/` -5. docs are now in `docs/build/html`