Vishesh 'ironeagle' Bangotra
a3c063b569
- Add comprehensive module and function docstrings to crud_app and model_app templates - Document OpenAPI-first guarantees, non-goals, and usage patterns in templates - Add template-level __init__.py files with CLI and client usage examples - Update mkdocs.yml to include CRUD and model-based CRUD template documentation - Ensure template documentation follows strict package-bound mkdocstrings rules
58 lines
1.4 KiB
YAML
58 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: openapi_first/templates/health_app/index.md
|
|
- CRUD App: openapi_first/templates/crud_app/index.md
|
|
- Model App: openapi_first/templates/model_app/index.md
|
|
|
|
- Errors:
|
|
- Error Hierarchy: openapi_first/errors.md
|