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

.readthedocs.yaml: add docs requirements to fix rtd build #173

Merged
merged 1 commit into from
Mar 14, 2024

Conversation

Bastian-Krause
Copy link
Member

In the past readthedocs installed sphinx-rtd-theme implicitly, but not anymore. So add a requirements.txt with a pinned version of sphinx-rtd-theme and reference it in the .readthedocs.yaml.

@jluebbe
Copy link
Member

jluebbe commented Mar 14, 2024

In rauc, we use pip-compile to fix all dependencies:
https://github.com/rauc/rauc/blob/master/docs/requirements.in
https://github.com/rauc/rauc/blob/master/docs/requirements.txt

Otherwise, RTD seems to install versions dependent on the project creation date...

In the past readthedocs installed sphinx-rtd-theme implicitly, but not
anymore. So add a requirements.in with sphinx and sphinx-rtd-theme, use
pip-compile to create a pinned requirements.txt and reference that in the
.readthedocs.yaml.

Signed-off-by: Bastian Krause <[email protected]>
@Bastian-Krause
Copy link
Member Author

Even better, I've adopted the same for rauc-hawkbit-updater.

@Bastian-Krause Bastian-Krause merged commit 076795d into rauc:master Mar 14, 2024
7 of 9 checks passed
@Bastian-Krause Bastian-Krause deleted the bst/fix-rtd branch March 14, 2024 11:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants