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

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 openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 5, 2023
@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.

@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch 2 times, most recently from 4cb17bc to 6f3b721 Compare April 6, 2023 22:14
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch 2 times, most recently from a82be95 to 5e66093 Compare April 14, 2023 12:28
@xitij2000 xitij2000 marked this pull request as ready for review April 14, 2023 13:58
@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 2 times, most recently from e268889 to 22afb04 Compare April 21, 2023 05:31
@mphilbrick211
Copy link

Hi @xitij2000! Is this ready for review? If so, would you mind addressing the branch date item in the meantime? Thanks!

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 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 22afb04 to 646bd13 Compare April 25, 2023 07:07
@xitij2000
Copy link
Contributor Author

xitij2000 commented Apr 25, 2023

Hi @xitij2000! Is this ready for review? If so, would you mind addressing the branch date item in the meantime? Thanks!

Yes, it's ready for review. CC: @feanil

I'm not sure what you mean by "addressing the branch date item"?

@feanil feanil merged commit a31b7cb into openedx:master Apr 25, 2023
9 checks passed
@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:24
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.

None yet

5 participants