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

15
docs/conf.py Normal file
View file

@ -0,0 +1,15 @@
"""Configure sphinx."""
import urban_meal_delivery as umd
project = umd.__pkg_name__
author = umd.__author__
copyright = f'2020, {author}' # pylint:disable=redefined-builtin
version = release = umd.__version__
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
'sphinx_autodoc_typehints',
]