using doc forge
This commit is contained in:
105
mkdocs.yml
105
mkdocs.yml
@@ -4,63 +4,64 @@ site_description: Format-agnostic document reading, parsing, and scraping framew
|
||||
theme:
|
||||
name: material
|
||||
palette:
|
||||
- scheme: slate
|
||||
primary: deep purple
|
||||
accent: cyan
|
||||
- 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
|
||||
- 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
|
||||
- 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
|
||||
|
||||
- Credentials Store:
|
||||
- Store: mail_intake/credentials/store.md
|
||||
- Pickle: mail_intake/credentials/pickle.md
|
||||
- Redis: mail_intake/credentials/redis.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
|
||||
- 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
|
||||
|
||||
Reference in New Issue
Block a user