Adjust docs for github pages

* Renamed doc folder to docs * Added docs/.nojekyll file * Added docs/index.html with redirect to docs/html/index.html * Moved docs/Makefile to repository root (and adjusted it consistently with rest of SamsungSLAV repositories) * Moved docs/sphinx contents to docs/ directly * Changed build directory from docs/build to docs/ * Moved docs/docker/Dockerfile for building documentation to docs/Dockerfile directory for consistency with other SamsungSLAV repositories * Adjusted Makefile after directory changes We should always link to: samsungslav.github.io/muxpi/html/ NOT to: samsungslav.github.io/muxpi/ (which works, but due to redirect is not SEO-friendly) I had used this thread as reference: sphinx-doc/sphinx#3382 Change-Id: I782507b8cdf1ffbdc8a8825a1530b9977bef196b Signed-off-by: Alexander Mazuruk <[email protected]>
aalexanderr · Oct 22, 2018 · 48cc23b · 48cc23b
1 parent b39848e
commit 48cc23b
Show file tree

Hide file tree

Showing 29 changed files with 17 additions and 14 deletions.
diff --git a/doc/Makefile → Makefile b/doc/Makefile → Makefile
@@ -1,28 +1,31 @@
-DOC_DIR = sphinx
+DOC_DIR = docs
 DOCKER_IMAGE = muxpi-doc-image
 DOCKER_CONTAINER = muxpi-doc-container
 DOCKER_CONTAINER_WORKDIR = /doc
 
-.PHONY: all clean build-doc-html build-docker-image clean-doc clean-docker
+.PHONY: docs
+docs: docs-sphinx
 
-all: build-doc-html
+.PHONY: clean
+clean-docs: clean-docs-sphinx clean-docker-sphinx
 
-clean: clean-doc clean-docker
-
-build-doc-html: build-docker-image
+.PHONY: docs-sphinx
+docs-sphinx: docker-image-sphinx
 	docker run --rm=true \
 		--volume `pwd`:${DOCKER_CONTAINER_WORKDIR} \
 		--user `id -u $$USER`:`id -g $$USER` \
 		--name ${DOCKER_CONTAINER} ${DOCKER_IMAGE} \
 		make -C ${DOC_DIR} html
 
-build-docker-image:
-	docker build -t ${DOCKER_IMAGE} docker
+.PHONY: docker-image-sphinx
+docker-image-sphinx:
+	docker build -t ${DOCKER_IMAGE} ${DOC_DIR}
 
-clean-doc:
-	-rm -r ${DOC_DIR}/build
+clean-docs-sphinx:
+	-rm -r ${DOC_DIR}/html
+	-rm -r ${DOC_DIR}/doctrees
 
-clean-docker:
+clean-docker-sphinx:
 	-docker rm ${DOCKER_CONTAINER}
 	-docker rmi ${DOCKER_IMAGE}
 
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/doc/docker/Dockerfile → docs/Dockerfile b/doc/docker/Dockerfile → docs/Dockerfile
diff --git a/doc/sphinx/Makefile → docs/Makefile b/doc/sphinx/Makefile → docs/Makefile
@@ -1,12 +1,11 @@
 # Minimal makefile for Sphinx documentation
-#
 
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
 SPHINXPROJ    = MuxPi
 SOURCEDIR     = source
