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:
3
docs/mail_intake/adapters/base.md
Normal file
3
docs/mail_intake/adapters/base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Base
|
||||
|
||||
::: mail_intake.adapters.base
|
||||
3
docs/mail_intake/adapters/gmail.md
Normal file
3
docs/mail_intake/adapters/gmail.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Gmail
|
||||
|
||||
::: mail_intake.adapters.gmail
|
||||
3
docs/mail_intake/adapters/index.md
Normal file
3
docs/mail_intake/adapters/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Adapters
|
||||
|
||||
::: mail_intake.adapters
|
||||
3
docs/mail_intake/auth/base.md
Normal file
3
docs/mail_intake/auth/base.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Base
|
||||
|
||||
::: mail_intake.auth.base
|
||||
3
docs/mail_intake/auth/google.md
Normal file
3
docs/mail_intake/auth/google.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Google
|
||||
|
||||
::: mail_intake.auth.google
|
||||
3
docs/mail_intake/auth/index.md
Normal file
3
docs/mail_intake/auth/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Auth
|
||||
|
||||
::: mail_intake.auth
|
||||
3
docs/mail_intake/config.md
Normal file
3
docs/mail_intake/config.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Config
|
||||
|
||||
::: mail_intake.config
|
||||
3
docs/mail_intake/exceptions.md
Normal file
3
docs/mail_intake/exceptions.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Exceptions
|
||||
|
||||
::: mail_intake.exceptions
|
||||
3
docs/mail_intake/index.md
Normal file
3
docs/mail_intake/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Mail Intake
|
||||
|
||||
::: mail_intake
|
||||
3
docs/mail_intake/ingestion/index.md
Normal file
3
docs/mail_intake/ingestion/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Ingestion
|
||||
|
||||
::: mail_intake.ingestion
|
||||
3
docs/mail_intake/ingestion/reader.md
Normal file
3
docs/mail_intake/ingestion/reader.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Reader
|
||||
|
||||
::: mail_intake.ingestion.reader
|
||||
3
docs/mail_intake/models/index.md
Normal file
3
docs/mail_intake/models/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Models
|
||||
|
||||
::: mail_intake.models
|
||||
3
docs/mail_intake/models/message.md
Normal file
3
docs/mail_intake/models/message.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Message
|
||||
|
||||
::: mail_intake.models.message
|
||||
3
docs/mail_intake/models/thread.md
Normal file
3
docs/mail_intake/models/thread.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Thread
|
||||
|
||||
::: mail_intake.models.thread
|
||||
3
docs/mail_intake/parsers/body.md
Normal file
3
docs/mail_intake/parsers/body.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Body
|
||||
|
||||
::: mail_intake.parsers.body
|
||||
3
docs/mail_intake/parsers/headers.md
Normal file
3
docs/mail_intake/parsers/headers.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Headers
|
||||
|
||||
::: mail_intake.parsers.headers
|
||||
3
docs/mail_intake/parsers/index.md
Normal file
3
docs/mail_intake/parsers/index.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Parsers
|
||||
|
||||
::: mail_intake.parsers
|
||||
3
docs/mail_intake/parsers/subject.md
Normal file
3
docs/mail_intake/parsers/subject.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# Subject
|
||||
|
||||
::: mail_intake.parsers.subject
|
||||
61
mkdocs.yml
Normal file
61
mkdocs.yml
Normal 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
|
||||
Reference in New Issue
Block a user