-
Notifications
You must be signed in to change notification settings - Fork 16
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
Conversation
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:
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. |
734207c
to
8676e9c
Compare
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! |
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.
LGTM
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.
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.
e957753
to
ab545da
Compare
Since I'm only changing documentation, I'll be merging as is even with the coverage failures. |
@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. |
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/