diff options
| -rw-r--r-- | docs/.gitignore | 1 | ||||
| -rw-r--r-- | docs/Makefile | 20 | ||||
| -rw-r--r-- | docs/make.bat | 35 | ||||
| -rw-r--r-- | docs/source/conf.py | 59 | ||||
| -rw-r--r-- | docs/source/index.rst | 25 | ||||
| -rw-r--r-- | docs/source/reference/hazwaz.command.rst | 7 | ||||
| -rw-r--r-- | docs/source/reference/hazwaz.rst | 13 | ||||
| -rw-r--r-- | docs/source/reference/modules.rst | 6 | ||||
| -rw-r--r-- | hazwaz/command.py | 2 |
9 files changed, 167 insertions, 1 deletions
diff --git a/docs/.gitignore b/docs/.gitignore new file mode 100644 index 0000000..378eac2 --- /dev/null +++ b/docs/.gitignore @@ -0,0 +1 @@ +build diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..6fcf05b --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+ echo.
+ echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+ echo.installed, then set the SPHINXBUILD environment variable to point
+ echo.to the full path of the 'sphinx-build' executable. Alternatively you
+ echo.may add the Sphinx directory to PATH.
+ echo.
+ echo.If you don't have Sphinx installed, grab it from
+ echo.https://www.sphinx-doc.org/
+ exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..d8dade9 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,59 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# 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('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'hazwaz' +copyright = '2022, Elena Grandi' +author = 'Elena “of Valhalla” Grandi' + +# The full version, including alpha/beta/rc tags +release = '0.0.1' +# The major project version +version = '0.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.viewcode', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +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'] diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..2b5c1f0 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,25 @@ +.. hazwaz documentation master file, created by + sphinx-quickstart on Tue Feb 22 20:02:16 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +.. include:: ../../README.rst + +Documentation +------------- + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + reference/modules + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/source/reference/hazwaz.command.rst b/docs/source/reference/hazwaz.command.rst new file mode 100644 index 0000000..1f5d87d --- /dev/null +++ b/docs/source/reference/hazwaz.command.rst @@ -0,0 +1,7 @@ +hazwaz.command module +===================== + +.. automodule:: hazwaz.command + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/reference/hazwaz.rst b/docs/source/reference/hazwaz.rst new file mode 100644 index 0000000..61d829e --- /dev/null +++ b/docs/source/reference/hazwaz.rst @@ -0,0 +1,13 @@ +hazwaz package +============== + +.. automodule:: hazwaz + :members: + :undoc-members: + :show-inheritance: + +Submodules +---------- + +.. toctree:: + hazwaz.command diff --git a/docs/source/reference/modules.rst b/docs/source/reference/modules.rst new file mode 100644 index 0000000..536bd19 --- /dev/null +++ b/docs/source/reference/modules.rst @@ -0,0 +1,6 @@ +hazwaz reference +================ + +.. toctree:: + + hazwaz diff --git a/hazwaz/command.py b/hazwaz/command.py index eb19eaf..91a2b68 100644 --- a/hazwaz/command.py +++ b/hazwaz/command.py @@ -90,7 +90,7 @@ class Command: A subcommand to a MainCommand. Every subcommand of your script will be a subclass of this, added to - the :py:attribute:`subcommands` of the MainCommand. + the :py:attr:`MainCommand.subcommands`. """ name = None |