diff options
| author | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-03 11:09:18 -0600 |
|---|---|---|
| committer | Jordan Cook <jordan.cook@pioneer.com> | 2021-03-03 11:09:18 -0600 |
| commit | 9c6d158625819093c5b81afc712549b4b65cd693 (patch) | |
| tree | 5a0666fdb116a0e16780cd6f30c12cdcd091b223 /CONTRIBUTING.md | |
| parent | 9703b30673bf74a29117d496537d457006a837e1 (diff) | |
| download | requests-cache-9c6d158625819093c5b81afc712549b4b65cd693.tar.gz | |
Add instructions for building docs using Readthedocs Docker container
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 15 |
1 files changed, 15 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a55da2a..5647862 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,6 +63,21 @@ $ open docs/_build/index.html $ 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: +```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 '.[dev]' \ + && make -C docs html" +``` + ## Pull Requests Here are some general guidelines for submitting a pull request: |