Conversation
There was a problem hiding this comment.
Pull request overview
This PR ports a set of “Literate cleanup” improvements from PowerFlows.jl into PowerGraphics.jl’s documentation build pipeline, mainly around tutorial generation/linking and doc-preview workflow behavior.
Changes:
- Moves docs base-URL logic into
docs/make_tutorials.jland uses it to generate correct absolute tutorial download/view-online links across preview/dev/tagged/stable deployments. - Improves Literate tutorial generation utilities (DataFrame display bounding, safer
APPEND_MARKDOWN(...)replacement, tutorial artifact cleanup, clearer comments). - Updates GitHub Actions docs workflow to set
DOCUMENTER_CURRENT_VERSION, and restricts doc preview cleanup to non-fork PRs.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
docs/make.jl |
Removes now-redundant _DOCS_BASE_URL constant (URL is computed in tutorial pipeline). |
docs/make_tutorials.jl |
Adds docs URL computation, download link policy, and refactors/clarifies Literate postprocessing and cleanup utilities. |
.github/workflows/docs.yml |
Adds a step to populate DOCUMENTER_CURRENT_VERSION for correct deployed tutorial links. |
.github/workflows/doc-preview-cleanup.yml |
Skips preview cleanup for forked PRs (since it pushes to gh-pages). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+25
to
+29
| maximum_number_of_columns = _DF_MAX_COLS, | ||
| show_omitted_cell_summary = true, | ||
| compact_printing = false, | ||
| limit_printing = true) | ||
| limit_printing = true, | ||
| kwargs...) |
Comment on lines
+35
to
+40
| maximum_number_of_rows = _DF_MAX_ROWS, | ||
| maximum_number_of_columns = _DF_MAX_COLS, | ||
| show_omitted_cell_summary = true, | ||
| compact_printing = false, | ||
| limit_printing = true) | ||
| limit_printing = true, | ||
| kwargs...) |
Comment on lines
+26
to
+29
| elif [[ "${{ github.ref }}" == refs/tags/* ]]; then | ||
| echo "DOCUMENTER_CURRENT_VERSION=${GITHUB_REF_NAME}" >> "$GITHUB_ENV" | ||
| elif [[ "${{ github.ref }}" == "refs/heads/main" ]] || [[ "${{ github.ref }}" =~ ^refs/heads/release- ]]; then | ||
| echo "DOCUMENTER_CURRENT_VERSION=dev" >> "$GITHUB_ENV" |
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
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.
Apply cleanup from Sienna-Platform/PowerFlows.jl#356