Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
wants to merge 1 commit into from

Conversation

goerz
Copy link
Member

@goerz goerz commented Feb 13, 2024

@mortenpi
Copy link
Member

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
Copy link
Member Author

goerz commented Feb 13, 2024

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
Copy link
Member Author

goerz commented Feb 13, 2024

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
Copy link
Member Author

goerz commented Feb 13, 2024

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

@goerz
Copy link
Member Author

goerz commented Feb 13, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants