Skip to content
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

Merged
merged 8 commits into from
Nov 16, 2018
Merged

Adds docs #35

merged 8 commits into from
Nov 16, 2018

Conversation

morris25
Copy link
Contributor

No description provided.

src/Example.jl Outdated Show resolved Hide resolved
@nalimilan
Copy link
Member

Thanks. Could you also add the code needed to deploy the docs to GitHub to .travis.yml?

docs/make.jl Outdated Show resolved Hide resolved
Copy link
Member

@nalimilan nalimilan left a 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.

@morris25
Copy link
Contributor Author

Thanks for catching my mistakes. I must've been more distracted than I thought that day.

@KristofferC
Copy link
Member

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.

@morris25
Copy link
Contributor Author

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.

@ararslan
Copy link
Member

Done.

docs/make.jl Outdated Show resolved Hide resolved
.gitignore Show resolved Hide resolved
@nalimilan
Copy link
Member

@ararslan Can you enable Travis on this repo too?

@ararslan
Copy link
Member

ararslan commented Nov 1, 2018

Can you enable Travis on this repo too?

Done. It looks like it used to be enabled but got turned off at some point.

@ararslan ararslan closed this Nov 1, 2018
@ararslan ararslan reopened this Nov 1, 2018
@ararslan
Copy link
Member

ararslan commented Nov 1, 2018

It shares the JuliaLang Travis queue so the builds will not be fast.

@fredrikekre
Copy link
Member

Maybe disable 0.7 and nightly and only run 0.6 and 1.0?

@ararslan
Copy link
Member

ararslan commented Nov 1, 2018

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.

@morris25
Copy link
Contributor Author

Is there anything else that needs to be fixed on this?

@fredrikekre fredrikekre merged commit 66607a6 into JuliaLang:master Nov 16, 2018
@ararslan ararslan deleted the sm/add-docs branch November 16, 2018 20:55
@cecileane
Copy link

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.

@nalimilan
Copy link
Member

Good catch, I've tagged a new version.

@vchuravy vchuravy mentioned this pull request Jul 16, 2019
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants