What hosting services exist that allows free API documentation hosting? Think Tr
ID: 660827 • Letter: W
Question
What hosting services exist that allows free API documentation hosting? Think Travis for CI or Bintray for binaries, only for docs.
I am looking for a service that can help automate API documentation publishing -- we would like to publish docs as part of our continuous integration.
Ideally it should have all of the following, but a subset of these features is ok too:
should be free
has a reasonable amount of space for hosting the docs
integration with GitHub/Bitbucket is a plus - like Travis works for projects builds, but hosting the generated docs
has a Web API for uploading the docs, in which case we would use Travis or Jenkins to upload the docs upon a successful build
the API documentation we want to publish is for an open-source project
the type of documentation would be ScalaDoc for Scala, or JavaDoc for Java, but ideally it should allow uploading any kind of (HTML) docs
ideally, there should be no ads, or they should not be too intrusive
Explanation / Answer
How about Github Pages.
should be free: Yes.
has a reasonable amount of space for hosting the docs: effectively unlimited for docs; soft limit of 1GB per repo/100mb per file.
integration with GitHub/Bitbucket is a plus - like Travis works for projects builds, but hosting the generated docs: integrated with Github.
has a Web API for uploading the docs, in which case we would use Travis or Jenkins to upload the docs upon a successful build You can upload it through git commands - I don't know if you can use Jenkins or Travis to do so.
the type of documentation would be ScalaDoc for Scala, or JavaDoc for Java, but ideally it should allow uploading any kind of (HTML) docs: I've only used Markdown (md) files, but this SO question describes using Maven to upload JavaDocs.
ideally, there should be no ads, or they should not be too intrusive: ad-free
An example would be Wrye Bash's Help pages - the help pages source is hosted in a separate repo.
Related Questions
drjack9650@gmail.com
Navigate
Integrity-first tutoring: explanations and feedback only — we do not complete graded work. Learn more.