alexander/urban-meal-delivery
1
1
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity Actions

Add technical documentation for the package

Browse source 
- use sphinx to document the developed package
- create a nox session "docs" that builds the docs
- include a skeleton in the docs/ folder
  + how to install the package
  + how to use nox
  + license
This commit is contained in:
Alexander Hess 2020-08-05 01:34:27 +02:00
commit 882226f0a9
Signed by: alexander
GPG key ID: 344EA5AB10D868E0
9 changed files with 503 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

4
pyproject.toml
View file

@ -55,5 +55,9 @@ pytest = "^6.0.1"
pytest-cov = "^2.10.0"
xdoctest = { version="^0.13.0", extras=["optional"] }
# Documentation
sphinx = "^3.1.2"
sphinx-autodoc-typehints = "^1.11.0"
[tool.poetry.scripts]
umd = "urban_meal_delivery.console:main"