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 Read the Docs builds #345

Merged
merged 2 commits into from
Mar 26, 2024
Merged

Conversation

kurtmckee
Copy link
Contributor

The documentation is failing to build on Read the Docs.

This PR:

  • Introduces a Read the Docs configuration
  • Locks the documentation build requirements to ensure reproducible builds
  • Fixes two trivial warnings that occur when building the docs

This work doesn't address #317 but makes it trivial to reproduce warnings and fix them, since all dependencies are locked.

If #344 merges, the documentation requirements can migrate to that same requirements management framework, and documentation builds can be tested/linted as a part of the test suite using tox.

Copy link
Owner

@corydolphin corydolphin left a comment

Choose a reason for hiding this comment

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

Thank you @kurtmckee for the contribution! This looks great. Merging.

@corydolphin corydolphin merged commit cadade9 into corydolphin:main Mar 26, 2024
@kurtmckee kurtmckee deleted the fix-readthedocs branch March 26, 2024 23:39
@kurtmckee
Copy link
Contributor Author

Thanks Cory!

I'm not seeing this trigger a new build on Read the Docs, though; it looks like the main branch isn't getting picked up as a version to build (link to listed versions). Would you double-check the settings for the project?

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.

2 participants