initial documentation (#2)

virtualstaticvoid · web-flow · commit 6d98306bd329 · 2025-11-07T16:58:24.000Z
sphinx configuration, etc.
diff --git a/.editorconfig b/.editorconfig
@@ -11,5 +11,8 @@ trim_trailing_whitespace = true
 [*.py]
 indent_size = 4
 
+[Makefile]
+indent_style = tab
+
 [*.md]
 max_line_length = off
diff --git a/.gitattributes b/.gitattributes
@@ -4,6 +4,8 @@
 # Force the following filetypes to have unix eols, so Windows does not break them
 *.* text eol=lf
 
+*.bat text eol=crlf
+
 # Denote all files that are truly binary and should not be modified.
 *.7z binary
 *.bak binary
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -46,6 +46,13 @@ tasks:
     cmds:
       - uv run pytest --durations 10
 
+  build-docs:
+    desc: Build HTML documentation
+    dir: docs
+    cmds:
+      - uv run sphinx-apidoc -o source/api ../src/tasktronaut
+      - uv run make html
+
   # https://docs.astral.sh/uv/guides/package/#updating-your-version
   bump-version:
     desc: Bump Python package minor version
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -0,0 +1 @@
+build
diff --git a/docs/Makefile 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
@@ -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
+
+%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
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd
diff --git a/docs/source/_static/.keep b/docs/source/_static/.keep
diff --git a/docs/source/_templates/.keep b/docs/source/_templates/.keep
diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst
@@ -0,0 +1,3 @@
+Advanced Use Cases
+==================
+
diff --git a/docs/source/api/modules.rst b/docs/source/api/modules.rst
@@ -0,0 +1,7 @@
+API Documentation
+=================
+
+.. toctree::
+   :maxdepth: 4
+
+   tasktronaut
diff --git a/docs/source/api/tasktronaut.backends.rst b/docs/source/api/tasktronaut.backends.rst
@@ -0,0 +1,21 @@
+tasktronaut.backends package
+============================
+
+Submodules
+----------
+
+tasktronaut.backends.rq module
+------------------------------
+
+.. automodule:: tasktronaut.backends.rq
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: tasktronaut.backends
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/source/api/tasktronaut.rst b/docs/source/api/tasktronaut.rst
@@ -0,0 +1,93 @@
+tasktronaut package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   tasktronaut.backends
+
+Submodules
+----------
+
+tasktronaut.backend module
+--------------------------
+
+.. automodule:: tasktronaut.backend
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.builder module
+--------------------------
+
+.. automodule:: tasktronaut.builder
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.context module
+--------------------------
+
+.. automodule:: tasktronaut.context
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.decorators module
+-----------------------------
+
+.. automodule:: tasktronaut.decorators
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.errors module
+-------------------------
+
+.. automodule:: tasktronaut.errors
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.process module
+--------------------------
+
+.. automodule:: tasktronaut.process
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.steps module
+------------------------
+
+.. automodule:: tasktronaut.steps
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.types module
+------------------------
+
+.. automodule:: tasktronaut.types
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+tasktronaut.utils module
+------------------------
+
+.. automodule:: tasktronaut.utils
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: tasktronaut
+   :members:
+   :show-inheritance:
+   :undoc-members:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -0,0 +1,31 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "tasktronaut"
+author = "Chris Stefano"
+copyright = f"2025, {author}"  # pylint: disable=redefined-builtin
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",  # Auto-generate docs from docstrings
+    "sphinx_autodoc_typehints",  # Include type hints in docs
+    "sphinx_rtd_theme",  # Use Read the Docs theme
+]
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_title = "tasktronaut Documentation"
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -0,0 +1,22 @@
+.. tasktronaut documentation master file, created by
+   sphinx-quickstart on Fri Nov  7 14:55:45 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+``tasktronaut`` Documentation
+=============================
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Contents:
+
+   user_guide
+   advanced
+   api/modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/docs/source/user_guide.rst b/docs/source/user_guide.rst
@@ -0,0 +1,2 @@
+User Guide
+==========
diff --git a/pyproject.toml b/pyproject.toml
@@ -50,6 +50,7 @@ build = [
 ]
 docs = [
   "sphinx>=5.0",
+  "sphinx-autodoc-typehints>=3.0.1",
   "sphinx-rtd-theme>=1.0",
 ]
 
diff --git a/uv.lock b/uv.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+Advanced Use Cases`
	`2`	`+==================`
	`3`	`+`