diff --git a/docs/core/content.md b/docs/core/content.md new file mode 100644 index 0000000..1ab7be9 --- /dev/null +++ b/docs/core/content.md @@ -0,0 +1 @@ +::: omniread.core.content diff --git a/docs/core/index.md b/docs/core/index.md new file mode 100644 index 0000000..cf537df --- /dev/null +++ b/docs/core/index.md @@ -0,0 +1 @@ +::: omniread.core diff --git a/docs/core/parser.md b/docs/core/parser.md new file mode 100644 index 0000000..403dae0 --- /dev/null +++ b/docs/core/parser.md @@ -0,0 +1 @@ +::: omniread.core.parser diff --git a/docs/core/scraper.md b/docs/core/scraper.md new file mode 100644 index 0000000..4fee994 --- /dev/null +++ b/docs/core/scraper.md @@ -0,0 +1 @@ +::: omniread.core.scraper diff --git a/docs/html/index.md b/docs/html/index.md new file mode 100644 index 0000000..79491c2 --- /dev/null +++ b/docs/html/index.md @@ -0,0 +1 @@ +::: omniread.html diff --git a/docs/html/parser.md b/docs/html/parser.md new file mode 100644 index 0000000..a000adf --- /dev/null +++ b/docs/html/parser.md @@ -0,0 +1 @@ +::: omniread.html.parser diff --git a/docs/html/scraper.md b/docs/html/scraper.md new file mode 100644 index 0000000..f82248e --- /dev/null +++ b/docs/html/scraper.md @@ -0,0 +1 @@ +::: omniread.html.scraper diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..77e9bbb --- /dev/null +++ b/docs/index.md @@ -0,0 +1 @@ +::: omniread diff --git a/docs/pdf/client.md b/docs/pdf/client.md new file mode 100644 index 0000000..347ffcc --- /dev/null +++ b/docs/pdf/client.md @@ -0,0 +1 @@ +::: omniread.pdf.client diff --git a/docs/pdf/index.md b/docs/pdf/index.md new file mode 100644 index 0000000..6948b1d --- /dev/null +++ b/docs/pdf/index.md @@ -0,0 +1 @@ +::: omniread.pdf diff --git a/docs/pdf/parser.md b/docs/pdf/parser.md new file mode 100644 index 0000000..f49a28b --- /dev/null +++ b/docs/pdf/parser.md @@ -0,0 +1 @@ +::: omniread.pdf.parser diff --git a/docs/pdf/scraper.md b/docs/pdf/scraper.md new file mode 100644 index 0000000..9788cff --- /dev/null +++ b/docs/pdf/scraper.md @@ -0,0 +1 @@ +::: omniread.pdf.scraper diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..2a736d4 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,53 @@ +site_name: Aetoskia OmniRead +site_description: Format-agnostic document reading, parsing, and scraping framework + +theme: + name: material + palette: + - 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 + +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 + +nav: + - Home: index.md + + - Core (Contracts): + - Content Models: core/content.md + - Parsers: core/parser.md + - Scrapers: core/scraper.md + + - HTML Implementation: + - HTML Parser: html/parser.md + - HTML Scraper: html/scraper.md + + - PDF Implementation: + - PDF Client: pdf/client.md + - PDF Parser: pdf/parser.md + - PDF Scraper: pdf/scraper.md