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

CLI for make.jl #75

Open
mortenpi opened this issue Jun 1, 2016 · 1 comment
Open

CLI for make.jl #75

mortenpi opened this issue Jun 1, 2016 · 1 comment

Comments

@mortenpi
Copy link
Member

mortenpi commented Jun 1, 2016

This is a small RFC to discuss a possible extension of the make.jl

In a nutshell, the make.jl script could take arguments to allow the user have a bit more control over what it does. I am thinking basically how mkdocs works. So, you would call it like julia make.jl <command>, where the command could be build, clean, deploy, serve etc.

You could also have more arguments, to give even more power to the user, without them having to make changes to the script (e.g. specify the target format, --debug etc). Also, having a serve command would be a first step in addressing #11.

In the make.jl it would look something like this

using Documenter, PkgName
Documenter.run(ARGS; config...)

The implementation actually wouldn't necessarily conflict with the way the scripts work currently, since we can keep makedocs and deploydocs function (and would probably call them in run), even though perhaps in the long term they should be deprecated. Also, build could be the default command, so julia make.jl would work as it does currently.

One more benefit would be that some things would become a bit more explicit. For example, deploydocs currently semi-magically decides if it should do something or not. The explicitness could maybe help with testing as well.

@MichaelHatherly
Copy link
Member

Yes, probably worth doing I think.

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

No branches or pull requests

2 participants