-
Notifications
You must be signed in to change notification settings - Fork 22
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
docs: [0074] include tooling and data attributes in references #450
base: main
Are you sure you want to change the base?
Conversation
Thanks for the pull request, @mariajgrimaldi! This repository is currently maintained by @openedx/hooks-extension-framework. Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.
|
673a9b3
to
e7c926f
Compare
bf8e0ca
to
c0d9328
Compare
Description
This PR includes tooling and data inline docstrings as part of the documentation to reference when creating a new event. This PR also includes the napoleon sphinx extension to make them more readable in RST formats.
Testing instructions
You can see the docs rendered here:
https://docsopenedxorg--450.org.readthedocs.build/projects/openedx-events/en/450/reference/events-tooling.html
https://docsopenedxorg--450.org.readthedocs.build/projects/openedx-events/en/450/reference/events-data.html
Deadline
None
Checklists
Check off if complete or not applicable:
Merge Checklist:
Post Merge:
finished.