Generate documentation
Leonidas-from-XIV opened this issue · 11 comments
It would be good to automatically generate API documentation on https://issuu.github.io/ocaml-zmq. I am not sure what the best way for doing so is now in 2018, so I'd very much appreciate input on what to check out. The best way would be if it could be somehow automatically split into master vs release tags.
My main priority would be that it can be somehow automated so it is not easy to forget.
$ jbuilder build @doc works if you have odoc. However, things aren't completely ideal at the moment as attaching your mld's isn't as straightforward as I'd like.
We could use something like this which is roughly based on what cohttp used to use. It'll generate and push the documentation. It may not be perfect but it will provide an odoc-rendered version for users to refer to.
@simonellefsen , can you help in enabling gh-pages for the ocaml-zmq project?
(https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages)
Is there anything the rest of us can do to help with this?
gh-pages is already enabled according to the setting - so not sure what to do next
That's very strange - I would have expected that to work. Thanks anyways.
I wrote github support, and they have fixed the problem. For some reason the site had not been build, so they triggered a build manually. It works now: https://issuu.github.io/ocaml-zmq
I took the liberty to update the documentation. We should add a link from the readme file.
It may also be worth adding a link from the project description - that way there's an immediate path to both the upstream library and the binding documentation.
#73 adds links to the documentation. Closing