-
Notifications
You must be signed in to change notification settings - Fork 12
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
feat: Add a config for openedx-events annotations #98
Conversation
d4cf0e7
to
1718a0c
Compare
3185ec4
to
7bd4dca
Compare
7bd4dca
to
541f1f7
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.
My review shouldn't be considered authoritative as I'm not a maintainer and I'm not familiar with this repo, but -- I did review the fields/annotations for completeness and consistency.
@mariajgrimaldi thanks, the docs said that first argument was supposed to be a separator so I thought it would... do that. :) All set now. |
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.
@timmc-edx: this implementation is similar to the featuretoggles one
class FeatureToggles(SphinxDirective): |
I've attempted to ping the owning team within 2U, but haven't heard back yet. I think if another week goes by without hearing from them, we should just merge this. |
@bmtcril I think we're good to merge this. |
Description: Adding code and config to find and document annotations used in the openedx-events repository. When run in openedx-events (see openedx/openedx-events#318) the generated documentation looks like this: