docs: [FC-0074] make adjustments to generate docs with sphinx for GH pages #11
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mariajgrimaldi
changed the title
BryanttV
reviewed
Jan 30, 2025
There was a problem hiding this comment.
Hi @mariajgrimaldi, I was reviewing the documentation and I have a few comments:
- The event name link and event type are incorrect:
openedx-events-2-zapier/README.rst
Line 59 in fc9284c
- When I try to access the handlers.py link it redirects me to the same page, but not to the repository. I think all relative links are broken.
openedx-events-2-zapier/README.rst
Line 71 in fc9284c
|
Thanks, @BryanttV. I see that handlers.py works fine in the readme file but not with Sphinx. I'll try a workaround to fix it. |
BryanttV
reviewed
Jan 31, 2025
README.rst
Outdated
| @@ -56,7 +58,7 @@ Supported Events | |||
| +-------------------------------------+------------------------------------------------------------+---------------------------------------------------------------------+ | |||
| | `COURSE_ENROLLMENT_CREATED`_ | org.openedx.learning.course.enrollment.created.v1 | Triggered upon successful course enrollment. | | |||
| +-------------------------------------+------------------------------------------------------------+---------------------------------------------------------------------+ | |||
| | `PERSISTENT_GRADE_SUMMARY_CHANGED`_ | org.openedx.learning.course.persistent_grade.summary.v1 | Triggered when a persistent grade summary is updated. This happens | | |||
| | `PERSISTENT_GRADE_SUMMARY_CHANGED`_ | org.openedx.learning.course.persistent_grade_summary.v1 | Triggered when a persistent grade summary is updated. This happens | | |||
There was a problem hiding this comment.
Suggested change
| | `PERSISTENT_GRADE_SUMMARY_CHANGED`_ | org.openedx.learning.course.persistent_grade_summary.v1 | Triggered when a persistent grade summary is updated. This happens | | |
| | `PERSISTENT_GRADE_SUMMARY_CHANGED`_ | org.openedx.learning.course.persistent_grade_summary.changed.v1 | Triggered when a persistent grade summary is updated. This happens | |
There was a problem hiding this comment.
I'm sorry for all the back and forth, I didn't notice these changes were wrong. Thanks :)
There was a problem hiding this comment.
Could we update the LICENSE and CODEOWNERS link? It is the same problem with the link.
|
FYI @sarina |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR changes the structure of the doc so it can be rendered in GH pages: https://edunext.github.io/openedx-events-2-zapier/ for the developer's consumption.