Skip to content

Commit fbf5092

Browse files
mikesir87rnorth
andcommitted
Add docker-compose.yml to simplify local doc development (#1653)
Co-Authored-By: Richard North <[email protected]>
1 parent bdb82b7 commit fbf5092

File tree

2 files changed

+16
-1
lines changed

2 files changed

+16
-1
lines changed

docker-compose.yml

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

docs/contributing_docs.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,11 @@ We publish our documentation using Netlify.
99

1010
## Previewing rendered content
1111

12-
### Previewing docs locally
12+
### Using Docker locally
13+
14+
The root of the project contains a `docker-compose.yml` file. Simply run `docker-compose up` and then access the docs at [http://localhost:8000](http://localhost:8000).
15+
16+
### Using Python locally
1317

1418
* Ensure that you have Python 3.6.0 or higher.
1519
* Set up a virtualenv and run `pip install -r requirements.txt` in the `testcontainers-java` root directory.

0 commit comments

Comments
 (0)