aetos/openapi-first
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs(templates): document CRUD and model CRUD apps and expose them in mkdocs

Browse Source 
- 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
This commit is contained in:
Vishesh 'ironeagle' Bangotra
2026-01-11 21:42:30 +05:30
parent 72b5be6976
commit a3c063b569
23 changed files with 740 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
mkdocs.yml
View File

@@ -49,10 +49,9 @@ nav:
- 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
- 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