docs: add mkdocs configuration and API documentation structure
- docs(mkdocs): add mkdocs.yml with material theme and plugin configuration - docs(mkdocs): configure navigation for core, html, and pdf modules - docs(docs): add documentation root and homepage - docs(docs): add core contracts documentation pages - docs(docs): add html implementation documentation pages - docs(docs): add pdf implementation documentation pages - docs(docs): wire mkdocstrings directives for API reference rendering
This commit is contained in:
1
docs/core/content.md
Normal file
1
docs/core/content.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.core.content
|
||||
1
docs/core/index.md
Normal file
1
docs/core/index.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.core
|
||||
1
docs/core/parser.md
Normal file
1
docs/core/parser.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.core.parser
|
||||
1
docs/core/scraper.md
Normal file
1
docs/core/scraper.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.core.scraper
|
||||
1
docs/html/index.md
Normal file
1
docs/html/index.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.html
|
||||
1
docs/html/parser.md
Normal file
1
docs/html/parser.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.html.parser
|
||||
1
docs/html/scraper.md
Normal file
1
docs/html/scraper.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.html.scraper
|
||||
1
docs/index.md
Normal file
1
docs/index.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread
|
||||
1
docs/pdf/client.md
Normal file
1
docs/pdf/client.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.pdf.client
|
||||
1
docs/pdf/index.md
Normal file
1
docs/pdf/index.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.pdf
|
||||
1
docs/pdf/parser.md
Normal file
1
docs/pdf/parser.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.pdf.parser
|
||||
1
docs/pdf/scraper.md
Normal file
1
docs/pdf/scraper.md
Normal file
@@ -0,0 +1 @@
|
||||
::: omniread.pdf.scraper
|
||||
53
mkdocs.yml
Normal file
53
mkdocs.yml
Normal file
@@ -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
|
||||
Reference in New Issue
Block a user