Add MkDocs documentation

Covers: overview, setup, API reference, configuration,
testing, deployment, and known quirks.
This commit is contained in:
Lennie S.
2026-04-09 20:24:49 +00:00
parent 17191fc489
commit 760b56bfd6
8 changed files with 691 additions and 0 deletions

45
mkdocs.yml Normal file
View File

@@ -0,0 +1,45 @@
site_name: email-classifier
site_description: FastAPI service that classifies email using a configurable LLM backend
site_url: https://git.danhenry.dev/daniel/email-classifier
repo_name: daniel/email-classifier
repo_url: https://git.danhenry.dev/daniel/email-classifier
nav:
- Home: index.md
- Setup: setup.md
- API Reference: api.md
- Configuration: configuration.md
- Testing Locally: testing.md
- Deployment: deployment.md
- Known Quirks: quirks.md
theme:
name: material
palette:
- scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: indigo
accent: indigo
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- content.code.copy
markdown_extensions:
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.snippets:
autoindent: true
- pymdownx.superfences
- admonition
- toc:
permalink: true