github.com/blag
1
0
Fork 1
mirror of https://github.com/venthur/blag.git synced 2025-11-25 12:42:41 +00:00
Code Activity

api docs

Browse Source
This commit is contained in:
Bastian Venthur
2021-03-21 14:47:02 +01:00
parent e2ebd950ae
commit 14ebc2769c
3 changed files with 32 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/api.rst Normal file
View File

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

26
docs/conf.py
View File

@@ -9,10 +9,12 @@
# If extensions (or modules to document with autodoc) are in another directory, # 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 # 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. # documentation root, use os.path.abspath to make it absolute, like shown here.
#
# import os import os
# import sys import sys
# sys.path.insert(0, os.path.abspath('.')) sys.path.insert(0, os.path.abspath('..'))
import blag
# -- Project information ----------------------------------------------------- # -- Project information -----------------------------------------------------
@@ -22,7 +24,7 @@ copyright = '2021, Bastian Venthur'
author = 'Bastian Venthur' author = 'Bastian Venthur'
# The full version, including alpha/beta/rc tags # The full version, including alpha/beta/rc tags
release = '0.0.0' release = blag.__VERSION__
# -- General configuration --------------------------------------------------- # -- General configuration ---------------------------------------------------
@@ -31,6 +33,9 @@ release = '0.0.0'
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones. # ones.
extensions = [ extensions = [
'sphinx.ext.autosummary',
'sphinx.ext.autodoc',
'sphinx.ext.napoleon',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.
@@ -52,4 +57,13 @@ html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here, # 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, # relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css". # so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static'] html_static_path = ['_static']
autodoc_default_options = {
'members': True,
'undoc-members': True,
'special-members': True,
'secret-members': True,
}
autosummary_generate = True

1
docs/index.rst
View File

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