Add Documentation workflow for automatic docs deployment #495
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 adds a GitHub Actions workflow to automatically build and deploy documentation on:
Problem
Issue #439 reported that the "Adding Parameters" tutorial example fails because the documentation website shows outdated syntax. Investigation revealed:
stablesymlink on gh-pages still points to v0.10.4 (Dec 2023)This means users visiting https://docs.sciml.ai/MethodOfLines/stable/tutorials/params/ see outdated documentation that uses the old (now broken) syntax:
Instead of the correct syntax that's in the master branch:
Solution
Adding a Documentation.yml workflow will:
dev/docs)stablesymlink)This ensures documentation stays in sync with code changes.
Test plan
dev/docs are updatedstablesymlink is updatedCloses #439
cc @ChrisRackauckas
🤖 Generated with Claude Code