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

fix: build was failing due to deprecated configs & deps compatibility issues #72

Merged
merged 4 commits into from
Apr 11, 2024

Conversation

bra-i-am
Copy link
Contributor

@bra-i-am bra-i-am commented Mar 21, 2024

Description

This PR intends to fix the issue #70 by adding the build.os config key to the .readthedocs config file as shown in readthedocs/readthedocs.org#10290 (comment). Also, this PR adds some constraints (at doc.in) so the dependencies are compatible with Sphinx>5.0

Ref. https://blog.readthedocs.com/use-build-os-config/

Aditional Information

JIRA ISSUE DS-857

@bra-i-am bra-i-am marked this pull request as ready for review April 5, 2024 15:25
@bra-i-am bra-i-am changed the title fix: update a deprecated config key so tests can run properly again fix: build was failing because of deprecated configs & deps compatibility issues Apr 5, 2024
@bra-i-am bra-i-am changed the title fix: build was failing because of deprecated configs & deps compatibility issues fix: build was failing due to deprecated configs & deps compatibility issues Apr 5, 2024
MaferMazu
MaferMazu previously approved these changes Apr 5, 2024
Copy link
Contributor

@MaferMazu MaferMazu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not so happy with adding the constraints, but I didn't find a better way to make it work. I think we can go with this now and in the future, try to simplify the documentation or make it similar to the openedx but with our logos to avoid the many constrictions.

Can you help me remove the release variable from the conf.py? It is out of scope, but I think it is a quick fix we can add. If not, don't worry :)

MaferMazu
MaferMazu previously approved these changes Apr 5, 2024
@MaferMazu MaferMazu linked an issue Apr 8, 2024 that may be closed by this pull request
luisfelipec95
luisfelipec95 previously approved these changes Apr 9, 2024
dcoa
dcoa previously approved these changes Apr 9, 2024
@bra-i-am bra-i-am dismissed stale reviews from dcoa, luisfelipec95, and MaferMazu via a19f950 April 11, 2024 15:12
@bra-i-am bra-i-am merged commit 134ed7f into main Apr 11, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG] Documentation's build error
5 participants