From 0eaa6ee99a19ae953b4f4ae711d26a2587c15c0a Mon Sep 17 00:00:00 2001 From: Vishesh 'ironeagle' Bangotra Date: Tue, 15 Sep 2026 18:51:21 +0530 Subject: [PATCH] fix: flatten docs/lib layout, remove stale nested docs/lib/omniread - Remove 21 stale files from docs/lib/omniread/ (core, csv, html, pdf, xlsx subdirs + index.md) - Update docs/lib/index.md to remove stale omniread/ child link - Regenerate README.md from root docstring (add 3 missing Xlsx entries: FileSystemXlsxClient, XlsxScraper, XlsxParser) - Regenerate via doc-forge build --mkdocs --module omniread --module-is-source --- README.md | 3 +++ docs/lib/index.md | 1 - docs/lib/omniread/core/content.md | 3 --- docs/lib/omniread/core/index.md | 6 ------ docs/lib/omniread/core/parser.md | 3 --- docs/lib/omniread/core/scraper.md | 3 --- docs/lib/omniread/csv/client.md | 3 --- docs/lib/omniread/csv/index.md | 7 ------- docs/lib/omniread/csv/parser.md | 3 --- docs/lib/omniread/csv/parser_base.md | 3 --- docs/lib/omniread/csv/scraper.md | 3 --- docs/lib/omniread/html/index.md | 5 ----- docs/lib/omniread/html/parser.md | 3 --- docs/lib/omniread/html/scraper.md | 3 --- docs/lib/omniread/index.md | 8 -------- docs/lib/omniread/pdf/client.md | 3 --- docs/lib/omniread/pdf/index.md | 6 ------ docs/lib/omniread/pdf/parser.md | 3 --- docs/lib/omniread/pdf/scraper.md | 3 --- docs/lib/omniread/xlsx/client.md | 3 --- docs/lib/omniread/xlsx/index.md | 7 ------- docs/lib/omniread/xlsx/parser.md | 3 --- docs/lib/omniread/xlsx/parser_base.md | 3 --- docs/lib/omniread/xlsx/scraper.md | 3 --- 24 files changed, 3 insertions(+), 88 deletions(-) delete mode 100644 docs/lib/omniread/core/content.md delete mode 100644 docs/lib/omniread/core/index.md delete mode 100644 docs/lib/omniread/core/parser.md delete mode 100644 docs/lib/omniread/core/scraper.md delete mode 100644 docs/lib/omniread/csv/client.md delete mode 100644 docs/lib/omniread/csv/index.md delete mode 100644 docs/lib/omniread/csv/parser.md delete mode 100644 docs/lib/omniread/csv/parser_base.md delete mode 100644 docs/lib/omniread/csv/scraper.md delete mode 100644 docs/lib/omniread/html/index.md delete mode 100644 docs/lib/omniread/html/parser.md delete mode 100644 docs/lib/omniread/html/scraper.md delete mode 100644 docs/lib/omniread/index.md delete mode 100644 docs/lib/omniread/pdf/client.md delete mode 100644 docs/lib/omniread/pdf/index.md delete mode 100644 docs/lib/omniread/pdf/parser.md delete mode 100644 docs/lib/omniread/pdf/scraper.md delete mode 100644 docs/lib/omniread/xlsx/client.md delete mode 100644 docs/lib/omniread/xlsx/index.md delete mode 100644 docs/lib/omniread/xlsx/parser.md delete mode 100644 docs/lib/omniread/xlsx/parser_base.md delete mode 100644 docs/lib/omniread/xlsx/scraper.md diff --git a/README.md b/README.md index 0a66f72..530daa1 100644 --- a/README.md +++ b/README.md @@ -91,6 +91,9 @@ required. - `FileSystemPDFClient`: Local filesystem PDF access. - `PDFScraper`: PDF-specific content acquisition. - `PDFParser`: Base parser for PDF binary interpretation. +- `FileSystemXlsxClient`: Local filesystem spreadsheet access. +- `XlsxScraper`: XLSX-specific content acquisition. +- `XlsxParser`: Generic string-row parser for xlsx workbooks. --- diff --git a/docs/lib/index.md b/docs/lib/index.md index 6329a04..a5d4ae1 100644 --- a/docs/lib/index.md +++ b/docs/lib/index.md @@ -1,4 +1,3 @@ # omniread ::: omniread -- [Omniread](omniread/) diff --git a/docs/lib/omniread/core/content.md b/docs/lib/omniread/core/content.md deleted file mode 100644 index 85c22e9..0000000 --- a/docs/lib/omniread/core/content.md +++ /dev/null @@ -1,3 +0,0 @@ -# Content - -::: omniread.core.content diff --git a/docs/lib/omniread/core/index.md b/docs/lib/omniread/core/index.md deleted file mode 100644 index 7602f6c..0000000 --- a/docs/lib/omniread/core/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Core - -::: omniread.core -- [Content](content.md) -- [Parser](parser.md) -- [Scraper](scraper.md) diff --git a/docs/lib/omniread/core/parser.md b/docs/lib/omniread/core/parser.md deleted file mode 100644 index db6d680..0000000 --- a/docs/lib/omniread/core/parser.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser - -::: omniread.core.parser diff --git a/docs/lib/omniread/core/scraper.md b/docs/lib/omniread/core/scraper.md deleted file mode 100644 index 17ccde2..0000000 --- a/docs/lib/omniread/core/scraper.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scraper - -::: omniread.core.scraper diff --git a/docs/lib/omniread/csv/client.md b/docs/lib/omniread/csv/client.md deleted file mode 100644 index 192c801..0000000 --- a/docs/lib/omniread/csv/client.md +++ /dev/null @@ -1,3 +0,0 @@ -# Client - -::: omniread.csv.client diff --git a/docs/lib/omniread/csv/index.md b/docs/lib/omniread/csv/index.md deleted file mode 100644 index a9e309f..0000000 --- a/docs/lib/omniread/csv/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Csv - -::: omniread.csv -- [Client](client.md) -- [Parser](parser.md) -- [Parser Base](parser_base.md) -- [Scraper](scraper.md) diff --git a/docs/lib/omniread/csv/parser.md b/docs/lib/omniread/csv/parser.md deleted file mode 100644 index cb84ff6..0000000 --- a/docs/lib/omniread/csv/parser.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser - -::: omniread.csv.parser diff --git a/docs/lib/omniread/csv/parser_base.md b/docs/lib/omniread/csv/parser_base.md deleted file mode 100644 index db71308..0000000 --- a/docs/lib/omniread/csv/parser_base.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser Base - -::: omniread.csv.parser_base diff --git a/docs/lib/omniread/csv/scraper.md b/docs/lib/omniread/csv/scraper.md deleted file mode 100644 index a6cd836..0000000 --- a/docs/lib/omniread/csv/scraper.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scraper - -::: omniread.csv.scraper diff --git a/docs/lib/omniread/html/index.md b/docs/lib/omniread/html/index.md deleted file mode 100644 index b125bc6..0000000 --- a/docs/lib/omniread/html/index.md +++ /dev/null @@ -1,5 +0,0 @@ -# Html - -::: omniread.html -- [Parser](parser.md) -- [Scraper](scraper.md) diff --git a/docs/lib/omniread/html/parser.md b/docs/lib/omniread/html/parser.md deleted file mode 100644 index 03beb98..0000000 --- a/docs/lib/omniread/html/parser.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser - -::: omniread.html.parser diff --git a/docs/lib/omniread/html/scraper.md b/docs/lib/omniread/html/scraper.md deleted file mode 100644 index bd32ee1..0000000 --- a/docs/lib/omniread/html/scraper.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scraper - -::: omniread.html.scraper diff --git a/docs/lib/omniread/index.md b/docs/lib/omniread/index.md deleted file mode 100644 index c2ded5b..0000000 --- a/docs/lib/omniread/index.md +++ /dev/null @@ -1,8 +0,0 @@ -# Omniread - -::: omniread -- [Core](core/) -- [Csv](csv/) -- [Html](html/) -- [Pdf](pdf/) -- [Xlsx](xlsx/) diff --git a/docs/lib/omniread/pdf/client.md b/docs/lib/omniread/pdf/client.md deleted file mode 100644 index 22271f1..0000000 --- a/docs/lib/omniread/pdf/client.md +++ /dev/null @@ -1,3 +0,0 @@ -# Client - -::: omniread.pdf.client diff --git a/docs/lib/omniread/pdf/index.md b/docs/lib/omniread/pdf/index.md deleted file mode 100644 index 4c49a14..0000000 --- a/docs/lib/omniread/pdf/index.md +++ /dev/null @@ -1,6 +0,0 @@ -# Pdf - -::: omniread.pdf -- [Client](client.md) -- [Parser](parser.md) -- [Scraper](scraper.md) diff --git a/docs/lib/omniread/pdf/parser.md b/docs/lib/omniread/pdf/parser.md deleted file mode 100644 index b1125bc..0000000 --- a/docs/lib/omniread/pdf/parser.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser - -::: omniread.pdf.parser diff --git a/docs/lib/omniread/pdf/scraper.md b/docs/lib/omniread/pdf/scraper.md deleted file mode 100644 index a94daec..0000000 --- a/docs/lib/omniread/pdf/scraper.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scraper - -::: omniread.pdf.scraper diff --git a/docs/lib/omniread/xlsx/client.md b/docs/lib/omniread/xlsx/client.md deleted file mode 100644 index 43ad64e..0000000 --- a/docs/lib/omniread/xlsx/client.md +++ /dev/null @@ -1,3 +0,0 @@ -# Client - -::: omniread.xlsx.client diff --git a/docs/lib/omniread/xlsx/index.md b/docs/lib/omniread/xlsx/index.md deleted file mode 100644 index e0795fb..0000000 --- a/docs/lib/omniread/xlsx/index.md +++ /dev/null @@ -1,7 +0,0 @@ -# Xlsx - -::: omniread.xlsx -- [Client](client.md) -- [Parser](parser.md) -- [Parser Base](parser_base.md) -- [Scraper](scraper.md) diff --git a/docs/lib/omniread/xlsx/parser.md b/docs/lib/omniread/xlsx/parser.md deleted file mode 100644 index 7eb915a..0000000 --- a/docs/lib/omniread/xlsx/parser.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser - -::: omniread.xlsx.parser diff --git a/docs/lib/omniread/xlsx/parser_base.md b/docs/lib/omniread/xlsx/parser_base.md deleted file mode 100644 index 5cf91ea..0000000 --- a/docs/lib/omniread/xlsx/parser_base.md +++ /dev/null @@ -1,3 +0,0 @@ -# Parser Base - -::: omniread.xlsx.parser_base diff --git a/docs/lib/omniread/xlsx/scraper.md b/docs/lib/omniread/xlsx/scraper.md deleted file mode 100644 index c374fb7..0000000 --- a/docs/lib/omniread/xlsx/scraper.md +++ /dev/null @@ -1,3 +0,0 @@ -# Scraper - -::: omniread.xlsx.scraper