build Sphinx documentation and use php -S to actually view it

Dominik Liebler · Dominik Liebler · commit 7e7cccab645c · 2019-02-25T22:15:04.000+01:00
diff --git a/Dockerfile b/Dockerfile
@@ -3,6 +3,7 @@ WORKDIR /app
 RUN apt-get update \
     && apt-get install -y libzip-dev wget git-core python-pip \
     && docker-php-ext-install zip \
-    && pip install Sphinx
+    && pip install Sphinx sphinx_rtd_theme
 ADD . /app
-CMD [ "make", "cs", "test" ]
+RUN cd /app && make cs test html
+CMD [ "php", "-S", "0.0.0.0:80", "-t", "_build/html" ]
diff --git a/Makefile b/Makefile
@@ -200,7 +200,7 @@ vendor: composer.phar
 	php composer.phar install
 
 cs: install
-	./vendor/bin/phpcs -p --standard=PSR2 --ignore=vendor .
+	./vendor/bin/phpcs -p --standard=PSR2 --ignore=vendor,_build .
 
-test: install cs
+test: install
 	./vendor/bin/phpunit
diff --git a/README.md b/README.md
@@ -29,14 +29,16 @@ $ ./vendor/bin/phpunit
 
 ## using Docker (optional)
 
-You can optionally run tests using [Docker for Mac, Windows or Linux](https://docs.docker.com/compose/install/).
+You can optionally build and browse the documentation using [Docker for Mac, Windows or Linux](https://docs.docker.com/compose/install/).
 
 Just run:
 
 ```bash
 $ docker-compose up
 ```
 
+Go to [http://localhost:8080/README.html](http://localhost:8080/README.html) to read the generated documentation.
+
 To only install the dependencies, use `docker-compose` like this:
 
 ```bash
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -4,5 +4,7 @@ services:
     build: 
       context: .
       dockerfile: Dockerfile
+    ports:
+      - "8080:80"
     volumes:
       - .:/app
