docs: nest lib docs under docs/lib with lib-prefixed nav

This commit is contained in:
2026-09-11 05:38:06 +05:30
parent fd73c312d6
commit af8bb5add8
2 changed files with 73 additions and 66 deletions

View File

@@ -1,29 +1,32 @@
home: index.md home: lib/index.md
groups: groups:
Core API: Core API:
- ingestion/index.md - lib/ingestion/index.md
- ingestion/reader.md - lib/ingestion/reader.md
Domain Models: Domain Models:
- models/index.md - lib/models/index.md
- models/message.md - lib/models/message.md
- models/thread.md - lib/models/thread.md
Provider Adapters: Provider Adapters:
- adapters/index.md - lib/adapters/index.md
- adapters/base.md - lib/adapters/base.md
- adapters/gmail.md - lib/adapters/gmail.md
Authentication & Storage: Authentication & Storage:
- auth/index.md - lib/auth/index.md
- auth/base.md - lib/auth/base.md
- auth/google.md - lib/auth/google.md
- credentials/index.md - lib/credentials/index.md
- credentials/store.md - lib/credentials/store.md
- credentials/pickle.md - lib/credentials/pickle.md
- credentials/redis.md - lib/credentials/redis.md
Normalization & Parsing: Normalization & Parsing:
- parsers/index.md - lib/parsers/index.md
- parsers/body.md - lib/parsers/body.md
- parsers/headers.md - lib/parsers/headers.md
- parsers/subject.md - lib/parsers/subject.md
Configuration & Errors: Configuration & Errors:
- config.md - lib/config.md
- exceptions.md - lib/exceptions.md
icon:
logo: material/inbox
repo: fontawesome/brands/github

View File

@@ -21,6 +21,31 @@ theme:
- search.highlight - search.highlight
- search.share - search.share
- search.suggest - search.suggest
icon:
logo: material/inbox
repo: fontawesome/brands/github
markdown_extensions:
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.details
- pymdownx.highlight:
linenums: true
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- footnotes
- pymdownx.caret
- pymdownx.tilde
- pymdownx.mark
extra_css:
- https://unpkg.com/dracula-prism/dist/css/dracula-prism.css
plugins: plugins:
- search - search
- mkdocstrings: - mkdocstrings:
@@ -41,55 +66,34 @@ plugins:
show_category_heading: true show_category_heading: true
show_object_full_path: false show_object_full_path: false
show_symbol_type_heading: true show_symbol_type_heading: true
markdown_extensions:
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.snippets
- admonition
- pymdownx.details
- pymdownx.superfences
- pymdownx.highlight:
linenums: true
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- tables
- footnotes
- pymdownx.caret
- pymdownx.tilde
- pymdownx.mark
site_name: mail_intake site_name: mail_intake
docs_dir: docs/lib docs_dir: docs
nav: nav:
- Home: index.md - Home: lib/index.md
- Core API: - Core API:
- ingestion/index.md - lib/ingestion/index.md
- ingestion/reader.md - lib/ingestion/reader.md
- Domain Models: - Domain Models:
- models/index.md - lib/models/index.md
- models/message.md - lib/models/message.md
- models/thread.md - lib/models/thread.md
- Provider Adapters: - Provider Adapters:
- adapters/index.md - lib/adapters/index.md
- adapters/base.md - lib/adapters/base.md
- adapters/gmail.md - lib/adapters/gmail.md
- Authentication & Storage: - Authentication & Storage:
- auth/index.md - lib/auth/index.md
- auth/base.md - lib/auth/base.md
- auth/google.md - lib/auth/google.md
- credentials/index.md - lib/credentials/index.md
- credentials/store.md - lib/credentials/store.md
- credentials/pickle.md - lib/credentials/pickle.md
- credentials/redis.md - lib/credentials/redis.md
- Normalization & Parsing: - Normalization & Parsing:
- parsers/index.md - lib/parsers/index.md
- parsers/body.md - lib/parsers/body.md
- parsers/headers.md - lib/parsers/headers.md
- parsers/subject.md - lib/parsers/subject.md
- Configuration & Errors: - Configuration & Errors:
- config.md - lib/config.md
- exceptions.md - lib/exceptions.md