-
-
Notifications
You must be signed in to change notification settings - Fork 129
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Adds docs #35
Adds docs #35
Conversation
Thanks. Could you also add the code needed to deploy the docs to GitHub to .travis.yml? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, looks good to me. We could enable Travis on the repo to check that it works, but maybe that's overkill.
Thanks for catching my mistakes. I must've been more distracted than I thought that day. |
We should probably use the Documenter.jl recommended way of doing this https://juliadocs.github.io/Documenter.jl/stable/man/hosting/#.travis.yml-Configuration-1. |
I'll note that adding the ssh keys will probably have to be done by one of the package owners for the deployment to work. |
Done. |
@ararslan Can you enable Travis on this repo too? |
Done. It looks like it used to be enabled but got turned off at some point. |
It shares the JuliaLang Travis queue so the builds will not be fast. |
Maybe disable 0.7 and nightly and only run 0.6 and 1.0? |
That would certainly be kinder on CI, but this is intended to be an example for others to craft their packages, so restricting the CI builds because it's annoying in the JuliaLang org seems unfortunate. |
Is there anything else that needs to be fixed on this? |
The badge to the stable doc gives a 404 "file not found" error, probably because there hasn't been a release since the addition of docs built by Documenter. Making a new release could fix this issue. |
Good catch, I've tagged a new version. |
No description provided.