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

Merged

Conversation

xitij2000
Copy link
Contributor

@xitij2000 xitij2000 commented Mar 24, 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

Reviewers:

  • tag reviewer
  • tag reviewer

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Version bumped
  • Changelog record added
  • Documentation updated (not only docstrings)
  • Commits are squashed

Post merge:

  • Create a tag
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)

Author concerns: List any concerns about this PR - inelegant
solutions, hacks, quick-and-dirty implementations, concerns about
migrations, etc.

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

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.

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.
@xitij2000 xitij2000 changed the title feat: Switch from edx-sphinx-theme to sphinx-book-theme chore: Switch from edx-sphinx-theme to sphinx-book-theme Mar 24, 2023
@xitij2000 xitij2000 force-pushed the kshitij/switch-to-sphinx-book-theme branch from 1560e7c to 075c663 Compare March 24, 2023 07:43
@mphilbrick211 mphilbrick211 requested review from a team and zainab-amir March 24, 2023 18:49
@mphilbrick211
Copy link

Hi @openedx/vanguards! Would someone be able to review/merge this? Thanks!

@mubbsharanwar mubbsharanwar merged commit 19d017d into openedx:master Mar 29, 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 12, 2023 12: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