Hi Andreas,
There’s no style guide specific to Julia that I’m aware of. Your best bet
would probably be to have a look to how other languages go
about documenting and extract the parts that make the most sense to you.
Beyond that I’d just suggest documenting each thing that you export from
Thanks, this is what I was looking for.
Jan
Dňa piatok, 9. januára 2015 17:12:57 UTC+1 Michael Hatherly napísal(-a):
Hi Jan,
If you run into any problems or have any suggestions for improvements feel
free to open an issue in the Docile repo.
— Mike
On Friday, 9 January 2015 16:49:53
Docile.jl works great. With Lexicon (or base Julia 0.4dev), you get nice
REPL help.
Mkdocs (http://mkdocs.org) works great for taking Markdown from Docile
output along with other Markdown files to make online documentation. Mkdocs
is super easy and works great with Github Pages. It also works
I'm experimenting with using Docile/Lexicon. Somehow i understood how to
add documentation. But is there somewhere also something like a style
guide, what to document?
Hi,
I had a look at your package: very nice indeed! It is not clear to me
where the actual documentation is though. I followed some links to source
code and there was no documentation in there…
Petr
On Saturday, January 10, 2015 at 8:35:24 AM UTC-8, tshort wrote:
Docile.jl works great.
Sorry, it's hidden in a branch (again, a work in progress):
* https://github.com/tshort/Sims.jl/tree/mkdocs
Here is the documentation directory with the static markdown files and the
markdown files generated from Docile:
* https://github.com/tshort/Sims.jl/tree/mkdocs/docs
Compare the input
Also, the links to source code don't work (I think) because I'm working on
a branch. They should work once I merge to master.
The only issue I found with Mkdocs was with syntax highlighting. Just a bit
of googling, though. I had to use the codehighlight extension that uses
Pygments. I also needed
Hi Jan,
If you run into any problems or have any suggestions for improvements feel
free to open an issue in the Docile repo.
— Mike
On Friday, 9 January 2015 16:49:53 UTC+2, Ján Dolinský wrote:
Thanks a lot. I'll check it out.
Jan
Dňa piatok, 9. januára 2015 10:53:10 UTC+1 Tim Holy
arg, the hazards of replying to a big batch of emails without checking what's
come in since the initial check...
--Tim
On Friday, January 09, 2015 01:26:55 AM ele...@gmail.com wrote:
On Friday, January 9, 2015 at 7:08:03 PM UTC+10, Ivar Nesje wrote:
Compat.jl doesn't have doc, but there is a
A help/doc system is in place in 0.4 (unstable) which allows to do that
(although no documentation about it yet...). It has not been backported
to 0.3 (yet?). But I guess you could use Compat.jl and start
documenting and have it all in place once 0.4 is released.
On Fri, 2015-01-09 at 09:41,
Compat.jl doesn't have doc, but there is a package that is reported to do this
for 0.3. I think it was Doctile.jl, but I might remember wrong.
Hi,
I would like to know how to write a help (comment) text e.g. for a module
function so that once module is loaded it is displayed if in REPL help mode.
E.g. for sum function
help?sum
displays brief help text for sum
Thanks,
Jan
If you're running julia 0.3, see the Docile package. If you're running julia
0.4, there's some in-progress documentation here:
https://github.com/JuliaLang/julia/pull/9447
--Tim
On Friday, January 09, 2015 12:41:33 AM Ján Dolinský wrote:
Hi,
I would like to know how to write a help
On Friday, January 9, 2015 at 7:08:03 PM UTC+10, Ivar Nesje wrote:
Compat.jl doesn't have doc, but there is a package that is reported to do
this for 0.3. I think it was Doctile.jl, but I might remember wrong.
See https://github.com/JuliaLang/julia/pull/9447 for first pass at
Thanks a lot. I'll check it out.
Jan
Dňa piatok, 9. januára 2015 10:53:10 UTC+1 Tim Holy napísal(-a):
If you're running julia 0.3, see the Docile package. If you're running
julia
0.4, there's some in-progress documentation here:
https://github.com/JuliaLang/julia/pull/9447
--Tim
On
15 matches
Mail list logo
