Merge pull request #122 from vapor-ware/rtd-docs

add readthedocs hosted documentation
vapor-ware · Apr 5, 2018 · 039c8f6 · 039c8f6
2 parents 892e91e + 940d897
commit 039c8f6
Show file tree

Hide file tree

Showing 35 changed files with 1,371 additions and 1,711 deletions.
diff --git a/.gitignore b/.gitignore
@@ -79,4 +79,4 @@ ENV/
 *.rpm
 *.deb
 
-!docs/*
+docs/build
diff --git a/Makefile b/Makefile
@@ -79,13 +79,14 @@ docker: docker-default docker-slim ## Build the docker image for Synse Server lo
 
 .PHONY: api-doc
 api-doc: ## Open the API doc HTML reference
-	open ./docs/index.html
-
-.PHONY: build-docs
-build-docs: ## Generate the API docs for Synse Server
-	docker build -f docs/build/Dockerfile -t vaporio/slate-docs docs/build
-	docker run --name slate-docs -v `pwd`/docs/build/src:/source vaporio/slate-docs
-	docker cp slate-docs:/slate/build/. docs
+	open ./docs/api/build/index.html
+
+.PHONY: docs
+docs: ## Generate the Synse Server documentation locally
+	docker build -f docs/Dockerfile -t vaporio/slate-docs docs
+	@if [ -d "docs/api/build" ]; then rm -rf docs/api/build; fi;
+	docker run --name slate-docs -v `pwd`/docs/api:/source vaporio/slate-docs
+	docker cp slate-docs:/slate/build/. docs/api/build
 	docker rm slate-docs
 
 .PHONY: lint
@@ -151,6 +152,6 @@ version: ## Print the version of Synse Server
 
 .PHONY: help
 help:  ## Print Make usage information
-	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-15s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
+	@awk 'BEGIN {FS = ":.*?## "} /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-16s\033[0m %s\n", $$1, $$2}' $(MAKEFILE_LIST) | sort
 
 .DEFAULT_GOAL := help
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ that lets you perform aggregations/operations over multiple devices easily.
 If you're looking for an integration, check out [synse-prometheus][prometheus]. You'll be
 able to put together complete monitoring and dashboard solution from the instructions there.
 
-Additional documentation may be found on the [Docs][docs] site.
+For more information, see the [API Documentation][api-docs] or the [User Guide][user-guide].
 
 ### Architecture
 
@@ -387,8 +387,8 @@ to happen when switching between the two modes of testing.
 ## License
 Synse is released under GPLv2 - see [LICENSE](LICENSE) for more information.
 
-
-[docs]: http://opendcre.com
+[api-docs]: https://vapor-ware.github.io/synse-server/
+[user-guide]: http://synse-server.readthedocs.io/en/latest/
 [cli]: https://github.com/vapor-ware/synse-cli
 [prometheus]: https://github.com/vapor-ware/synse-prometheus
 [graphql]: https://github.com/vapor-ware/synse-graphql

diff --git a/docs/build/Dockerfile → docs/Dockerfile b/docs/build/Dockerfile → docs/Dockerfile
diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = SynseServer
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/build/src/images/logo.png → docs/api/images/logo.png b/docs/build/src/images/logo.png → docs/api/images/logo.png
diff --git a/docs/build/src/index.html.md → docs/api/index.html.md b/docs/build/src/index.html.md → docs/api/index.html.md
diff --git a/docs/fonts/slate.eot b/docs/fonts/slate.eot
diff --git a/docs/fonts/slate.svg b/docs/fonts/slate.svg
diff --git a/docs/fonts/slate.ttf b/docs/fonts/slate.ttf
diff --git a/docs/fonts/slate.woff b/docs/fonts/slate.woff
diff --git a/docs/fonts/slate.woff2 b/docs/fonts/slate.woff2
diff --git a/docs/images/navbar.png b/docs/images/navbar.png