Quarto plugin #482
Quarto plugin #482
Conversation
…new Julia engine since v1.5
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #482 +/- ##
==========================================
- Coverage 94.33% 88.13% -6.21%
==========================================
Files 24 25 +1
Lines 742 784 +42
==========================================
- Hits 700 691 -9
- Misses 42 93 +51 ☔ View full report in Codecov by Sentry. |
|
|
||
| Arguments | ||
| * `--help` - print this help and exit without rendering the documentation | ||
| * `--prettyurls` – toggle the prettyurls part to true (which is otherwise only true on CI) |
There was a problem hiding this comment.
I think this option is currently not realised? For the rest – one should maybe also make sure the make-jl is excusable for this to work.
But cool, that you found this idea so useful to even provide it here as a template!
There was a problem hiding this comment.
Yeh I think you're right about the option and will either remove it or make sure it's realized. As for make.jl being executable, there's this line here and I think this is already working.
I'm going to hold on before doing more work on this due to #478 and also the discussion here #483, but thank you for the review!
There was a problem hiding this comment.
Ah, I did not see that line, that of course makes sure this works as a script.
This adds a new
Quartoplugin that can be used to generate package documentation with Quarto and Documenter.jl. I've closely followed the steps outlined by @kellertuer in this blog post and also during our joint JuliaCon presentation earlier this year.Additions
src/plugins/ci.jl(l. 79) gets aHAS_QUARTOfield to be used in templates. TheHAS_DOCUMENTERfield is adjusted.src/plugins/quarto.jladds the plugin, which 1) inherits its view from theReadmeandDocumenterplugins; 2) generates aREADME.qmd,docs/src/index.qmd, a custom executablemake.jl(includes steps for remote rendering) and a_quarto.yml(configs for Quarto).templates/github/workflows/CI.ymlensure that docs are rendered through Quarto if he plugin is used.templates/quarto/for theREADME.qmd,index.qmd,_quarto.ymlandmake.jl.All other changes are due to running
JuliaFormatter.format("src").Doubts and other notes
CondaPkgand caching), because I'd expect that most users will use QuartoNotebookRunner.jl in the future.fixupfunction (continuing from this stale PR) and accidentally merged some of this here initially (should be all reverted in 3910fe6)@kellertuer might you be able to have a quick look at this and see if you spot any missing pieces?