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

Build documentation based on sphinx-jsonschema #34

Open
kenloen opened this issue Feb 14, 2024 · 0 comments
Open

Build documentation based on sphinx-jsonschema #34

kenloen opened this issue Feb 14, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation question Further information is requested
Milestone

Comments

@kenloen
Copy link
Collaborator

kenloen commented Feb 14, 2024

It could be beneficial to build the documentation using the sphinx-jsonschema and leverage the description in the schema as the main source of documentation and then extend these descriptions with figures and more detailed text.

@kenloen kenloen added documentation Improvements or additions to documentation question Further information is requested labels Feb 19, 2024
@kenloen kenloen added this to windIO Feb 19, 2024
@kenloen kenloen added this to the Version 1.2 milestone Feb 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested
Projects
Status: No status
Development

No branches or pull requests

1 participant