diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-10 09:29:30 -0500 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-04-10 09:29:30 -0500 |
| commit | 76fb97de2c9cf27e36268f4ae7c23c535e954c19 (patch) | |
| tree | a9236b9997c3e312a9e19aff24101e9c09eac6d1 /CONTRIBUTING.md | |
| parent | f6a8f325b6cb1b4c4fab77c3860df2842ec5aaa2 (diff) | |
| download | requests-cache-76fb97de2c9cf27e36268f4ae7c23c535e954c19.tar.gz | |
Move readthedocs container to a separate docker-compose file
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7410f5c..72c7539 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,11 +99,12 @@ $ xdg-open docs/_build/index.html 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/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. +the docs. A configured build container is included in `docs/docker-compose.yml` to simplify this. Run with: ```bash -docker-compose up -d --build +# Optionally add --build to rebuild with updated dependencies +docker-compose -f docs/docker-compose.yml up -d docker exec readthedocs make all ``` |