Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs to repo #188

Merged
merged 5 commits into from
Dec 10, 2018
Merged

Add docs to repo #188

merged 5 commits into from
Dec 10, 2018

Conversation

joelfrederico
Copy link
Contributor

This follows the Documenter.jl paradigm for creating docs. Right now, it's bare: only the usage section has been moved from the README.md into the docs. I can continue documenting if this is accepted and there is interest.

@joelfrederico
Copy link
Contributor Author

Some setup is necessary, see: https://juliadocs.github.io/Documenter.jl/stable/man/hosting/

@stevengj
Copy link
Contributor

stevengj commented Dec 8, 2018

Thanks, this looks good.

(The ZMQ.jl package was created before docstrings existed in Julia, much less Documenter.jl.)

@stevengj
Copy link
Contributor

stevengj commented Dec 8, 2018

I set up the public/private keys in the Travis and repo settings; does that make this ready to merge?

@joelfrederico
Copy link
Contributor Author

Almost! You'll also need to create a gh-pages branch for tracking doc history and then point the repo's GitHub.io docs to that branch. And also update the repo's byline with the github.io link.

@stevengj
Copy link
Contributor

stevengj commented Dec 8, 2018

The docs you linked says that the branch will be created automatically by deploydocs if needed?

@joelfrederico
Copy link
Contributor Author

It does say that, when I did that in my fork it didn't happen though and I had to make it manually. YMMV?

@stevengj stevengj merged commit 1d6de3f into JuliaInterop:master Dec 10, 2018
@joelfrederico
Copy link
Contributor Author

Awesome! At some point I may document things as I learn the lib.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants