Add support for API docs generation to HTML format.
Project: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/commit/146a46cc Tree: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/tree/146a46cc Diff: http://git-wip-us.apache.org/repos/asf/incubator-usergrid/diff/146a46cc Branch: refs/heads/ug2-doc-update Commit: 146a46cc1673e18c621200ac7dd5baef74ab92bd Parents: acae959 Author: Dave Johnson <snoopd...@apache.org> Authored: Tue Aug 4 08:26:56 2015 -0400 Committer: Dave Johnson <snoopd...@apache.org> Committed: Tue Aug 4 08:26:56 2015 -0400 ---------------------------------------------------------------------- docs/README.md | 4 +- docs/asset-and-files/tbd.md | 2 +- docs/geolocation/tbd.md | 2 +- docs/orgs-and-apps/tbd.md | 2 +- docs/push-notifications/tbd.md | 2 +- docs/rest-endpoints/api-docs.css | 29 + docs/rest-endpoints/api-docs.html | 5867 ++++++++++++++++++ docs/rest-endpoints/api-docs.md | 2326 ++++--- docs/sdks/tbd.md | 2 +- docs/src/main/groovy/ApiDocGenerator.groovy | 176 - .../main/groovy/usergrid/ApiDocGenerator.groovy | 278 + docs/src/main/resources/file-end-html.mustache | 13 + .../src/main/resources/file-start-html.mustache | 21 + docs/src/main/resources/model-html.mustache | 38 + docs/src/main/resources/operation-html.mustache | 43 + docs/src/main/resources/usergrid-swagger.yaml | 2 +- docs/user-management/tbd.md | 2 +- 17 files changed, 7648 insertions(+), 1161 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/README.md ---------------------------------------------------------------------- diff --git a/docs/README.md b/docs/README.md index 204e90d..9f65b40 100644 --- a/docs/README.md +++ b/docs/README.md @@ -53,7 +53,7 @@ If you need to update the REST API docs, you should edit the usergrid-swagger.ya If you need to change the formatting of the REST API docs, then you will need to edit the Mustache templates in ``src/main/resource`` and you may need to edit the Groovy script that does the -generation: ``src/main/groovy/ApiDocGenerator``. +generation: ``src/main/groovy/usergrid.ApiDocGenerator``. You will need: * Groovy 2.x @@ -63,7 +63,7 @@ Unfortunately, you will have to Git Clone Mustatche.java before you can run the This is the command to run the generation: - groovy src/main/groovy/ApiDocGenerator.groovy + groovy src/main/groovy/usergrid.ApiDocGenerator.groovy The script will update the file ``rest-endpoints/api-docs.md`` and when you are happy with your update you should commit and push that file with Git. http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/asset-and-files/tbd.md ---------------------------------------------------------------------- diff --git a/docs/asset-and-files/tbd.md b/docs/asset-and-files/tbd.md index f65681d..279d128 100644 --- a/docs/asset-and-files/tbd.md +++ b/docs/asset-and-files/tbd.md @@ -1 +1 @@ -# Coming soon... \ No newline at end of file +# COMING SOON... \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/geolocation/tbd.md ---------------------------------------------------------------------- diff --git a/docs/geolocation/tbd.md b/docs/geolocation/tbd.md index f65681d..279d128 100644 --- a/docs/geolocation/tbd.md +++ b/docs/geolocation/tbd.md @@ -1 +1 @@ -# Coming soon... \ No newline at end of file +# COMING SOON... \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/orgs-and-apps/tbd.md ---------------------------------------------------------------------- diff --git a/docs/orgs-and-apps/tbd.md b/docs/orgs-and-apps/tbd.md index f65681d..279d128 100644 --- a/docs/orgs-and-apps/tbd.md +++ b/docs/orgs-and-apps/tbd.md @@ -1 +1 @@ -# Coming soon... \ No newline at end of file +# COMING SOON... \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/push-notifications/tbd.md ---------------------------------------------------------------------- diff --git a/docs/push-notifications/tbd.md b/docs/push-notifications/tbd.md index f65681d..279d128 100644 --- a/docs/push-notifications/tbd.md +++ b/docs/push-notifications/tbd.md @@ -1 +1 @@ -# Coming soon... \ No newline at end of file +# COMING SOON... \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-usergrid/blob/146a46cc/docs/rest-endpoints/api-docs.css ---------------------------------------------------------------------- diff --git a/docs/rest-endpoints/api-docs.css b/docs/rest-endpoints/api-docs.css new file mode 100644 index 0000000..e9a2087 --- /dev/null +++ b/docs/rest-endpoints/api-docs.css @@ -0,0 +1,29 @@ + + +.panel-default > .panel-heading.GET{ + background-color: rgba(54, 180, 255, 0.42); + background-image: none; +} +.panel-default > .panel-heading.POST { + background-color: rgba(0, 128, 0, 0.38); + background-image: none; +} +.panel-default > .panel-heading.PUT{ + background-color: rgba(255, 165, 0, 0.41); + background-image: none; +} +.panel-default > .panel-heading.DELETE { + background-color: rgba(255, 0, 0, 0.29); + background-image: none; +} + +.panel-heading a.collapse-button:after { + font-family:'Glyphicons Halflings'; + content:"\e114"; + float: right; + color: grey; +} +.panel-heading a.collapse-button.collapsed:after { + content:"\e080"; +} +
