Vishesh 'ironeagle' Bangotra
72b5be6976
- Restrict mkdocstrings generation to real Python packages (require __init__.py) - Add explicit documentation section for CLI scaffolding and templates - Generalize CLI to support multiple templates with dynamic discovery - Package templates correctly for importlib.resources access - Add fully documented health_app template (app entry point and handlers) - Fix setuptools package-data configuration for bundled templates These changes make documentation import-safe, clarify package boundaries, and provide a deterministic, OpenAPI-first scaffolding workflow via CLI.
59 lines
1.4 KiB
YAML
59 lines
1.4 KiB
YAML
site_name: Aetoskia Mail Intake
|
|
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: openapi_first/index.md
|
|
|
|
- Core:
|
|
- OpenAPI-First App: openapi_first/app.md
|
|
- Route Binder: openapi_first/binder.md
|
|
- Spec Loaders: openapi_first/loader.md
|
|
- Client: openapi_first/client.md
|
|
|
|
- CLI:
|
|
- Home: openapi_first/cli.md
|
|
|
|
- Templates:
|
|
- Home: openapi_first/templates/index.md
|
|
- Health App:
|
|
- Home: openapi_first/templates/health_app/index.md
|
|
- App: openapi_first/templates/health_app/main.md
|
|
- Routes: openapi_first/templates/health_app/routes.md
|
|
|
|
- Errors:
|
|
- Error Hierarchy: openapi_first/errors.md
|