search

JuliaDocs / DocumenterTools.jl

Extra tools for setting up Documenter
Other
30 stars 19 forks source link

Add code to `make.jl` so it can run as a script #88

Closed goerz closed 7 months ago

goerz commented 7 months ago

See https://github.com/JuliaDocs/Documenter.jl/issues/1413#issuecomment-1942392352

mortenpi commented 7 months ago

One note here: I am not sure we want to maintain the generation functionality that much here? Wouldn't we want to direct users to PkgTemplates?

goerz commented 7 months ago

Maybe… I was playing around with rewriting the Documenter Guide, and it would allow for a rather didactic approach where we can set up the documentation from scratch, using @repl/@eval blocks:

CleanShot 2024-02-13 at 16 50 17@2x

This would make the guide full reproducible, and DocumenterTools.generate would definitely help there.

goerz commented 7 months ago

Not quite sure yet if this really works out, though. It would be helpful if there was a @repl block that could also handle pkg > and shell > mode, but that would be a whole new issue to open and not completely trivial to implement.

goerz commented 7 months ago

Anyway, I might play around more, but I'll probably put this on the backburner until the next community call.

goerz commented 7 months ago

Wouldn't we want to direct users to PkgTemplates?

Actually, you're right. PkgTemplates is a much better place to focus any effort on for defining best practices, and I can use that just as well in a tutorial.