docs: fix silently failing c.i. build of the sphinx docs #459
Conversation
This file contains 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
|
Here's the C.I. failure 
This didn't manifest before for two reasons.
|
CalMacCQ
commented
Feb 6, 2025
| for w in `find wheelhouse/ -type f -name "*.whl"` ; do poetry run pip install $w ; done | ||
| bash ./docs/install.sh | ||
| cd docs | ||
| for w in `find ../wheelhouse/ -type f -name "*.whl"` ; do poetry run pip install $w ; done |
There was a problem hiding this comment.
Seems the reason this wasn't working it that we couldn't find the wheelhouse directory after "cd"ing into docs
After 0773b8c the checks are passing.
CalMacCQ
changed the title
cqc-melf
reviewed
Feb 6, 2025
| rm -rf build/ | ||
|
|
||
| # This build script is only used for local docs build. |
There was a problem hiding this comment.
And on the CI for doc checks?
There was a problem hiding this comment.
Good point, I'll clarify that.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
closes #458
The issue was twofold. Firstly the
wheelhousedirectory could not be found after the "cd" into the docs directory. secondly we were also not using "recursive" mode for the docs submodules in c.i.Will add link checking in a follow up PR I think. Its proving to be a bit more annoying than I thought to get it working with the other stuff in
build-docs.shI think we should maybe change a few things about how this works going forward.