Docs now auto-generate from docstrings

This commit is contained in:
Jef Roosens 2020-08-27 18:18:27 +02:00
parent e41d9780a4
commit 9c1a56445b
5 changed files with 11 additions and 13 deletions

View file

@ -10,9 +10,9 @@
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import os
import sys
sys.path.insert(0, os.path.abspath('../..'))
# -- Project information -----------------------------------------------------
@ -31,6 +31,7 @@ release = '0.1'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.napoleon',
]
# Add any paths that contain templates here, relative to this directory.
@ -52,4 +53,4 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_static_path = ['_static']

View file

@ -1,8 +1,3 @@
.. Frank documentation master file, created by
sphinx-quickstart on Thu Aug 27 17:28:57 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to Frank's documentation!
=================================