Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions compose.yml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions docs/contributing_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
Expand Down