-
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
chore: Switch from edx-sphinx-theme to sphinx-book-theme #87
chore: Switch from edx-sphinx-theme to sphinx-book-theme #87
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. |
18bc3a5
to
73c6375
Compare
73c6375
to
8d78fe5
Compare
@xitij2000 Are the changes kept to the minimal because the repo has been using the theme before and the settings that had been set are assumed to be the desired ones? Just asking, since I've notice a minor difference to how the docs in the other repos look after the change - no light/dark mode theme button, no changes to the footer, and perhaps there is more. Not a blocker on my side. |
👍
|
Yes, the rest of the config was already in place. |
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme. This removes references to the deprecated theme, replaces them with the new standard theme for the platform, and updates the theme configuraiton to use the new theme. See openedx/edx-sphinx-theme#184
8d78fe5
to
dab0b7d
Compare
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.
Thank you for the changes!
@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, replaces them with the new
standard theme for the platform, and updates the theme configuraiton to use the
new theme.
Testing instructions:
make docs
ormake html
in the docs directory and see that the docs are generated properly and use the sphinx-book-themeSee openedx/public-engineering#200