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

feat: Add autodoc for event annotations #318

Merged
merged 4 commits into from
Mar 14, 2024

Conversation

bmtcril
Copy link
Contributor

@bmtcril bmtcril commented Feb 20, 2024

Description: Adds automatic documentation of annotated events for discoverability and ease of configuration. This is in draft until dependencies merge and release, so I can update requirements to the official version, I'll be adding event_key_fields for the rest of the events while that is in review. Generated docs look like this:

Screenshot 2024-02-20 at 1 11 21 PM

Dependencies: openedx/code-annotations#98

Installation instructions: List any non-trivial installation
instructions.

Testing instructions:

  1. Requirements are updated to use the branch of code-annotations necessary to run this so pulling this branch and running make requirements should suffice
  2. Run make docs
  3. Sphinx should run and pop open the generated docs in your browser. Navigate to reference -> events to see the content.

Reviewers:

  • tag reviewer
  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

@bmtcril
Copy link
Contributor Author

bmtcril commented Feb 20, 2024

Coverage issue is just because there is more code (comments), there is nothing to test in any of this.

Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This has my soft-approval. Thanks for doing this! We'll merge this once openedx/code-annotations#98 is merged so we can the code-annotations release instead. Is that okay?

Copy link
Contributor

@timmc-edx timmc-edx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good pending the code-annotations release!

@bmtcril bmtcril force-pushed the bmtcril/autodoc-event-annotations branch from e85be8b to 4086c95 Compare February 20, 2024 20:36
Not all events are compatible with the bus, and some that are have never been configured for it that I
could find. This is everything I could locate in the
org.
It looks like the pii check config was removed at some point, but checks that pointed to it were left in place. This just finishes the removal.
@bmtcril bmtcril force-pushed the bmtcril/autodoc-event-annotations branch from 4086c95 to 8ff3541 Compare March 14, 2024 12:32
@bmtcril
Copy link
Contributor Author

bmtcril commented Mar 14, 2024

@timmc-edx @mariajgrimaldi this is ready for re-review. Changes since the last push:

  • Using the release of code-annotations
  • Ran make upgrade because of that
  • Removed pii checks from Makefile and tox since they were broken after the removal of .pii_annotations.yml

Copy link
Member

@mariajgrimaldi mariajgrimaldi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thank you!

@mariajgrimaldi mariajgrimaldi merged commit fb6c3e1 into main Mar 14, 2024
9 checks passed
@mariajgrimaldi mariajgrimaldi deleted the bmtcril/autodoc-event-annotations branch March 14, 2024 13:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants