Files
mail-intake/mkdocs.yml

68 lines
1.7 KiB
YAML

site_name: Aetoskia Mail Intake
site_description: Format-agnostic document reading, parsing, and scraping framework
theme:
name: material
palette:
- scheme: slate
primary: deep purple
accent: cyan
font:
text: Inter
code: JetBrains Mono
features:
- navigation.tabs
- navigation.expand
- navigation.top
- navigation.instant
- content.code.copy
- content.code.annotate
plugins:
- search
- mkdocstrings:
handlers:
python:
paths:
- .
options:
docstring_style: google
show_source: false
show_signature_annotations: true
separate_signature: true
merge_init_into_class: true
inherited_members: true
annotations_path: brief
show_root_heading: true
group_by_category: true
nav:
- Home: mail_intake/index.md
- Core API:
- mail_intake/ingestion/index.md
- mail_intake/ingestion/reader.md
- Domain Models:
- mail_intake/models/index.md
- mail_intake/models/message.md
- mail_intake/models/thread.md
- Provider Adapters:
- mail_intake/adapters/index.md
- mail_intake/adapters/base.md
- mail_intake/adapters/gmail.md
- Authentication & Storage:
- mail_intake/auth/index.md
- mail_intake/auth/base.md
- mail_intake/auth/google.md
- mail_intake/credentials/index.md
- mail_intake/credentials/store.md
- mail_intake/credentials/pickle.md
- mail_intake/credentials/redis.md
- Normalization & Parsing:
- mail_intake/parsers/index.md
- mail_intake/parsers/body.md
- mail_intake/parsers/headers.md
- mail_intake/parsers/subject.md
- Configuration & Errors:
- mail_intake/config.md
- mail_intake/exceptions.md