Add Sphinx documentation, docs Makefile, and documentation URL

This commit is contained in:
Chris Proctor
2026-06-22 22:27:43 -04:00
parent ffed9f2d01
commit a7543b7b1b
12 changed files with 1026 additions and 5 deletions

46
docs/conf.py Normal file
View File

@@ -0,0 +1,46 @@
# Configuration file for the Sphinx documentation builder.
#
# For a full list of options see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
import os
import sys
sys.path.insert(0, os.path.abspath('..'))
# -- Project information -----------------------------------------------------
project = 'easybits'
copyright = '2025, Chris Proctor'
author = 'Chris Proctor'
# The full version, including alpha/beta/rc tags
release = '0.1.4'
# -- General configuration ---------------------------------------------------
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.napoleon",
"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.
exclude_patterns = []
# -- Options for HTML output -------------------------------------------------
html_theme = 'furo'
html_static_path = ['_static']
# -- Additional configuration -------------------------------------------------
autodoc_member_order = 'bysource'
autodoc_typehints = 'none'