Fix Read the Docs builds #116
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Read the Docs builds are throwing the following error: > Config validation error in `build.os`. Value `build` not found. This commit attempts to address all of the anticipated failures.
This is the full text of the Sphinx warning: ``` WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English). ```
The full text of the Sphinx info message is:
```
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
```
Two warnings were thrown for the same underlying issue: ``` WARNING: py:exc reference target not found: seekpath.SupercellWarning [ref.exc] ```
t-reents
approved these changes
Jan 29, 2026
Collaborator
t-reents
left a comment
t-reents
left a comment
There was a problem hiding this comment.
Thanks a lot @kurtmckee !
I'll merge this one first, as you also addressed the warnings that I also found locally.
I'll then update my own fix in #114 to restructure the dependencies.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
RTD builds are failing. [recent example]
This PR attempts to fix all of the anticipated issues, as well as resolve a number of warnings and info messages displayed when building the docs locally using
sphinx-build -b html -n docs/source docs/_build: