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

chore: Switch from edx-sphinx-theme to sphinx-book-theme #87

Merged

Conversation

xitij2000
Copy link
Contributor

@xitij2000 xitij2000 commented May 11, 2023

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:

  • Run make docs or make html in the docs directory and see that the docs are generated properly and use the sphinx-book-theme

See openedx/public-engineering#200

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 11, 2023
@openedx-webhooks
Copy link

openedx-webhooks commented May 11, 2023

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:

  • 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.

@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 18bc3a5 to 73c6375 Compare May 11, 2023 11:36
@xitij2000 xitij2000 changed the title 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. chore: Switch from edx-sphinx-theme to sphinx-book-theme May 11, 2023
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 73c6375 to 8d78fe5 Compare May 19, 2023 09:46
@xitij2000 xitij2000 marked this pull request as ready for review May 19, 2023 09:47
@xitij2000 xitij2000 requested a review from a team as a code owner May 19, 2023 09:47
@Cup0fCoffee
Copy link

Cup0fCoffee commented May 22, 2023

@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.

@Cup0fCoffee
Copy link

👍

  • I tested this: make docs
  • I read through the code

@xitij2000
Copy link
Contributor Author

@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
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 8d78fe5 to dab0b7d Compare May 25, 2023 19:57
Copy link
Member

@mariajgrimaldi mariajgrimaldi left a 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!

@mariajgrimaldi mariajgrimaldi merged commit a270423 into openedx:main Jun 1, 2023
@openedx-webhooks
Copy link

@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.

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Sep 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants