api docs

docs/api.rst

@@ -0,0 +1,11 @@
+API
+===
+
+.. autosummary::
+   :toctree: DIRNAME
+
+   blag.__init__
+   blag.version
+   blag.blag
+   blag.markdown
+   blag.devserver

docs/conf.py

@@ -9,10 +9,12 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # 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('..'))
+
+import blag
 
 
 # -- Project information -----------------------------------------------------
@@ -22,7 +24,7 @@ copyright = '2021, Bastian Venthur'
 author = 'Bastian Venthur'
 
 # The full version, including alpha/beta/rc tags
-release = '0.0.0'
+release = blag.__VERSION__
 
 
 # -- General configuration ---------------------------------------------------
@@ -31,6 +33,9 @@ release = '0.0.0'
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'sphinx.ext.autosummary',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -53,3 +58,12 @@ html_theme = 'alabaster'
 # 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']
+
+autodoc_default_options = {
+    'members': True,
+    'undoc-members': True,
+    'special-members': True,
+    'secret-members': True,
+}
+
+autosummary_generate = True

docs/index.rst

@@ -10,6 +10,7 @@ Welcome to blag's documentation!
    :maxdepth: 2
    :caption: Contents:
 
+   api.rst
 
 
 Indices and tables