Uwe, take a look here <http://www.stochasticlifestyle.com/finalizing-julia-package-documentation-testing-coverage-publishing/>. You can use mkdocs build then mkdocs serve to do so (I think serving will actually build the docs too so that might be redundant).
Glad to see this package announcement! It really is a spectacular documentation system and will really serve the Julia community. I hope that the GSoC student implements the documentation from tests <https://github.com/JuliaDocs/Documenter.jl/issues/55>since I still see a lot of Julia packages saying saying things similar to "to learn the package, take a look at the tests". I think that if we start generating tutorials/examples directly from these tests, add them to this documentation system which pulls everything from docstrings, and allow it to generate parts of the Github README, we will be in a heaven of "documentation which is generated from the actual tested code and thus up to date". On Friday, June 17, 2016 at 6:50:23 AM UTC-7, Uwe Fechner wrote: > > Hello, > > I installed Documenter and followed the tutorial. Now I would like to > convert the documentation in html WITHOUT deploying > it to github. How can I do this? > > Uwe > > On Friday, June 17, 2016 at 11:07:26 AM UTC+2, Michael Hatherly wrote: >> >> I’m please to announce the initial release of Documenter.jl >> <https://github.com/JuliaDocs/Documenter.jl> — a documentation generator >> for Julia. >> >> The package docs are here >> <https://juliadocs.github.io/Documenter.jl/stable>. >> >> The package is still a work-in-progress, but now has sufficient features >> to make a stable release worth while. Major breaking changes should >> hopefully be few and far between from now on. >> >> If you have already been making use of the package, which quite a few of >> the community have been, then I’d would like to extend my thanks to you for >> helping file bug reports, feature requests, and pull requests. >> >> Please do upgrade your .travis.yml configuration to reflect the fact >> that Documenter is now tagged and available from METADATA. All that >> should be needed is to replace either >> >> Pkg.clone("https://github.com/MichaelHatherly/Documenter.jl";) >> >> or, more recently, >> >> Pkg.clone("https://github.com/JuliaDocs/Documenter.jl";) >> >> with >> >> Pkg.add("Documenter") >> >> and your build scripts should work fine. Any problems you happen to run >> into should, as always, be reported on the GitHub issue tracker >> <https://github.com/JuliaDocs/Documenter.jl/issues>. master will be more >> unstable from this point on. >> >> If you do have a publicly available package that is making use of >> Documenter, then please do add a link to the Examples >> <https://juliadocs.github.io/Documenter.jl/stable/man/examples/> page if >> you’d like. >> >> Finally: I’d like to thank one of our Google Summer of Code students, >> Morten Piibeleht, who is developing some great new features for the package >> over the summer. >> >> — Mike >> >> >> >>
