summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorJordan Cook <jordan.cook@pioneer.com>2021-04-04 21:21:24 -0500
committerJordan Cook <jordan.cook@pioneer.com>2021-04-04 21:21:24 -0500
commit8ae34b76e045fdab57e95b01c66e86062169fde3 (patch)
tree03a63172be36da7ddf332ae909200a18aca87ef7 /CONTRIBUTING.md
parent0ef5121050e4eaf459a0e14b0b8511b01f63bb5c (diff)
downloadrequests-cache-8ae34b76e045fdab57e95b01c66e86062169fde3.tar.gz
Add Dockerfile + docker-compose config to make it easier to run the readthedocs build container
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md17
1 files changed, 7 insertions, 10 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index e3f7340..7410f5c 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -97,17 +97,14 @@ $ xdg-open docs/_build/index.html
### Readthedocs
Sometimes, there are differences in the Readthedocs build environment that can cause builds to
-succeed locally but fail remotely. To help debug this, you can use the Readthedocs Docker container
-(`readthedocs/build`) to perform the build. Example:
+succeed locally but fail remotely. To help debug this, you can use the
+[readthedocs/build](https://github.com/readthedocs/readthedocs-docker-images) container to build
+the docs. A configured build container is included in `docker-compose.yml` to simplify this.
+
+Run with:
```bash
-docker pull readthedocs/build
-docker run --rm -ti \
- -v (pwd):/home/docs/project \
- readthedocs/build \
- /bin/bash -c \
- "cd /home/docs/project \
- && pip3 install '.[docs,backends]' \
- && make -C docs html"
+docker-compose up -d --build
+docker exec readthedocs make all
```
## Pull Requests