From 208ff184051663502a6e24b85bbc38d426e05626 Mon Sep 17 00:00:00 2001 From: Brad Warren Date: Fri, 8 May 2026 13:59:22 -0700 Subject: [PATCH] remove readthedocs requirements files (#10639) as those with access can see [here](https://github.com/certbot/certbot/security/dependabot), dependabot recently got confused by our readthedocs.org.requirements.txt files my read of the situation looking at output like [this](https://github.com/certbot/certbot/actions/runs/25448194392/job/74658002711#step:3:72) is dependabot expects paths to local packages to be relative to the requirements file while readthedocs wants them to relative to the root of the repo. (i tested changing the paths to be relative to the requirements file and [readthedocs was not happy](https://app.readthedocs.org/projects/eff-certbot/builds/32592654/)) to deal with this, we could create a .github/dependabot.yaml file and set [exclude-paths](https://docs.github.com/en/code-security/reference/supply-chain-security/dependabot-options-reference#exclude-paths-), but it strikes me as even simpler and cleaner to just remove these files if possible our use of these readthedocs.org.requirements.txt files dates back to https://github.com/certbot/certbot/pull/261, long before readthedocs added its .readthedocs.yaml files which we much more recently adopted in https://github.com/certbot/certbot/pull/9762. inspired by the suggestions at https://github.com/readthedocs/readthedocs.org/issues/7258 to workaround the lack of support for constraints files, i took the approach of [customizing the build process](https://docs.readthedocs.com/platform/stable/build-customization.html) we luckily don't have to override any of the existing readthedocs build steps. for reference, the build process is described [here](https://docs.readthedocs.com/platform/stable/builds.html), however, if you compare the readthedocs build logs from [main](https://app.readthedocs.org/projects/eff-certbot/builds/32568259/) and [this branch](https://app.readthedocs.org/projects/eff-certbot/builds/32597332/), you'll see they are essentially identical in addition to the certbot build, i also triggered [acme](https://app.readthedocs.org/projects/acme-python/builds/32597344/) and [dns-cloudflare](https://app.readthedocs.org/projects/certbot-dns-cloudflare/builds/32597347/) builds from this branch which passed as well i personally think we can get away with just one review on this PR, but if the reviewer disagrees, by all means request a second one --- acme/.readthedocs.yaml | 16 +++++++--------- acme/readthedocs.org.requirements.txt | 13 ------------- certbot-dns-cloudflare/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-digitalocean/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-dnsimple/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-dnsmadeeasy/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-gehirn/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-google/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-linode/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-luadns/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-nsone/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-ovh/.readthedocs.yaml | 16 +++++++--------- certbot-dns-ovh/readthedocs.org.requirements.txt | 15 --------------- certbot-dns-rfc2136/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-route53/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot-dns-sakuracloud/.readthedocs.yaml | 16 +++++++--------- .../readthedocs.org.requirements.txt | 15 --------------- certbot/.readthedocs.yaml | 16 +++++++--------- certbot/readthedocs.org.requirements.txt | 14 -------------- 30 files changed, 105 insertions(+), 357 deletions(-) delete mode 100644 acme/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-cloudflare/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-digitalocean/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-dnsimple/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-dnsmadeeasy/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-gehirn/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-google/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-linode/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-luadns/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-nsone/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-ovh/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-rfc2136/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-route53/readthedocs.org.requirements.txt delete mode 100644 certbot-dns-sakuracloud/readthedocs.org.requirements.txt delete mode 100644 certbot/readthedocs.org.requirements.txt diff --git a/acme/.readthedocs.yaml b/acme/.readthedocs.yaml index 7a4797fe5..2100edc53 100644 --- a/acme/.readthedocs.yaml +++ b/acme/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: acme/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/acme/readthedocs.org.requirements.txt b/acme/readthedocs.org.requirements.txt deleted file mode 100644 index c872cdc58..000000000 --- a/acme/readthedocs.org.requirements.txt +++ /dev/null @@ -1,13 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e acme[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install acme[docs]" does not work as -# expected and "pip install -e acme[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme[docs] diff --git a/certbot-dns-cloudflare/.readthedocs.yaml b/certbot-dns-cloudflare/.readthedocs.yaml index 746a42d15..052cb36ab 100644 --- a/certbot-dns-cloudflare/.readthedocs.yaml +++ b/certbot-dns-cloudflare/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-cloudflare[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-cloudflare/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-cloudflare/readthedocs.org.requirements.txt b/certbot-dns-cloudflare/readthedocs.org.requirements.txt deleted file mode 100644 index ac9a27217..000000000 --- a/certbot-dns-cloudflare/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-cloudflare[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-cloudflare[docs]" does not work as -# expected and "pip install -e certbot-dns-cloudflare[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-cloudflare[docs] diff --git a/certbot-dns-digitalocean/.readthedocs.yaml b/certbot-dns-digitalocean/.readthedocs.yaml index 0ef84ccaa..cb1a28853 100644 --- a/certbot-dns-digitalocean/.readthedocs.yaml +++ b/certbot-dns-digitalocean/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-digitalocean[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-digitalocean/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-digitalocean/readthedocs.org.requirements.txt b/certbot-dns-digitalocean/readthedocs.org.requirements.txt deleted file mode 100644 index 66af301bd..000000000 --- a/certbot-dns-digitalocean/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-digitalocean[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-digitalocean[docs]" does not work as -# expected and "pip install -e certbot-dns-digitalocean[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-digitalocean[docs] diff --git a/certbot-dns-dnsimple/.readthedocs.yaml b/certbot-dns-dnsimple/.readthedocs.yaml index cd091b3bf..88253a298 100644 --- a/certbot-dns-dnsimple/.readthedocs.yaml +++ b/certbot-dns-dnsimple/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-dnsimple[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-dnsimple/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-dnsimple/readthedocs.org.requirements.txt b/certbot-dns-dnsimple/readthedocs.org.requirements.txt deleted file mode 100644 index 7fd38f972..000000000 --- a/certbot-dns-dnsimple/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-dnsimple[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-dnsimple[docs]" does not work as -# expected and "pip install -e certbot-dns-dnsimple[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-dnsimple[docs] diff --git a/certbot-dns-dnsmadeeasy/.readthedocs.yaml b/certbot-dns-dnsmadeeasy/.readthedocs.yaml index f5a92584b..da18e15f4 100644 --- a/certbot-dns-dnsmadeeasy/.readthedocs.yaml +++ b/certbot-dns-dnsmadeeasy/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-dnsmadeeasy[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-dnsmadeeasy/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-dnsmadeeasy/readthedocs.org.requirements.txt b/certbot-dns-dnsmadeeasy/readthedocs.org.requirements.txt deleted file mode 100644 index 384c53f2c..000000000 --- a/certbot-dns-dnsmadeeasy/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-dnsmadeeasy[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-dnsmadeeasy[docs]" does not work as -# expected and "pip install -e certbot-dns-dnsmadeeasy[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-dnsmadeeasy[docs] diff --git a/certbot-dns-gehirn/.readthedocs.yaml b/certbot-dns-gehirn/.readthedocs.yaml index 3a4e68b45..332099d39 100644 --- a/certbot-dns-gehirn/.readthedocs.yaml +++ b/certbot-dns-gehirn/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-gehirn[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-gehirn/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-gehirn/readthedocs.org.requirements.txt b/certbot-dns-gehirn/readthedocs.org.requirements.txt deleted file mode 100644 index ea9311980..000000000 --- a/certbot-dns-gehirn/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-gehirn[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-gehirn[docs]" does not work as -# expected and "pip install -e certbot-dns-gehirn[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-gehirn[docs] diff --git a/certbot-dns-google/.readthedocs.yaml b/certbot-dns-google/.readthedocs.yaml index 01937103c..67611e01b 100644 --- a/certbot-dns-google/.readthedocs.yaml +++ b/certbot-dns-google/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-google[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-google/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-google/readthedocs.org.requirements.txt b/certbot-dns-google/readthedocs.org.requirements.txt deleted file mode 100644 index 113e27b4c..000000000 --- a/certbot-dns-google/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-google[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-google[docs]" does not work as -# expected and "pip install -e certbot-dns-google[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-google[docs] diff --git a/certbot-dns-linode/.readthedocs.yaml b/certbot-dns-linode/.readthedocs.yaml index 73e5dd44c..97865168a 100644 --- a/certbot-dns-linode/.readthedocs.yaml +++ b/certbot-dns-linode/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-linode[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-linode/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-linode/readthedocs.org.requirements.txt b/certbot-dns-linode/readthedocs.org.requirements.txt deleted file mode 100644 index d3b89ccd5..000000000 --- a/certbot-dns-linode/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-linode[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-linode[docs]" does not work as -# expected and "pip install -e certbot-dns-linode[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-linode[docs] diff --git a/certbot-dns-luadns/.readthedocs.yaml b/certbot-dns-luadns/.readthedocs.yaml index 2012f9d99..e995d0645 100644 --- a/certbot-dns-luadns/.readthedocs.yaml +++ b/certbot-dns-luadns/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-luadns[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-luadns/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-luadns/readthedocs.org.requirements.txt b/certbot-dns-luadns/readthedocs.org.requirements.txt deleted file mode 100644 index c6346176f..000000000 --- a/certbot-dns-luadns/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-luadns[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-luadns[docs]" does not work as -# expected and "pip install -e certbot-dns-luadns[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-luadns[docs] diff --git a/certbot-dns-nsone/.readthedocs.yaml b/certbot-dns-nsone/.readthedocs.yaml index f02a7e033..737c067dd 100644 --- a/certbot-dns-nsone/.readthedocs.yaml +++ b/certbot-dns-nsone/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-nsone[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-nsone/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-nsone/readthedocs.org.requirements.txt b/certbot-dns-nsone/readthedocs.org.requirements.txt deleted file mode 100644 index 2c5a9f0cf..000000000 --- a/certbot-dns-nsone/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-nsone[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-nsone[docs]" does not work as -# expected and "pip install -e certbot-dns-nsone[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-nsone[docs] diff --git a/certbot-dns-ovh/.readthedocs.yaml b/certbot-dns-ovh/.readthedocs.yaml index bdc43ff6b..2b5558170 100644 --- a/certbot-dns-ovh/.readthedocs.yaml +++ b/certbot-dns-ovh/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-ovh[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-ovh/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-ovh/readthedocs.org.requirements.txt b/certbot-dns-ovh/readthedocs.org.requirements.txt deleted file mode 100644 index 8af3e3e1c..000000000 --- a/certbot-dns-ovh/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-ovh[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-ovh[docs]" does not work as -# expected and "pip install -e certbot-dns-ovh[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-ovh[docs] diff --git a/certbot-dns-rfc2136/.readthedocs.yaml b/certbot-dns-rfc2136/.readthedocs.yaml index d9af76592..66683678a 100644 --- a/certbot-dns-rfc2136/.readthedocs.yaml +++ b/certbot-dns-rfc2136/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-rfc2136[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-rfc2136/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-rfc2136/readthedocs.org.requirements.txt b/certbot-dns-rfc2136/readthedocs.org.requirements.txt deleted file mode 100644 index 20ca804af..000000000 --- a/certbot-dns-rfc2136/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-rfc2136[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-rfc2136[docs]" does not work as -# expected and "pip install -e certbot-dns-rfc2136[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-rfc2136[docs] diff --git a/certbot-dns-route53/.readthedocs.yaml b/certbot-dns-route53/.readthedocs.yaml index 511197768..73b5a6602 100644 --- a/certbot-dns-route53/.readthedocs.yaml +++ b/certbot-dns-route53/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-route53[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-route53/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-route53/readthedocs.org.requirements.txt b/certbot-dns-route53/readthedocs.org.requirements.txt deleted file mode 100644 index fa5bb660d..000000000 --- a/certbot-dns-route53/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-route53[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-route53[docs]" does not work as -# expected and "pip install -e certbot-dns-route53[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-route53[docs] diff --git a/certbot-dns-sakuracloud/.readthedocs.yaml b/certbot-dns-sakuracloud/.readthedocs.yaml index d99780fc9..3a3a940c6 100644 --- a/certbot-dns-sakuracloud/.readthedocs.yaml +++ b/certbot-dns-sakuracloud/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot -e certbot-dns-sakuracloud[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot-dns-sakuracloud/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot-dns-sakuracloud/readthedocs.org.requirements.txt b/certbot-dns-sakuracloud/readthedocs.org.requirements.txt deleted file mode 100644 index 7fc550891..000000000 --- a/certbot-dns-sakuracloud/readthedocs.org.requirements.txt +++ /dev/null @@ -1,15 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot-dns-sakuracloud[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install certbot-dns-sakuracloud[docs]" does not work as -# expected and "pip install -e certbot-dns-sakuracloud[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot --e certbot-dns-sakuracloud[docs] diff --git a/certbot/.readthedocs.yaml b/certbot/.readthedocs.yaml index e44786fdc..c2c68ea0d 100644 --- a/certbot/.readthedocs.yaml +++ b/certbot/.readthedocs.yaml @@ -9,8 +9,13 @@ build: os: ubuntu-22.04 tools: python: "3.11" - # You can also specify other tool versions: - + # You can also specify other tool versions + jobs: + post_install: + # Using a constraints file isn't natively supported. We use a + # post_install job with the following flags and method of invoking pip to + # most closely mimic the current default installation behavior. + - python -m pip install --exists-action=w --no-cache-dir -c tools/requirements.txt -e acme -e certbot[docs] # Build documentation in the "docs/" directory with Sphinx sphinx: @@ -24,10 +29,3 @@ sphinx: formats: - pdf - epub - -# Optional but recommended, declare the Python requirements required -# to build your documentation -# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html -python: - install: - - requirements: certbot/readthedocs.org.requirements.txt \ No newline at end of file diff --git a/certbot/readthedocs.org.requirements.txt b/certbot/readthedocs.org.requirements.txt deleted file mode 100644 index 11c007454..000000000 --- a/certbot/readthedocs.org.requirements.txt +++ /dev/null @@ -1,14 +0,0 @@ -# readthedocs.org gives no way to change the install command to "pip -# install -e certbot[docs]" (that would in turn install documentation -# dependencies), but it allows to specify a requirements.txt file at -# https://readthedocs.org/dashboard/letsencrypt/advanced/ (c.f. #259) - -# Although ReadTheDocs certainly doesn't need to install the project -# in --editable mode (-e), just "pip install .[docs]" does not work as -# expected and "pip install -e certbot[docs]" must be used instead - -# We also pin our dependencies for increased stability. - --c ../tools/requirements.txt --e acme --e certbot[docs]