docs(mail_intake): add MkDocs navigation and API reference document structure

- docs(mkdocs.yml): define navigation structure for mail_intake modules
- docs(mkdocs.yml): configure mkdocstrings for Python API rendering
- docs(docs): add documentation root and mail_intake index page
- docs(docs): add adapters documentation pages with mkdocstrings directives
- docs(docs): add auth documentation pages with mkdocstrings directives
- docs(docs): add ingestion documentation pages with mkdocstrings directives
- docs(docs): add models documentation pages with mkdocstrings directives
- docs(docs): add parsers documentation pages with mkdocstrings directives
- docs(docs): add config and exceptions documentation pages
This commit is contained in:
2026-01-09 17:41:10 +05:30
parent f22af90e98
commit b14ffe9e44
19 changed files with 115 additions and 0 deletions

61
mkdocs.yml Normal file
View File

@@ -0,0 +1,61 @@
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
- Adapters:
- Base Adapter: mail_intake/adapters/base.md
- Gmail Adapter: mail_intake/adapters/gmail.md
- Auth:
- Base Auth: mail_intake/auth/base.md
- Google Auth: mail_intake/auth/google.md
- Mail Reader: mail_intake/ingestion/reader.md
- Models:
- Message: mail_intake/models/message.md
- Thread: mail_intake/models/thread.md
- Parsers:
- Body: mail_intake/parsers/body.md
- Headers: mail_intake/parsers/headers.md
- Subject: mail_intake/parsers/subject.md
- Config: mail_intake/config.md
- Exceptions: mail_intake/exceptions.md