Add literate.jl tutorial infrastructure#251
Conversation
Performance ResultsPrecompile Time
Execution Time
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #251 +/- ##
==========================================
+ Coverage 78.52% 79.54% +1.01%
==========================================
Files 38 38
Lines 3781 3783 +2
==========================================
+ Hits 2969 3009 +40
+ Misses 812 774 -38
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
|
@m-bossart I'm going ahead with adding this literate tutorial processing infrastructure now, since the documentation effort has been split in two, so future tutorials can be written directly using literate.jl format |
There was a problem hiding this comment.
Pull request overview
Adds documentation tooling to support Literate.jl-based tutorial generation and cross-project linking in the docs build pipeline, plus automation for cleaning up Documenter preview artifacts.
Changes:
- Add tutorial-generation infrastructure (
make_tutorials.jl) to produce Documenter-flavored markdown and companion notebooks, with post-processing for downloads/admonitions/images. - Add DocumenterInterLinks configuration to enable
@extreflinks to PowerSystems and PowerSystemCaseBuilder docs. - Add CI wiring for setting
DOCUMENTER_CURRENT_VERSION(for correct download links) and a new workflow to delete PR preview docs on PR close.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/Project.toml | Adds docs-only dependencies needed for Literate tutorial generation and InterLinks. |
| docs/make.jl | Wires InterLinks plugin and calls tutorial generation before makedocs. |
| docs/make_tutorials.jl | New tutorial processing pipeline + notebook/markdown post-processing helpers. |
| .pre-commit-config.yaml | Adds a local pre-commit hook to run the Julia formatter script. |
| .github/workflows/docs.yml | Sets DOCUMENTER_CURRENT_VERSION in CI for correct generated download links. |
| .github/workflows/doc-preview-cleanup.yml | New workflow to remove gh-pages preview directories after PR close. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| git config user.email "documenter@juliadocs.github.io" | ||
| git rm -rf "${preview_dir}" | ||
| git commit -m "delete preview" | ||
| git branch gh-pages-new "$(echo "delete history" | git commit-tree "HEAD^{tree}")" |
| types: [file] | ||
| pass_filenames: false |
| for file in tutorial_files | ||
| @show file | ||
| infile_path = joinpath(tutorials_dir, file) | ||
| execute = | ||
| if occursin("EXECUTE = TRUE", uppercase(readline(infile_path))) | ||
| true | ||
| else | ||
| false | ||
| end |
Uh oh!
There was an error while loading. Please reload this page.