chore: Switch from edx-sphinx-theme to sphinx-book-theme. #268
Conversation
openedx-webhooks
added
the
open-source-contribution
|
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 #268 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 16 16
Lines 436 436
Branches 47 47
=========================================
Hits 436 436
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. |
xitij2000
changed the title
xitij2000
force-pushed
the
kshitij/switch-to-sphinx-book-theme
branch
from
a97f649 to
3ed927a
Compare
|
Hi @openedx/arch-bom - would someone be able to review this and merge if all looks good? Thanks! |
rgraber
left a comment
rgraber
left a comment
There was a problem hiding this comment.
Please remove the unrelated requirements/ changes. It will make rollback easier if it becomes necessary, and help us keep track of what changes were made when
| "repository_url": "https://github.com/openedx/django-user-tasks", | ||
| "repository_branch": "master", | ||
| "path_to_docs": "docs/", | ||
| "home_page_in_toc": True, |
There was a problem hiding this comment.
[question] Why are we leaving out logo_only ?
There was a problem hiding this comment.
Support for that seems to have been removed in this PR: https://github.com/executablebooks/sphinx-book-theme/pull/668/files#diff-56e5475bc04460ee05cd5ac9199ebbfa3e21f1bfa64ce5469cfb2f1890b41ccfL42
There is now a different mechanism for this as outlined here: executablebooks/sphinx-book-theme@b0e6b52#diff-ffa6fcfcf96f0b20b242a31c1346439658bb90a4e42e3c8fc8d0b1bc3d4b7277L59
The new default behaviour seems to match logo_only = True though.
|
👍 Conditional approval, for when the unnecessary changes in the
|
|
Hi @xitij2000 - just flagging the feedback here. Thanks! |
docs/conf.py
Outdated
| href="https://openedx.org" | ||
| property="cc:attributionName" | ||
| rel="cc:attributionURL" | ||
| >The Center for Reimagining Learning</a> |
There was a problem hiding this comment.
| >The Center for Reimagining Learning</a> | |
| >The Axim Collaborative</a> |
xitij2000
force-pushed
the
kshitij/switch-to-sphinx-book-theme
branch
2 times, most recently
from
d152dcd to
4b9c6d0
Compare
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
xitij2000
force-pushed
the
kshitij/switch-to-sphinx-book-theme
branch
from
4b9c6d0 to
7e25da2
Compare
feanil
changed the title
feanil
dismissed
rgraber’s stale review
The requirements have been re-built correctly.
|
@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. |
6 participants
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 docsand see that the docs are generated properly and use the sphinx-book-theme