From 8ae34b76e045fdab57e95b01c66e86062169fde3 Mon Sep 17 00:00:00 2001 From: Jordan Cook Date: Sun, 4 Apr 2021 21:21:24 -0500 Subject: Add Dockerfile + docker-compose config to make it easier to run the readthedocs build container --- CONTRIBUTING.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'CONTRIBUTING.md') 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 -- cgit v1.2.1