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.
Greptile Summary
This PR enhances the GitHub Actions workflow that synchronizes documentation from the main repository to a Read the Docs mirror repository. The changes add manual workflow dispatch capability, allowing developers to manually trigger documentation syncs and optionally specify a target branch different from the source branch. This provides more flexibility for documentation deployment strategies, testing changes on different branches, and preparing releases.
The workflow maintains backward compatibility - when triggered automatically (via push/tag events), it continues to mirror content to the same branch/tag names as before. However, when manually triggered, users can now specify a target branch parameter to push content from any source branch to a specific target branch in the mirror repository.
Additionally, the PR includes maintenance updates to keep the workflow compatible with current GitHub Actions standards: upgrading from deprecated
set-output
syntax toGITHUB_OUTPUT
environment files, and updating checkout actions from v3 to v4. The logic for pushing to the mirror repository has been consolidated and made conditional based on the trigger type.The submodule update for
docs/notebooks
brings in newer notebook content that will be included in the synchronized documentation.Important Files Changed
File Changes
.github/workflows/tidy3d-docs-sync-readthedocs-repo.yml
docs/notebooks
Confidence score: 4/5