Merge pull request #305 from simonswine/fix-sphinx-docs

Fix sphinx docs

Author: simonswine

docs/Dockerfile

@@ -1,10 +1,12 @@
 # Copyright Jetstack Ltd. See LICENSE for details.
-FROM python:3
+FROM python:3.6-stretch
 
 WORKDIR /site
 
+# ensure python and dependencies are installed
 RUN apt-get update && apt-get install -y python-enchant wbritish
 
+# install sphinx
 COPY requirements.txt .
 RUN pip install -r requirements.txt
 RUN mkdir -p venv/bin && ln -s $(which python) venv/bin/python && touch .venv

docs/Makefile

@@ -27,13 +27,14 @@ help:
 
 # Make the site's html in docker
 docker_html:
-	set -x; mkdir -p _build; \
-	docker build -t tarmakdocs:latest .; \
-	container=$$(docker create tarmakdocs:latest); \
-	git ls-files -z | xargs -0 tar -czvf - | docker cp - $$container:/site; \
-	docker start -a $$container; \
-	docker cp $$container:/site/_build .; \
-	docker rm $$container
+	# create sphinx image
+	$(eval IMAGE_ID := $(shell docker build -q .))
+	# start documentaion build
+	$(eval CONTAINER_ID := $(shell docker create $(IMAGE_ID)))
+	(git ls-files && git ls-files --others --exclude-standard) | tar cf -  -T - | docker cp - $(CONTAINER_ID):/site
+	docker start -a $(CONTAINER_ID)
+	docker cp $(CONTAINER_ID):/site/_build - | tar xf -
+	docker rm $(CONTAINER_ID)
 
 .venv:
 	virtualenv -p $(shell which python3) $(VENV_PATH)

docs/requirements.txt

@@ -1,5 +1,5 @@
-CommonMark==0.5.4
-Sphinx==1.6.3
-sphinx-rtd-theme==0.2.4
-sphinxcontrib-spelling==2.3.0
+recommonmark==0.4.0
+sphinx==1.7.5
+sphinx-rtd-theme==0.4.0
+sphinxcontrib-spelling==4.1.0
 sphinxcontrib-versioning==2.2.1