Add necessary Documenter.jl files #29
Conversation
|
Sorry I'm slow on this! Is it possible for me to give you the necessary permissions here? |
|
No rush on my end - the blocking step would be adding a deploy key (for Travis) to the repository, which can only be done by the repository owner AFAIK. |
.travis.yml
Outdated
| - julia -e 'cd(Pkg.dir("AxisArrays")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())' | ||
| - julia -e 'cd(Pkg.dir("AxisArrays")); Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())' | ||
| - julia -e 'Pkg.add("Documenter")' | ||
| - julia -e 'cd(Pkg.dir("AxisArrays")); include(joinpath("doc", "make.jl"))' |
There was a problem hiding this comment.
"doc" -> "docs" will need to be changed here too (https://travis-ci.org/mbauman/AxisArrays.jl/jobs/140622570#L464)
There was a problem hiding this comment.
👍 thanks! I think I got all the keys set up now, too, so we'll see if it works after this push. If you'd prefer, I can now move the folder back, but the Documenter setup tasks seemed to assume this layout… so this was the path of least resistance.
There was a problem hiding this comment.
Changing it makes sense, best to stick with the Documenter defaults unless there's a reason to deviate I think.
This reverts commit dc11dd1.
|
Hm, I don't think that last step is necessary (it errors and other packages don't seem to do it). I think this just needs to be on master for it to work now — Documenter.jl simply reports "skipping deployment". Ready to merge? |
|
For sure! 👍 |
|
Lots of room for improvement, but it's a start: http://mbauman.github.io/AxisArrays.jl/latest/ |
Adds in the files necessary for implementing Documenter.jl. @mbauman will still need to do two steps (#1, #2) before it's up and running.
For now I just set the doc site homepage to have the same content as the README and created a second auto-generated reference page to display the package's docstrings - this can no doubt be improved on moving forward.