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

Install read_the_docs theme in .readthedocs.yaml #2029

Merged
merged 2 commits into from
Oct 24, 2023

Conversation

ni-jfitzger
Copy link
Collaborator

@ni-jfitzger ni-jfitzger commented Oct 24, 2023

  • This contribution adheres to CONTRIBUTING.md.

  • [ ] I've updated CHANGELOG.md if applicable.

  • [ ] I've added tests applicable for this pull request

What does this Pull Request accomplish?

Documentation is failing to build due to the theme not being found. Most likely, Read the Docs changed something so that their theme is no longer installed by default.

This change updates the .readthedocs.yamls to install the theme.

I don't have time to properly add a requirements file, right now, so this is just a band-aid: a sort-of requirements file to get the dependency installed. We still have an open issue to properly add a requirements file for the sphinx build.

List issues fixed by this Pull Request below, if any.

What testing has been done?

None. If the PR checks pass, it should fix the issue.

@ni-jfitzger
Copy link
Collaborator Author

I clearly misinterpreted the Read the Docs documentation. I have to add a requirements file.

@ni-jfitzger
Copy link
Collaborator Author

Skipping the rest of the build, since the documentation builds passed and nothing else changed.

@ni-jfitzger ni-jfitzger merged commit d92f58a into ni:master Oct 24, 2023
25 of 26 checks passed
@ni-jfitzger ni-jfitzger deleted the install-rtd-theme branch October 24, 2023 14:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation is failing to build on Read the Docs due to the read_the_docs theme not being found.
2 participants