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 #190

Merged

Conversation

xitij2000
Copy link
Contributor

@xitij2000 xitij2000 commented Apr 5, 2023

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:

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

See openedx/public-engineering#200

@openedx-webhooks
Copy link

openedx-webhooks commented Apr 5, 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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 5, 2023
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch 2 times, most recently from 61c07a2 to 448a4ea Compare April 6, 2023 22:14
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 448a4ea to b39adf0 Compare April 14, 2023 12:15
@Cup0fCoffee
Copy link

@xitij2000 FYI, the tests are failing due to codecov issue.

@Cup0fCoffee
Copy link

👍

  • I tested this: ran make docs
  • I read through the code
  • Includes documentation

@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch 3 times, most recently from ffc921f to 87809d0 Compare April 24, 2023 05:54
@xitij2000 xitij2000 marked this pull request as ready for review April 24, 2023 06:01
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
@feanil feanil force-pushed the kshitij/switch-to-sphinx-book-theme branch from 87809d0 to 9064696 Compare April 25, 2023 14:25
@feanil feanil merged commit e14c1e0 into openedx:master Apr 25, 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.

@xitij2000 xitij2000 deleted the kshitij/switch-to-sphinx-book-theme branch April 27, 2023 02:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

4 participants