CI: Build docs on PR if src/ or docs/ change + index.md typo fix #8
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
- Enhanced documentation for plot_param_line and calculate_param_line functions - Updated module documentation in Linear_Algebra.jl - Improved function docstrings for clarity and consistency - Updated docs/src/index.md with plotting-related documentation
- Fixed malformed quotes in @autodocs Pages parameter - Changed Pages = [""linear_algebra_transform.jl"] to Pages = ["linear_algebra_transform.jl"] - Documentation now builds successfully without parse errors
- Adds docs-build job for PRs - Uses shell check to detect changes in src/ or docs/ and skips build otherwise - Prevents docs build for unrelated file changes (e.g., copilot-instructions.md)
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.
This PR adds CI workflow improvements so that documentation is built on pull requests only if files in src/ or docs/ are changed, and includes a typo fix in docs/src/index.md for the autodocs block.
Testing:
"