-BUILDDIR      = build
+BUILDDIR      = .
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -17,4 +16,4 @@ help:
 # 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)
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1 @@
+<meta http-equiv="refresh" content="0; url=./html/index.html" />
diff --git a/doc/sphinx/source/armbian.txt → docs/source/armbian.txt b/doc/sphinx/source/armbian.txt → docs/source/armbian.txt
diff --git a/doc/sphinx/source/conf.py → docs/source/conf.py b/doc/sphinx/source/conf.py → docs/source/conf.py
diff --git a/doc/sphinx/source/dut-setup.txt → docs/source/dut-setup.txt b/doc/sphinx/source/dut-setup.txt → docs/source/dut-setup.txt
diff --git a/doc/sphinx/source/hw-overview.txt → docs/source/hw-overview.txt b/doc/sphinx/source/hw-overview.txt → docs/source/hw-overview.txt
diff --git a/doc/sphinx/source/image/board-addon-left.png → docs/source/image/board-addon-left.png b/doc/sphinx/source/image/board-addon-left.png → docs/source/image/board-addon-left.png
diff --git a/...sphinx/source/image/board-addon-right.png → docs/source/image/board-addon-right.png b/...sphinx/source/image/board-addon-right.png → docs/source/image/board-addon-right.png
diff --git a/...phinx/source/image/board-addon-sample.png → docs/source/image/board-addon-sample.png b/...phinx/source/image/board-addon-sample.png → docs/source/image/board-addon-sample.png
diff --git a/...mage/board-bottom-standrad-connectors.png → ...mage/board-bottom-standrad-connectors.png b/...mage/board-bottom-standrad-connectors.png → ...mage/board-bottom-standrad-connectors.png
diff --git a/doc/sphinx/source/image/board-dypers.png → docs/source/image/board-dypers.png b/doc/sphinx/source/image/board-dypers.png → docs/source/image/board-dypers.png
diff --git a/doc/sphinx/source/image/board-eth.png → docs/source/image/board-eth.png b/doc/sphinx/source/image/board-eth.png → docs/source/image/board-eth.png
diff --git a/doc/sphinx/source/image/board-jumpers.png → docs/source/image/board-jumpers.png b/doc/sphinx/source/image/board-jumpers.png → docs/source/image/board-jumpers.png
diff --git a/...x/source/image/board-other-connectors.png → docs/source/image/board-other-connectors.png b/...x/source/image/board-other-connectors.png → docs/source/image/board-other-connectors.png
diff --git a/doc/sphinx/source/image/board-power.png → docs/source/image/board-power.png b/doc/sphinx/source/image/board-power.png → docs/source/image/board-power.png
diff --git a/doc/sphinx/source/image/board-r21.png → docs/source/image/board-r21.png b/doc/sphinx/source/image/board-r21.png → docs/source/image/board-r21.png
diff --git a/doc/sphinx/source/image/board-sd.png → docs/source/image/board-sd.png b/doc/sphinx/source/image/board-sd.png → docs/source/image/board-sd.png
diff --git a/...e/image/board-top-standard-connectors.png → ...e/image/board-top-standard-connectors.png b/...e/image/board-top-standard-connectors.png → ...e/image/board-top-standard-connectors.png
diff --git a/doc/sphinx/source/image/board-uart-rs232.png → docs/source/image/board-uart-rs232.png b/doc/sphinx/source/image/board-uart-rs232.png → docs/source/image/board-uart-rs232.png
diff --git a/doc/sphinx/source/image/board-uart.png → docs/source/image/board-uart.png b/doc/sphinx/source/image/board-uart.png → docs/source/image/board-uart.png
diff --git a/doc/sphinx/source/image/board-ui.png → docs/source/image/board-ui.png b/doc/sphinx/source/image/board-ui.png → docs/source/image/board-ui.png
diff --git a/doc/sphinx/source/image/board-usb.png → docs/source/image/board-usb.png b/doc/sphinx/source/image/board-usb.png → docs/source/image/board-usb.png
diff --git a/doc/sphinx/source/image/hw-overview.svg → docs/source/image/hw-overview.svg b/doc/sphinx/source/image/hw-overview.svg → docs/source/image/hw-overview.svg
diff --git a/doc/sphinx/source/index.txt → docs/source/index.txt b/doc/sphinx/source/index.txt → docs/source/index.txt
diff --git a/doc/sphinx/source/install-sw.txt → docs/source/install-sw.txt b/doc/sphinx/source/install-sw.txt → docs/source/install-sw.txt
diff --git a/doc/sphinx/source/project-overview.txt → docs/source/project-overview.txt b/doc/sphinx/source/project-overview.txt → docs/source/project-overview.txt
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		<meta http-equiv="refresh" content="0; url=./html/index.html" />