gaurav
commented
3 years ago Looks good but the part I'm missing (or have missed) is how does the documentation get there (on a repeatable and/or automated mechanism, say upon or as part of a release, for example). If it isn't something I missed, is this going to come in a separate PR?
http://javadoc.io monitors the Maven Central repository (and detects any new versions published there within 24 hours, it claims) and pulls the documentation from there automatically. When we publish to Maven, we generate and upload a JAR file containing Javadocs; I think it pulls the documentation from there.
If not, what's the advantage over GitHub Pages hosted documentation?
The main advantage is that I don't have to figure out how to integrate the documentation generation into Maven -- we generate the documentation into target/apidocs, but I'm not sure when that happens in the packaging process or how to modify the pom.xml file to generate that documentation into docs/ instead (or to copy that directory into the docs/ directory once it has been generated). I tried searching for information on this, but most of the examples I could find involve publishing the Javadocs directly to the gh_pages branch. If we wanted to take that route, it would be easier to write it as a Github Action. I think Javadoc.io meets all our needs for now, but if you'd like the documentation to be generated into a docs/ directory as we currently do with phyx.js, I think we should open an issue for now and tackle it later.
hlapp
http://javadoc.io offers free Javadoc documentation hosting for projects in the Central Maven repository. This PR adds a badge that links to the JPhyloRef documentation on their site.