From f1d4387a73105d5b2032da18f06365f39ce0e4a1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 Aug 2024 23:54:39 +0000 Subject: [PATCH 1/4] Bump sphinx from 7.4.7 to 8.0.2 Bumps [sphinx](https://github.com/sphinx-doc/sphinx) from 7.4.7 to 8.0.2. - [Release notes](https://github.com/sphinx-doc/sphinx/releases) - [Changelog](https://github.com/sphinx-doc/sphinx/blob/v8.0.2/CHANGES.rst) - [Commits](https://github.com/sphinx-doc/sphinx/compare/v7.4.7...v8.0.2) --- updated-dependencies: - dependency-name: sphinx dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 87f2c1911f6..21da7ac6505 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,4 +1,4 @@ -sphinx==7.4.7 +sphinx==8.0.2 furo==2024.7.18 furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1 sphinx-paramlinks==0.6.0 From 99eb4a25e7232e556108e9a02b270d98747c47a3 Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Sat, 3 Aug 2024 00:37:09 -0400 Subject: [PATCH 2/4] Mention python 3.10 for docs --- .github/CONTRIBUTING.rst | 2 +- .github/workflows/docs.yml | 2 +- docs/source/conf.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 63906fabd6f..b64a368ac43 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -210,7 +210,7 @@ doc strings don't have a separate documentation site they generate, instead, the User facing documentation ------------------------- -We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.9 or above and have the required dependencies installed as explained above. +We use `sphinx`_ to generate static HTML docs. To build them, first make sure you're running Python 3.10 or above and have the required dependencies installed as explained above. Then, run the following from the PTB root directory: .. code-block:: bash diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 73e123e17ea..49d2a26c7bf 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,7 +14,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: [3.9] + python-version: [3.10] os: [ubuntu-latest] fail-fast: False steps: diff --git a/docs/source/conf.py b/docs/source/conf.py index fdc3b27e857..abad78812c6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -30,7 +30,7 @@ release = telegram.__version__ # If your documentation needs a minimal Sphinx version, state it here. -needs_sphinx = "6.1.3" +needs_sphinx = "8.0.2" # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom From 57c5ac77929546402b05837fefa63a296ae8349e Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Sat, 3 Aug 2024 00:38:25 -0400 Subject: [PATCH 3/4] use quotes --- .github/workflows/docs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 49d2a26c7bf..b6a92ffdba8 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -14,7 +14,7 @@ jobs: runs-on: ${{matrix.os}} strategy: matrix: - python-version: [3.10] + python-version: ['3.10'] os: [ubuntu-latest] fail-fast: False steps: From 25b9047da04814606fe9264c47efa20908342e3b Mon Sep 17 00:00:00 2001 From: Harshil <37377066+harshil21@users.noreply.github.com> Date: Tue, 6 Aug 2024 20:46:21 -0400 Subject: [PATCH 4/4] Bump furo --- docs/requirements-docs.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index 21da7ac6505..7c3a4239807 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -1,5 +1,5 @@ sphinx==8.0.2 -furo==2024.7.18 +furo==2024.8.6 furo-sphinx-search @ git+https://github.com/harshil21/furo-sphinx-search@v0.2.0.1 sphinx-paramlinks==0.6.0 sphinxcontrib-mermaid==0.9.2