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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 1 commit into from
Apr 26, 2023
Merged

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

merged 1 commit into from
Apr 26, 2023

Conversation

xitij2000
Copy link
Contributor

@xitij2000 xitij2000 commented Apr 5, 2023 •
edited
Loading

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 •
edited
Loading

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 fa1729d to 485a05f Compare April 6, 2023 22:14
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 485a05f to 18ac71c Compare April 14, 2023 12:15
@xitij2000 xitij2000 marked this pull request as ready for review April 14, 2023 12:16
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 18ac71c to fb4087b Compare April 14, 2023 14:00
@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 a7af636 to feb23d3 Compare April 21, 2023 05:31
@mphilbrick211
Copy link

Hi @xitij2000 is this ready for review?

@xitij2000
Copy link
Contributor Author

Hi @xitij2000 is this ready for review?

Yes.

@feanil
Copy link
Contributor

feanil commented Apr 25, 2023

@xitij2000 it looks like this branch has some conflicts with master, can you resolve them?

@xitij2000
chore: Switch from edx-sphinx-theme to sphinx-book-theme
212dca1 
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 feb23d3 to 212dca1 Compare April 26, 2023 12:41
@feanil feanil merged commit d0e71ab into openedx:master Apr 26, 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 01:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@feanil feanil feanil approved these changes

Assignees
No one assigned
Labels
open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@xitij2000 @openedx-webhooks @Cup0fCoffee @mphilbrick211 @feanil