added basic documentation with pyscaffold and tox. A lot of it is probably wrong.

This commit is contained in:
Josiah Baldwin
2024-11-05 22:21:35 -08:00
parent 8dab88bfea
commit 69afbfeba7
34 changed files with 2053 additions and 725 deletions

27
.readthedocs.yml Normal file
View File

@@ -0,0 +1,27 @@
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required
version: 2
# Build documentation in the docs/ directory with Sphinx
sphinx:
configuration: docs/conf.py
# Build documentation with MkDocs
#mkdocs:
# configuration: mkdocs.yml
# Optionally build your docs in additional formats such as PDF
formats:
- pdf
build:
os: ubuntu-22.04
tools:
python: "3.11"
python:
install:
- requirements: docs/requirements.txt
- {path: ., method: pip}