-
Notifications
You must be signed in to change notification settings - Fork 477
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
additionnal documentation of julia make.jl
for newbies
#1565
Comments
julia make
for newbiesjulia make.jl
for newbies
The beginner section of the docs should definitely be improved. However, I don't really agree with this particular suggestions (putting various |
Hi Morten , Thank you for your feedback. My somewhat long answer below. tldr: either the "beginner" instructions are not completely robust, or I am using them wrong (My bayesian opinion would point towards the second solution, the most likely outcome of beginners trying beginner instructions... 😃 ) , but maybe the information below would show otherwise?
FWIW, i am trying to ressuscitate (/spring cleaning) this package: https://github.com/mkriele/ValueOrientedRiskManagementInsurance.jl, which I downloaded and am modifying locally.
The package |
If you're compiling the docs from the command line, you definitely need to make sure that you've activated the Our docs are oriented towards this CLI approach though, and what would probably be really helpful for users is to have a section describing a e.g. VSCode-based workflow. The only thing one really needs to do there though is run |
I've just been running into the same problem @reumle described. I'm new to Documenter, but surely not to Julia. So I agree that the beginners documentation needs some improvement 😀. I haven't |
Closing in favor of #1413 |
Hi I just used Documenter for the first time. Thanks all for the great stuff!
I initially struggled letting
julia make
work as i was trying to start documenting a package. I had errors such asFinally i found https://discourse.julialang.org/t/problem-using-documenter-jl/29052 . It solves my issue (with the first 2 lines of code below) . I suggest to incorporate the tip in the Documenter docs with something like this:
Except if it is already in the docs, but i could not find it.
Ok for a pull request to that effect?
Regards.
The text was updated successfully, but these errors were encountered: