Closed lgauthier closed 7 years ago
Suggestion: Build using github-pages.
master
should trigger a travis build step that generates docs and pushes them to a gh-pages
branch.docs.metova.com
. Any other repos with pages will then be automatically hosted at docs.metova.com/repo-name
.
Ever since the end of May this year, CocoaDocs no longer generates and hosts documentation for newly submitted pod versions. Read more here.
We need to figure out a simple way of generating and hosting documentation for new versions ourselves. Generating the documentation is fairly simple--we can just use jazzy, which is the tool CocoaDocs used. The trickier parts that we need to address are:
I've looked into it a little bit so far, and I think we could potentially simply host our docs within our GitHub repo to make publishing new docs easy, but we'd want to automate this process. You can check out the branch I've started to see what I've done so far:
So far, the main problems with what I've done on that branch are:
jazzy
each time before submitting a new version.