search

JuliaAstro / FITSIO.jl

Flexible Image Transport System (FITS) file support for Julia
http://juliaastro.org/FITSIO.jl/
MIT License
55 stars 29 forks source link

Add Documenter to build documentation #77

Closed TestSubjector closed 6 years ago

TestSubjector commented 6 years ago

TODO

kbarbary commented 6 years ago

Looking good so far! I guess me or @giordano will have to set up travis ssh keys, but perhaps that's better done after this PR is merged?

giordano commented 6 years ago

There is no rush to do it right now, but I'd do that before merging the PR, so that merge commit readily triggers building of the docs.

kbarbary commented 6 years ago

OK, I've set up the GitHub/Travis ssh keys for Documenter.

kbarbary commented 6 years ago

How's this going @TestSubjector? If you're short on time, we could do without adding the examples sections for the purpose of this PR.

TestSubjector commented 6 years ago

Yes, this way will work much better for me. I'll work on and make a new PR for the examples documentation, when things become a little less hectic on my side.

kbarbary commented 6 years ago

I guess this is ready to merge?

TestSubjector commented 6 years ago

All clear from my side 🏁

kbarbary commented 6 years ago

Looks like the docs build didn't succeed on Travis. I think we need a mkdocs.yml file: https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#The-MkDocs-mkdocs.yml-File-1 and also arguments deps and julia = "0.6" in the deploydocs() function in docs/make.jl.

giordano commented 6 years ago

Travis on GNU/Linux with nighly Julia is successful, maybe the problem is that the src/index.md file is actually empty?

kbarbary commented 6 years ago

Oh, that's probably not good either.

The travis job can succeed while the doc build fails, because docs are built after_success. Looking at the log here: https://travis-ci.org/JuliaAstro/FITSIO.jl/jobs/269730603#L3836