From b828dc23b9589e34b01434b3bdff346d9f2ef427 Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Sat, 21 Feb 2026 22:12:16 +0530 Subject: [PATCH] module as source doc fixes --- docforge.nav.yml | 24 +++++++++++------------ docs/{omniread => }/core/content.md | 0 docs/{omniread => }/core/index.md | 0 docs/{omniread => }/core/parser.md | 0 docs/{omniread => }/core/scraper.md | 0 docs/{omniread => }/html/index.md | 0 docs/{omniread => }/html/parser.md | 0 docs/{omniread => }/html/scraper.md | 0 docs/{omniread => }/index.md | 2 +- docs/{omniread => }/pdf/client.md | 0 docs/{omniread => }/pdf/index.md | 0 docs/{omniread => }/pdf/parser.md | 0 docs/{omniread => }/pdf/scraper.md | 0 mkdocs.yml | 30 +++++++++++++---------------- 14 files changed, 26 insertions(+), 30 deletions(-) rename docs/{omniread => }/core/content.md (100%) rename docs/{omniread => }/core/index.md (100%) rename docs/{omniread => }/core/parser.md (100%) rename docs/{omniread => }/core/scraper.md (100%) rename docs/{omniread => }/html/index.md (100%) rename docs/{omniread => }/html/parser.md (100%) rename docs/{omniread => }/html/scraper.md (100%) rename docs/{omniread => }/index.md (56%) rename docs/{omniread => }/pdf/client.md (100%) rename docs/{omniread => }/pdf/index.md (100%) rename docs/{omniread => }/pdf/parser.md (100%) rename docs/{omniread => }/pdf/scraper.md (100%) diff --git a/docforge.nav.yml b/docforge.nav.yml index 3fe52f3..20349e8 100644 --- a/docforge.nav.yml +++ b/docforge.nav.yml @@ -1,16 +1,16 @@ -home: omniread/index.md +home: index.md groups: Core API: - - omniread/core/index.md - - omniread/core/content.md - - omniread/core/parser.md - - omniread/core/scraper.md + - core/index.md + - core/content.md + - core/parser.md + - core/scraper.md HTML Handling: - - omniread/html/index.md - - omniread/html/parser.md - - omniread/html/scraper.md + - html/index.md + - html/parser.md + - html/scraper.md PDF Handling: - - omniread/pdf/index.md - - omniread/pdf/client.md - - omniread/pdf/parser.md - - omniread/pdf/scraper.md + - pdf/index.md + - pdf/client.md + - pdf/parser.md + - pdf/scraper.md diff --git a/docs/omniread/core/content.md b/docs/core/content.md similarity index 100% rename from docs/omniread/core/content.md rename to docs/core/content.md diff --git a/docs/omniread/core/index.md b/docs/core/index.md similarity index 100% rename from docs/omniread/core/index.md rename to docs/core/index.md diff --git a/docs/omniread/core/parser.md b/docs/core/parser.md similarity index 100% rename from docs/omniread/core/parser.md rename to docs/core/parser.md diff --git a/docs/omniread/core/scraper.md b/docs/core/scraper.md similarity index 100% rename from docs/omniread/core/scraper.md rename to docs/core/scraper.md diff --git a/docs/omniread/html/index.md b/docs/html/index.md similarity index 100% rename from docs/omniread/html/index.md rename to docs/html/index.md diff --git a/docs/omniread/html/parser.md b/docs/html/parser.md similarity index 100% rename from docs/omniread/html/parser.md rename to docs/html/parser.md diff --git a/docs/omniread/html/scraper.md b/docs/html/scraper.md similarity index 100% rename from docs/omniread/html/scraper.md rename to docs/html/scraper.md diff --git a/docs/omniread/index.md b/docs/index.md similarity index 56% rename from docs/omniread/index.md rename to docs/index.md index 0bb27d4..a5d4ae1 100644 --- a/docs/omniread/index.md +++ b/docs/index.md @@ -1,3 +1,3 @@ -# Omniread +# omniread ::: omniread diff --git a/docs/omniread/pdf/client.md b/docs/pdf/client.md similarity index 100% rename from docs/omniread/pdf/client.md rename to docs/pdf/client.md diff --git a/docs/omniread/pdf/index.md b/docs/pdf/index.md similarity index 100% rename from docs/omniread/pdf/index.md rename to docs/pdf/index.md diff --git a/docs/omniread/pdf/parser.md b/docs/pdf/parser.md similarity index 100% rename from docs/omniread/pdf/parser.md rename to docs/pdf/parser.md diff --git a/docs/omniread/pdf/scraper.md b/docs/pdf/scraper.md similarity index 100% rename from docs/omniread/pdf/scraper.md rename to docs/pdf/scraper.md diff --git a/mkdocs.yml b/mkdocs.yml index 1cf8fee..babd582 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,3 @@ -site_name: Aetoskia OmniRead -site_description: Format-agnostic document reading, parsing, and scraping framework - theme: name: material palette: @@ -17,7 +14,6 @@ theme: - navigation.instant - content.code.copy - content.code.annotate - plugins: - search - mkdocstrings: @@ -35,20 +31,20 @@ plugins: annotations_path: brief show_root_heading: true group_by_category: true - +site_name: omniread nav: -- Home: omniread/index.md +- Home: index.md - Core API: - - omniread/core/index.md - - omniread/core/content.md - - omniread/core/parser.md - - omniread/core/scraper.md + - core/index.md + - core/content.md + - core/parser.md + - core/scraper.md - HTML Handling: - - omniread/html/index.md - - omniread/html/parser.md - - omniread/html/scraper.md + - html/index.md + - html/parser.md + - html/scraper.md - PDF Handling: - - omniread/pdf/index.md - - omniread/pdf/client.md - - omniread/pdf/parser.md - - omniread/pdf/scraper.md + - pdf/index.md + - pdf/client.md + - pdf/parser.md + - pdf/scraper.md