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

Documentation for config #35

Open
nguu0123 opened this issue Oct 9, 2024 · 2 comments
Open

Documentation for config #35

nguu0123 opened this issue Oct 9, 2024 · 2 comments

Comments

@nguu0123
Copy link
Collaborator

nguu0123 commented Oct 9, 2024

Currently mkdocs can't extract the field description of the BaseModel that we use for configuration -> Find way to solve this so that user can understand how to configure qoaclient, probes, connector/collector

@nguu0123
Copy link
Collaborator Author

nguu0123 commented Oct 9, 2024

Found this extension griffe-pydantic but only accessible for sponsor

@pawamoy
Copy link

pawamoy commented Oct 11, 2024

@nguu0123 griffe-pydantic will be made available to everyone very soon, keep an eye on it :)

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

No branches or pull requests

2 participants