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

docs: add configuration for automatic filters docs generation #173

Merged
merged 3 commits into from
Jun 21, 2024

Conversation

mariajgrimaldi
Copy link
Member

@mariajgrimaldi mariajgrimaldi commented Jun 4, 2024

Description

This PR adds the necessary configuration for automatic docs generation based on Open edX Filters classes, you can see the docs generated here: https://docsopenedxorg--173.org.readthedocs.build/projects/openedx-filters/en/173/

@openedx-webhooks
Copy link

openedx-webhooks commented Jun 4, 2024

Thanks for the pull request, @mariajgrimaldi! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 4, 2024
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review June 5, 2024 03:06
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner June 5, 2024 03:06
@mariajgrimaldi
Copy link
Member Author

mariajgrimaldi commented Jun 5, 2024

Hi @Ian2012 @felipemontoya! Here's a PR for better docs on the filters that are available. I'll also update the classes' docstrings so they have more meaningful content. But in the meantime, what do you think about the format? Is it enough info? What else should we add? Thanks!

@mariajgrimaldi mariajgrimaldi linked an issue Jun 5, 2024 that may be closed by this pull request
Copy link
Contributor

@Ian2012 Ian2012 left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@felipemontoya felipemontoya left a comment

Choose a reason for hiding this comment

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

Working as advertised. I think this is good for merging.

Another thing we should do is to make available the different versions on the docs page, but that is not related to this specific work.

@mariajgrimaldi
Copy link
Member Author

mariajgrimaldi commented Jun 21, 2024

Since I'm only changing documentation, I'll be merging as is even with the coverage failures.

@mariajgrimaldi mariajgrimaldi merged commit 8505116 into main Jun 21, 2024
10 of 11 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/docs-gen branch June 21, 2024 21:42
@openedx-webhooks
Copy link

@mariajgrimaldi 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

4 participants