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

This commit is contained in:
Dominik Liebler
2019-02-25 22:15:04 +01:00
parent 8dd39599e7
commit 7e7cccab64
4 changed files with 10 additions and 5 deletions

View File

@@ -29,7 +29,7 @@ $ ./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:
@@ -37,6 +37,8 @@ Just run:
$ 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