chore: Switch from edx-sphinx-theme to sphinx-book-theme #426
chore: Switch from edx-sphinx-theme to sphinx-book-theme #426
Conversation
Thanks for the pull request, @xitij2000! 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. |
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## master #426 +/- ##
=======================================
Coverage 86.13% 86.13%
=======================================
Files 11 11
Lines 952 952
Branches 156 156
=======================================
Hits 820 820
Misses 88 88
Partials 44 44
Flags with carried forward coverage won't be shown. Click here to find out more. Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report in Codecov by Sentry. |
d719af8
to
39bca1a
Compare
Hi @xitij2000 - looks like there's some failing tests on this one. |
2bee43b
to
a0ad1d6
Compare
It seems the test failures are happening due to a change in linting rules which were updated during the requirements upgrade. So I'm limiting all these PRs to just changes to docs related requirements. |
2e9aa0e
to
de6fbd1
Compare
The coverage failure seems to be due to reasons outside of this PR since this doesn't touch any non documentation code. |
@jmbowman - flagging this for you. 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.
1 change, then I can merge.
@feanil Tests are failing in this and some other repos due to codecov being missing. I can remove the dependency but am not sure if this is the appropriate PR for it. Perhaps as a separate commit in the PRs? Or do I wait till that is corrected in a separate PR before rebasing these PRs? |
I've got a separate PR to fix it, that I'm waiting for review on: #431 |
@xitij2000 you should be ableto rebase this now and it should pass tests. |
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme. This removes references to the deprecated theme and replaces them with the new standard theme for the platform. See https://github.com/openedx/edx-sphinx-theme/issues/184
20e9548
to
94144af
Compare
Done! |
@xitij2000 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme. This removes references to the deprecated theme and replaces them with the new standard theme for the platform.
Testing instructions:
make docs
and see that the docs are generated properly and use the sphinx-book-themeSee openedx/public-engineering#200