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.

Sign up for GitHub

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

Jump to bottom

Generate YAML examples for setup_configuration ConfigurationModels #45

Open
stevenbal opened this issue Jan 10, 2025 · 0 comments · May be fixed by #35
Open

Generate YAML examples for setup_configuration ConfigurationModels #45

stevenbal opened this issue Jan 10, 2025 · 0 comments · May be fixed by #35
Assignees
@stevenbal
Labels
enhancement New feature or request owner: dimpact

Comments

@stevenbal
Copy link
Contributor

stevenbal commented Jan 10, 2025 •
edited
Loading

The library should provide a sphinx directive that outputs a YAML example of the targeted ConfigurationStep's config model

Example: https://mozilla-django-oidc-db--134.org.readthedocs.build/en/134/setup_configuration.html#setup-configuration-settings
@stevenbal stevenbal added the enhancement New feature or request label Jan 10, 2025
@stevenbal stevenbal self-assigned this Jan 10, 2025
@stevenbal stevenbal moved this to In Progress in Data en API fundament Jan 10, 2025
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
➕ [#45] Add ruamel.yaml to dependencies
aaa9ca7 
this library will be used to generate YAML examples for documentation
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
1df1eb1 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
67bd903
@stevenbal stevenbal linked a pull request Jan 10, 2025 that will close this issue
Draft
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
7d132f3 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
82d545f
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
➕ [#45] Add ruamel.yaml and docutils to dependencies
5c23611 
this library will be used to generate YAML examples for documentation
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
92a40cc 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
dd157de
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
ab49bef 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
bf5984b
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
159653a 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
ac7b512
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
743c540 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
4c00e7a
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
a2840e4
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Fix polymorphic examples for non-objects
f842092
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Fix polymorphic examples for non-objects
7615ebb
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Fix polymorphic examples for non-objects
5daf9ff
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Slightly refactor model directive
32ff396
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✨ [#45] Sphinx directive to generate YAML examples for config models
96996b1 
it accepts a path to a ConfigurationStep and will display a commented YAML example for the config model associated with that step
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
✅ [#45] Tests for YAML example sphinx directive
682960d
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Fix polymorphic examples for non-objects
4f9109f
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
♻️ [#45] Slightly refactor model directive
5ea4f0b
stevenbal added a commit that referenced this issue Jan 10, 2025
@stevenbal
🔧 [#45] Remove unnecessary settings in docs config
8a5a703
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
🚚 [#45] rename directive to setup-config-example
571e23a
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
👌 [#45] Process PR feedback
8e1bea6
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
👌 [#45] Process PR feedback
9dc408f
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
📝 [#45] Add documentation for YAML example directive
5c8553e
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
📝 [#45] Add documentation for YAML example directive
23be26d
stevenbal added a commit that referenced this issue Jan 16, 2025
@stevenbal
✨ [#45] Generate correct example for literal annotations
dcc9873
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevenbal stevenbal

Labels
enhancement New feature or request owner: dimpact
Projects
Data en API fundament
Status: In Progress
Milestone
No milestone
2 participants
@joeribekker @stevenbal