From af8bb5add87389436750474157297ad5f90e24db Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Fri, 11 Sep 2026 05:38:06 +0530 Subject: [PATCH] docs: nest lib docs under docs/lib with lib-prefixed nav --- docforge.nav.yml | 47 +++++++++++++------------ mkdocs.yml | 92 +++++++++++++++++++++++++----------------------- 2 files changed, 73 insertions(+), 66 deletions(-) diff --git a/docforge.nav.yml b/docforge.nav.yml index 26c6d7c..99d6eda 100644 --- a/docforge.nav.yml +++ b/docforge.nav.yml @@ -1,29 +1,32 @@ -home: index.md +home: lib/index.md groups: Core API: - - ingestion/index.md - - ingestion/reader.md + - lib/ingestion/index.md + - lib/ingestion/reader.md Domain Models: - - models/index.md - - models/message.md - - models/thread.md + - lib/models/index.md + - lib/models/message.md + - lib/models/thread.md Provider Adapters: - - adapters/index.md - - adapters/base.md - - adapters/gmail.md + - lib/adapters/index.md + - lib/adapters/base.md + - lib/adapters/gmail.md Authentication & Storage: - - auth/index.md - - auth/base.md - - auth/google.md - - credentials/index.md - - credentials/store.md - - credentials/pickle.md - - credentials/redis.md + - lib/auth/index.md + - lib/auth/base.md + - lib/auth/google.md + - lib/credentials/index.md + - lib/credentials/store.md + - lib/credentials/pickle.md + - lib/credentials/redis.md Normalization & Parsing: - - parsers/index.md - - parsers/body.md - - parsers/headers.md - - parsers/subject.md + - lib/parsers/index.md + - lib/parsers/body.md + - lib/parsers/headers.md + - lib/parsers/subject.md Configuration & Errors: - - config.md - - exceptions.md + - lib/config.md + - lib/exceptions.md +icon: + logo: material/inbox + repo: fontawesome/brands/github \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 8fa7afa..ca8845a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -21,6 +21,31 @@ theme: - search.highlight - search.share - 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: - search - mkdocstrings: @@ -41,55 +66,34 @@ plugins: show_category_heading: true show_object_full_path: false 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 -docs_dir: docs/lib +docs_dir: docs nav: -- Home: index.md +- Home: lib/index.md - Core API: - - ingestion/index.md - - ingestion/reader.md + - lib/ingestion/index.md + - lib/ingestion/reader.md - Domain Models: - - models/index.md - - models/message.md - - models/thread.md + - lib/models/index.md + - lib/models/message.md + - lib/models/thread.md - Provider Adapters: - - adapters/index.md - - adapters/base.md - - adapters/gmail.md + - lib/adapters/index.md + - lib/adapters/base.md + - lib/adapters/gmail.md - Authentication & Storage: - - auth/index.md - - auth/base.md - - auth/google.md - - credentials/index.md - - credentials/store.md - - credentials/pickle.md - - credentials/redis.md + - lib/auth/index.md + - lib/auth/base.md + - lib/auth/google.md + - lib/credentials/index.md + - lib/credentials/store.md + - lib/credentials/pickle.md + - lib/credentials/redis.md - Normalization & Parsing: - - parsers/index.md - - parsers/body.md - - parsers/headers.md - - parsers/subject.md + - lib/parsers/index.md + - lib/parsers/body.md + - lib/parsers/headers.md + - lib/parsers/subject.md - Configuration & Errors: - - config.md - - exceptions.md + - lib/config.md + - lib/exceptions.md