Fix documentation build errors in Buildkite CI #468
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
- Fix path handling in make.jl to work from both root and docs directory - Fix broken example in sispde.md by adding error handling for failed steady state solve - Update broken JuliaHub compiler documentation link - Create assets directory if it doesn't exist These changes address the documentation build failures seen in Buildkite CI. The main issue was that make.jl assumed it was run from the root directory, but Buildkite runs it from the docs directory. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
As requested, reverting the path handling changes in make.jl and removing the generated Project.toml file from assets. The documentation build issues will need to be addressed differently. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
The episize! function was using 'state' as the variable name for the solution object, but it should be 'steadystate' to be consistent with the rest of the document and to properly work with solution indexing. The solve() function returns a solution object that can be indexed directly, so we just need to use the correct variable name. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
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.
Summary
This PR fixes the documentation build errors that were causing failures in Buildkite CI.
Problems Fixed
Path handling in make.jl: The script assumed it was run from the root directory, but Buildkite runs it from the docs directory, causing "file not found" errors.
Failed example in sispde.md: The
episize!function example was failing becausesolve()was returningnothingand the code tried to index into it.Broken JuliaHub link: The link to JuliaSimCompiler documentation (https://help.juliahub.com/juliasimcompiler/dev/) was returning 404.
Changes
docs/make.jl: Added logic to detect whether the script is run from root or docs directory and adjust paths accordingly. Also ensures the assets directory exists.
docs/src/tutorials/sispde.md: Added error handling in the
episize!function to check if the steady state solve was successful before trying to access the solution.docs/src/performance.md: Updated the broken JuliaHub compiler documentation link to point to the main JuliaSim products page.
Test Results
Tested locally by running the documentation build from both the root directory and the docs directory:
julia --project=docs docs/make.jl(from root)cd docs && julia --project=. make.jl(from docs directory)Both now work correctly with these changes.
Related Issues
🤖 Generated with Claude Code