-
Notifications
You must be signed in to change notification settings - Fork 123
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
Generate plugin documentation from their sources #2549
Conversation
80b0d2c
to
8d0fca6
Compare
f5fba70
to
70c9ea8
Compare
edc4734
to
f564b1d
Compare
70c9ea8
to
09e97dc
Compare
f564b1d
to
025dc74
Compare
09e97dc
to
49af58e
Compare
49b9ddb
to
722af16
Compare
6575508
to
a6bfc52
Compare
49af58e
to
e19d8f0
Compare
f6351a7
to
044dbed
Compare
2ffecd3
to
e3282e0
Compare
a551f2e
to
a2933ec
Compare
a2933ec
to
8d2ef47
Compare
1dc5dc9
to
93eceec
Compare
/packit test -i full |
93eceec
to
b197b2e
Compare
This required a small refactoring of how field properties were stored. Instead of treating them as something owned by CLI options, they have their use outside of CLI area, and must exist in field metadata to be consumable in general. Now we have a template, a script, a section in docs. Fixing the content would be the next step...
b197b2e
to
e5256ca
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Beautiful, elegant, and... just awesome! This will save us a lot of duplicated documentation code. Thanks much for implementing this. Looks great, I just capitalized the heading.
/packit test -i full |
/packit test -i provision |
Glad to hear you like it. Please, check also the second PR, #2574, in a way they are sort of two parts of the same "virtual PR". #2549 adds a template and some basic changes, and #2574 builds on top of them by improving the template, adding more changes, CLI rendering, and multiple plugin changes to make them better play with ReST. I was hoping that we might merge them both, with not that many questions asked, because in some ways, they are also incomplete - the changes made to plugins are significant, but by no means complete. The review tracked in #2657 will result in more changes, resolving many, many loose ends you may easily find in both these pull requests - I just felt it's probably time to stop here and now, when it finally works, and leave the cleanup to per-plugin PRs. |
Ack. Yeah, makes sense. I'll finish that one before leaving for PTO. |
This required a small refactoring of how field properties were stored. Instead of treating them as something owned by CLI options, they have their use outside of CLI area, and must exist in field metadata to be consumable in general.
Now we have a template, a script, a section in docs. Fixing the content would be the next step...
Pull Request Checklist