diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/conf.py | 7 | ||||
| -rw-r--r-- | docs/source/reference/hazwaz.mixins.rst | 7 | ||||
| -rw-r--r-- | docs/source/reference/hazwaz.rst | 3 | ||||
| -rw-r--r-- | docs/source/reference/modules.rst | 5 | ||||
| -rwxr-xr-x | docs/update_reference.sh | 13 | 
5 files changed, 30 insertions, 5 deletions
| diff --git a/docs/source/conf.py b/docs/source/conf.py index d8dade9..7b50891 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -10,9 +10,10 @@  # 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 ----------------------------------------------------- diff --git a/docs/source/reference/hazwaz.mixins.rst b/docs/source/reference/hazwaz.mixins.rst new file mode 100644 index 0000000..057d78d --- /dev/null +++ b/docs/source/reference/hazwaz.mixins.rst @@ -0,0 +1,7 @@ +hazwaz.mixins module +==================== + +.. automodule:: hazwaz.mixins +   :members: +   :undoc-members: +   :show-inheritance: diff --git a/docs/source/reference/hazwaz.rst b/docs/source/reference/hazwaz.rst index 61d829e..32a91d1 100644 --- a/docs/source/reference/hazwaz.rst +++ b/docs/source/reference/hazwaz.rst @@ -10,4 +10,7 @@ Submodules  ----------  .. toctree:: +   :maxdepth: 4 +     hazwaz.command +   hazwaz.mixins diff --git a/docs/source/reference/modules.rst b/docs/source/reference/modules.rst index 536bd19..544d53f 100644 --- a/docs/source/reference/modules.rst +++ b/docs/source/reference/modules.rst @@ -1,6 +1,7 @@ -hazwaz reference -================ +hazwaz +======  .. toctree:: +   :maxdepth: 4     hazwaz diff --git a/docs/update_reference.sh b/docs/update_reference.sh new file mode 100755 index 0000000..784ea2b --- /dev/null +++ b/docs/update_reference.sh @@ -0,0 +1,13 @@ +#!/bin/sh + +# This script generates new autodoc files for the hazwaz reference, overwriting +# all existing files. + +cd $(dirname "$0")/.. + +echo "This will overwrite all existing files in the docs/source/reference/" +echo "continue? (press enter to continue, or ctrl-C to abort)" + +read continue + +sphinx-apidoc -f -e -M -o docs/source/reference/ hazwaz $* | 
