From b14ffe9e44c13c5a3c570b5fc2ab2f4a870ab0f8 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Fri, 9 Jan 2026 17:41:10 +0530 Subject: [PATCH] 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 --- docs/mail_intake/adapters/base.md | 3 ++ docs/mail_intake/adapters/gmail.md | 3 ++ docs/mail_intake/adapters/index.md | 3 ++ docs/mail_intake/auth/base.md | 3 ++ docs/mail_intake/auth/google.md | 3 ++ docs/mail_intake/auth/index.md | 3 ++ docs/mail_intake/config.md | 3 ++ docs/mail_intake/exceptions.md | 3 ++ docs/mail_intake/index.md | 3 ++ docs/mail_intake/ingestion/index.md | 3 ++ docs/mail_intake/ingestion/reader.md | 3 ++ docs/mail_intake/models/index.md | 3 ++ docs/mail_intake/models/message.md | 3 ++ docs/mail_intake/models/thread.md | 3 ++ docs/mail_intake/parsers/body.md | 3 ++ docs/mail_intake/parsers/headers.md | 3 ++ docs/mail_intake/parsers/index.md | 3 ++ docs/mail_intake/parsers/subject.md | 3 ++ mkdocs.yml | 61 ++++++++++++++++++++++++++++ 19 files changed, 115 insertions(+) create mode 100644 docs/mail_intake/adapters/base.md create mode 100644 docs/mail_intake/adapters/gmail.md create mode 100644 docs/mail_intake/adapters/index.md create mode 100644 docs/mail_intake/auth/base.md create mode 100644 docs/mail_intake/auth/google.md create mode 100644 docs/mail_intake/auth/index.md create mode 100644 docs/mail_intake/config.md create mode 100644 docs/mail_intake/exceptions.md create mode 100644 docs/mail_intake/index.md create mode 100644 docs/mail_intake/ingestion/index.md create mode 100644 docs/mail_intake/ingestion/reader.md create mode 100644 docs/mail_intake/models/index.md create mode 100644 docs/mail_intake/models/message.md create mode 100644 docs/mail_intake/models/thread.md create mode 100644 docs/mail_intake/parsers/body.md create mode 100644 docs/mail_intake/parsers/headers.md create mode 100644 docs/mail_intake/parsers/index.md create mode 100644 docs/mail_intake/parsers/subject.md create mode 100644 mkdocs.yml diff --git a/docs/mail_intake/adapters/base.md b/docs/mail_intake/adapters/base.md new file mode 100644 index 0000000..309649c --- /dev/null +++ b/docs/mail_intake/adapters/base.md @@ -0,0 +1,3 @@ +# Base + +::: mail_intake.adapters.base diff --git a/docs/mail_intake/adapters/gmail.md b/docs/mail_intake/adapters/gmail.md new file mode 100644 index 0000000..13818cc --- /dev/null +++ b/docs/mail_intake/adapters/gmail.md @@ -0,0 +1,3 @@ +# Gmail + +::: mail_intake.adapters.gmail diff --git a/docs/mail_intake/adapters/index.md b/docs/mail_intake/adapters/index.md new file mode 100644 index 0000000..7342162 --- /dev/null +++ b/docs/mail_intake/adapters/index.md @@ -0,0 +1,3 @@ +# Adapters + +::: mail_intake.adapters diff --git a/docs/mail_intake/auth/base.md b/docs/mail_intake/auth/base.md new file mode 100644 index 0000000..a1da95e --- /dev/null +++ b/docs/mail_intake/auth/base.md @@ -0,0 +1,3 @@ +# Base + +::: mail_intake.auth.base diff --git a/docs/mail_intake/auth/google.md b/docs/mail_intake/auth/google.md new file mode 100644 index 0000000..93e3086 --- /dev/null +++ b/docs/mail_intake/auth/google.md @@ -0,0 +1,3 @@ +# Google + +::: mail_intake.auth.google diff --git a/docs/mail_intake/auth/index.md b/docs/mail_intake/auth/index.md new file mode 100644 index 0000000..07da8c8 --- /dev/null +++ b/docs/mail_intake/auth/index.md @@ -0,0 +1,3 @@ +# Auth + +::: mail_intake.auth diff --git a/docs/mail_intake/config.md b/docs/mail_intake/config.md new file mode 100644 index 0000000..355fbef --- /dev/null +++ b/docs/mail_intake/config.md @@ -0,0 +1,3 @@ +# Config + +::: mail_intake.config diff --git a/docs/mail_intake/exceptions.md b/docs/mail_intake/exceptions.md new file mode 100644 index 0000000..6ac1bf2 --- /dev/null +++ b/docs/mail_intake/exceptions.md @@ -0,0 +1,3 @@ +# Exceptions + +::: mail_intake.exceptions diff --git a/docs/mail_intake/index.md b/docs/mail_intake/index.md new file mode 100644 index 0000000..dae6579 --- /dev/null +++ b/docs/mail_intake/index.md @@ -0,0 +1,3 @@ +# Mail Intake + +::: mail_intake diff --git a/docs/mail_intake/ingestion/index.md b/docs/mail_intake/ingestion/index.md new file mode 100644 index 0000000..7c15d77 --- /dev/null +++ b/docs/mail_intake/ingestion/index.md @@ -0,0 +1,3 @@ +# Ingestion + +::: mail_intake.ingestion diff --git a/docs/mail_intake/ingestion/reader.md b/docs/mail_intake/ingestion/reader.md new file mode 100644 index 0000000..690d9d9 --- /dev/null +++ b/docs/mail_intake/ingestion/reader.md @@ -0,0 +1,3 @@ +# Reader + +::: mail_intake.ingestion.reader diff --git a/docs/mail_intake/models/index.md b/docs/mail_intake/models/index.md new file mode 100644 index 0000000..9e85680 --- /dev/null +++ b/docs/mail_intake/models/index.md @@ -0,0 +1,3 @@ +# Models + +::: mail_intake.models diff --git a/docs/mail_intake/models/message.md b/docs/mail_intake/models/message.md new file mode 100644 index 0000000..b460397 --- /dev/null +++ b/docs/mail_intake/models/message.md @@ -0,0 +1,3 @@ +# Message + +::: mail_intake.models.message diff --git a/docs/mail_intake/models/thread.md b/docs/mail_intake/models/thread.md new file mode 100644 index 0000000..74d3cc2 --- /dev/null +++ b/docs/mail_intake/models/thread.md @@ -0,0 +1,3 @@ +# Thread + +::: mail_intake.models.thread diff --git a/docs/mail_intake/parsers/body.md b/docs/mail_intake/parsers/body.md new file mode 100644 index 0000000..2cf14af --- /dev/null +++ b/docs/mail_intake/parsers/body.md @@ -0,0 +1,3 @@ +# Body + +::: mail_intake.parsers.body diff --git a/docs/mail_intake/parsers/headers.md b/docs/mail_intake/parsers/headers.md new file mode 100644 index 0000000..8192602 --- /dev/null +++ b/docs/mail_intake/parsers/headers.md @@ -0,0 +1,3 @@ +# Headers + +::: mail_intake.parsers.headers diff --git a/docs/mail_intake/parsers/index.md b/docs/mail_intake/parsers/index.md new file mode 100644 index 0000000..9f982a9 --- /dev/null +++ b/docs/mail_intake/parsers/index.md @@ -0,0 +1,3 @@ +# Parsers + +::: mail_intake.parsers diff --git a/docs/mail_intake/parsers/subject.md b/docs/mail_intake/parsers/subject.md new file mode 100644 index 0000000..50bdd01 --- /dev/null +++ b/docs/mail_intake/parsers/subject.md @@ -0,0 +1,3 @@ +# Subject + +::: mail_intake.parsers.subject diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..8944ac8 --- /dev/null +++ b/mkdocs.yml @@ -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