Skip to content

Commit f98d072

Browse files
chore: Use Docker Compose to host documentation locally (#1410)
Co-authored-by: Andre Hofmeister <[email protected]>
1 parent 8470afd commit f98d072

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

compose.yml

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
services:
2+
docs:
3+
image: python:3.8-alpine
4+
command: sh -c "pip install -r requirements.txt && mkdocs serve -a 0.0.0.0:8000"
5+
working_dir: /docs
6+
volumes:
7+
- ./:/docs
8+
ports:
9+
- 8000:8000

docs/contributing_docs.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,10 @@ We publish our documentation using Netlify.
1515
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-dotnet` root directory.
1616
* Once Python dependencies have been installed, run `mkdocs serve` to start a local auto-updating MkDocs server.
1717

18+
### Using Docker
19+
20+
The root of the project contains a `compose.yml` file. Simply run `docker compose up` and access the docs at: `http://localhost:8000`.
21+
1822
### PR preview deployments
1923

2024
Note that documentation for pull requests will automatically be published by Netlify as 'deploy preview'.

0 commit comments

Comments
 (0)