Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🚧 directive to load/validate yaml examples #44

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

stevenbal
Copy link
Contributor

@stevenbal stevenbal commented Jan 3, 2025

example usage in library: maykinmedia/mozilla-django-oidc-db#133
example usage in project:

TODO:

  • validate that all optional fields are used?

libraries should also make use of this directive themselves to ensure the data is validated in the docs build

@stevenbal stevenbal marked this pull request as draft January 3, 2025 16:32
@stevenbal stevenbal force-pushed the feature/embed-model-examples branch from f380821 to 3971a0f Compare January 3, 2025 16:37
@stevenbal
Copy link
Contributor Author

@swrichards I tried out your suggestion from #35 (comment) in this PR and it might indeed be a more workable solution than generating the YAML. I've used mozilla-django-oidc-db as an example: https://github.com/maykinmedia/mozilla-django-oidc-db/pull/133/files. Like you suggested we can use autodoc pydantic to show additional information for the fields

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant