Complete edx-sphinx-theme DEPR in edx org

[robrap]

AC:

• Usage of edx-sphinx-theme in the edx org has been removed.

Additional Notes:

• DEPR: https://github.com/openedx-unsupported/edx-sphinx-theme/issues/184
• Instructions: https://docs.openedx.org/en/latest/developers/how-tos/switch-to-the-sphinx-book-theme.html
• The repos in the edx GitHub org that still depend on this theme:

Tasks

Preview Give feedback

1. braze-client
2. commerce-coordinator
3. dbt-schema-builder
4. demographics
5. edx-arch-experiments
6. edx-exams
7. edx-name-affirmation
8. financial-assistance
9. getsmarter-api-clients
10. learner-pathway-progress
11. monitoring-scripts
12. outcome-surveys
13. platform-plugin-coaching (unable to write to this and forking is also disabled)
14. platform-plugin-notices
15. portal-designer
16. program-intent-engagement
17. subscriptions
18. video-encode-manager

• The common constraint was removed, but we think that upgrades may be picking up the right version for some reason, which is good. Otherwise, this constraint would need to be copied into the other repos. See https://github.com/openedx-unsupported/edx-sphinx-theme/issues/184
  • I closed the ticket to remove this common constraint: Remove Sphinx Common Constraint openedx/edx-lint#338

[huniafatima-arbi]

We are waiting on the information to be added in license and author section which is to be updated as the edx-sphinx-theme is being replaced by sphinx-book-theme.
Slack thread for more information.
Moving it to blocked until the issue is resolved.

[MichaelRoytman]

@huniafatima-arbi I hope you're doing well. I think that the upgrade of sphinx may have broken the requirements in the repository, as there is now a conflict between doc8, readme-renderer, and sphinx on the version of docutils. This causing the Python requirements upgrade action to fail.

Here is the error log.

pip._vendor.resolvelib.resolvers.ResolutionImpossible: [RequirementInformation(requirement=SpecifierRequirement('docutils<=0.21.2,>=0.19'), parent=LinkCandidate('https://files.pythonhosted.org/packages/0c/f1/6ffd5d76578e98a8f21ae7216b88a7212c778f665f1a8f4f8ce6f9605da4/doc8-1.1.2-py3-none-any.whl (from https://pypi.org/simple/doc8/) (requires-python:>=3.8)')), RequirementInformation(requirement=SpecifierRequirement('docutils>=0.21.2'), parent=LinkCandidate('https://files.pythonhosted.org/packages/e1/67/921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0/readme_renderer-44.0-py3-none-any.whl (from https://pypi.org/simple/readme-renderer/) (requires-python:>=3.9)')), RequirementInformation(requirement=SpecifierRequirement('docutils<0.20,>=0.14'), parent=LinkCandidate('https://files.pythonhosted.org/packages/67/a7/01dd6fd9653c056258d65032aa09a615b5d7b07dd840845a9f41a8860fbc/sphinx-5.3.0-py3-none-any.whl (from https://pypi.org/simple/sphinx/) (requires-python:>=3.6)'))]

• doc8 requires docutils<=0.21.2,>=0.19
• readme-renderer requires docutils>=0.21.2
• sphinx requires docutils<0.20,>=0.14

The earliest version of sphinx that supports docutils>0.21.0 is 7.3.0, but that causes conflicts with the sphinx-book-theme you added, because that requires sphinx<7.

I'm unable to find a combination of versions that allow us to successfully install requirements. Can you help me understand how to correct this issue while maintaining the changes you made? Thank you.

[huniafatima-arbi]

@huniafatima-arbi I hope you're doing well. I think that the upgrade of sphinx may have broken the requirements in the repository, as there is now a conflict between doc8, readme-renderer, and sphinx on the version of docutils. This causing the Python requirements upgrade action to fail.

Here is the error log.

pip._vendor.resolvelib.resolvers.ResolutionImpossible: [RequirementInformation(requirement=SpecifierRequirement('docutils<=0.21.2,>=0.19'), parent=LinkCandidate('https://files.pythonhosted.org/packages/0c/f1/6ffd5d76578e98a8f21ae7216b88a7212c778f665f1a8f4f8ce6f9605da4/doc8-1.1.2-py3-none-any.whl (from https://pypi.org/simple/doc8/) (requires-python:>=3.8)')), RequirementInformation(requirement=SpecifierRequirement('docutils>=0.21.2'), parent=LinkCandidate('https://files.pythonhosted.org/packages/e1/67/921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0/readme_renderer-44.0-py3-none-any.whl (from https://pypi.org/simple/readme-renderer/) (requires-python:>=3.9)')), RequirementInformation(requirement=SpecifierRequirement('docutils<0.20,>=0.14'), parent=LinkCandidate('https://files.pythonhosted.org/packages/67/a7/01dd6fd9653c056258d65032aa09a615b5d7b07dd840845a9f41a8860fbc/sphinx-5.3.0-py3-none-any.whl (from https://pypi.org/simple/sphinx/) (requires-python:>=3.6)'))]

• doc8 requires docutils<=0.21.2,>=0.19
• readme-renderer requires docutils>=0.21.2
• sphinx requires docutils<0.20,>=0.14

The earliest version of sphinx that supports docutils>0.21.0 is 7.3.0, but that causes conflicts with the sphinx-book-theme you added, because that requires sphinx<7.

I'm unable to find a combination of versions that allow us to successfully install requirements. Can you help me understand how to correct this issue while maintaining the changes you made? Thank you.

Hey @MichaelRoytman I have created an issue against this and added to board. We shall be picking this up and looking into this issue.
Issue reference: edx/edx-name-affirmation#231
thank you for pointing it out.