diff --git a/compose.yml b/compose.yml new file mode 100644 index 000000000..0f0a55963 --- /dev/null +++ b/compose.yml @@ -0,0 +1,9 @@ +services: + docs: + image: python:3.8-alpine + command: sh -c "pip install -r requirements.txt && mkdocs serve -a 0.0.0.0:8000" + working_dir: /docs + volumes: + - ./:/docs + ports: + - 8000:8000 \ No newline at end of file diff --git a/docs/contributing_docs.md b/docs/contributing_docs.md index 01e809629..e3c67d299 100644 --- a/docs/contributing_docs.md +++ b/docs/contributing_docs.md @@ -15,6 +15,10 @@ We publish our documentation using Netlify. * Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-dotnet` root directory. * Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server. +### Using Docker + +The root of the project contains a `compose.yml` file. Simply run `docker compose up` and access the docs at: `http://localhost:8000`. + ### PR preview deployments Note that documentation for pull requests will automatically be published by Netlify as 'deploy preview'.