From 7b72ed9d757cf2253f581943ebfb90d3109fee15 Mon Sep 17 00:00:00 2001 From: David Lord Date: Wed, 16 Oct 2024 12:10:38 -0700 Subject: [PATCH 1/4] update docs build --- .readthedocs.yaml | 6 +++++- docs/conf.py | 7 +++++-- docs/requirements.txt | 5 ++--- 3 files changed, 12 insertions(+), 6 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index af232107..e09c74ea 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -1,8 +1,12 @@ version: 2 +build: + os: ubuntu-24.04 + tools: + python: '3.12' python: install: + - requirements: requirements/docs.txt - method: pip path: . - - requirements: docs/requirements.txt sphinx: builder: dirhtml diff --git a/docs/conf.py b/docs/conf.py index fa839a4d..3167f069 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -13,13 +13,16 @@ master_doc = "index" extensions = [ "sphinx.ext.autodoc", + "sphinx.ext.extlinks", "sphinx.ext.intersphinx", "pallets_sphinx_themes", "sphinxcontrib.log_cabinet", - "sphinx_issues", ] +extlinks = { + "issue": ("https://github.com/pallets/markupsafe/issues/%s", "#%s"), + "pr": ("https://github.com/pallets/markupsafe/pull/%s", "#%s"), +} intersphinx_mapping = {"python": ("https://docs.python.org/3/", None)} -issues_github_path = "pallets/markupsafe" # HTML ----------------------------------------------------------------- diff --git a/docs/requirements.txt b/docs/requirements.txt index 7cad0cf8..21155ba6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,4 +1,3 @@ -Sphinx~=3.0.0 -Pallets-Sphinx-Themes~=1.2.3 +Sphinx~=8.1.0 +Pallets-Sphinx-Themes~=2.2.0 sphinxcontrib-log-cabinet~=1.0.1 -sphinx-issues~=1.2.0 From dcfdffa7d7bc8f165266d48368c946168b8e5b6d Mon Sep 17 00:00:00 2001 From: David Lord Date: Wed, 16 Oct 2024 12:50:52 -0700 Subject: [PATCH 2/4] update docs build --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e09c74ea..171a99b3 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,7 +5,7 @@ build: python: '3.12' python: install: - - requirements: requirements/docs.txt + - requirements: docs/requirements.txt - method: pip path: . sphinx: From 7ee787ecbf1e6caf9c331ef1b1d1cfddcb32d8a2 Mon Sep 17 00:00:00 2001 From: David Lord Date: Wed, 16 Oct 2024 13:43:30 -0700 Subject: [PATCH 3/4] update docs build --- requirements/docs.in | 1 - requirements/docs.txt | 59 ++++++++++++++++++------------------------- 2 files changed, 25 insertions(+), 35 deletions(-) diff --git a/requirements/docs.in b/requirements/docs.in index 7ec501b6..d68fcaee 100644 --- a/requirements/docs.in +++ b/requirements/docs.in @@ -1,4 +1,3 @@ Pallets-Sphinx-Themes Sphinx -sphinx-issues sphinxcontrib-log-cabinet diff --git a/requirements/docs.txt b/requirements/docs.txt index 8c86827b..b1e60ae3 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,65 +1,56 @@ -# SHA1:45c590f97fe95b8bdc755eef796e91adf5fbe4ea -# -# This file is autogenerated by pip-compile-multi -# To update, run: -# -# pip-compile-multi -# -alabaster==0.7.12 +# This file was autogenerated by uv via the following command: +# uv pip compile requirements/docs.in -o requirements/docs.txt +alabaster==1.0.0 # via sphinx -babel==2.9.1 +babel==2.16.0 # via sphinx -certifi==2021.10.8 +certifi==2024.8.30 # via requests -charset-normalizer==2.0.12 +charset-normalizer==3.4.0 # via requests -docutils==0.17.1 +docutils==0.21.2 # via sphinx -idna==3.3 +idna==3.10 # via requests -imagesize==1.3.0 +imagesize==1.4.1 # via sphinx -jinja2==3.0.3 +jinja2==3.1.4 # via sphinx -markupsafe==2.0.1 +markupsafe==3.0.1 # via jinja2 -packaging==21.3 +packaging==24.1 # via # pallets-sphinx-themes # sphinx -pallets-sphinx-themes==2.0.2 +pallets-sphinx-themes==2.2.0 # via -r requirements/docs.in -pygments==2.11.2 +pygments==2.18.0 # via sphinx -pyparsing==3.0.7 - # via packaging -pytz==2021.3 - # via babel -requests==2.27.1 +requests==2.32.3 # via sphinx snowballstemmer==2.2.0 # via sphinx -sphinx==4.4.0 +sphinx==8.1.3 # via # -r requirements/docs.in # pallets-sphinx-themes - # sphinx-issues + # sphinx-notfound-page # sphinxcontrib-log-cabinet -sphinx-issues==3.0.1 - # via -r requirements/docs.in -sphinxcontrib-applehelp==1.0.2 +sphinx-notfound-page==1.0.4 + # via pallets-sphinx-themes +sphinxcontrib-applehelp==2.0.0 # via sphinx -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx sphinxcontrib-log-cabinet==1.0.1 # via -r requirements/docs.in -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==2.0.0 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==2.0.0 # via sphinx -urllib3==1.26.8 +urllib3==2.2.3 # via requests From d762f0dbdaf8fbd4c3622d6efafea99c0036a443 Mon Sep 17 00:00:00 2001 From: David Lord Date: Wed, 16 Oct 2024 13:55:00 -0700 Subject: [PATCH 4/4] update docs build --- requirements/docs.txt | 62 +++++++++++++++++-------------------------- 1 file changed, 24 insertions(+), 38 deletions(-) diff --git a/requirements/docs.txt b/requirements/docs.txt index e48ec9a9..84e02176 100644 --- a/requirements/docs.txt +++ b/requirements/docs.txt @@ -1,70 +1,56 @@ -# -# This file is autogenerated by pip-compile with Python 3.7 -# by the following command: -# -# pip-compile docs.in -# -alabaster==0.7.13 +# This file was autogenerated by uv via the following command: +# uv pip compile docs.in -o docs.txt +alabaster==1.0.0 # via sphinx -babel==2.14.0 +babel==2.16.0 # via sphinx -certifi==2024.2.2 +certifi==2024.8.30 # via requests -charset-normalizer==3.3.2 +charset-normalizer==3.4.0 # via requests -docutils==0.19 +docutils==0.21.2 # via sphinx -idna==3.6 +idna==3.10 # via requests imagesize==1.4.1 # via sphinx -importlib-metadata==6.7.0 - # via - # pallets-sphinx-themes - # sphinx -jinja2==3.1.3 +jinja2==3.1.4 # via sphinx -markupsafe==2.1.4 +markupsafe==3.0.1 # via jinja2 -packaging==23.2 +packaging==24.1 # via # pallets-sphinx-themes # sphinx -pallets-sphinx-themes==2.0.3 +pallets-sphinx-themes==2.2.0 # via -r docs.in -pygments==2.17.2 +pygments==2.18.0 # via sphinx -pytz==2024.1 - # via babel -requests==2.31.0 +requests==2.32.3 # via sphinx snowballstemmer==2.2.0 # via sphinx -sphinx==5.3.0 +sphinx==8.1.3 # via # -r docs.in # pallets-sphinx-themes - # sphinx-issues + # sphinx-notfound-page # sphinxcontrib-log-cabinet -sphinx-issues==3.0.1 - # via -r docs.in -sphinxcontrib-applehelp==1.0.2 +sphinx-notfound-page==1.0.4 + # via pallets-sphinx-themes +sphinxcontrib-applehelp==2.0.0 # via sphinx -sphinxcontrib-devhelp==1.0.2 +sphinxcontrib-devhelp==2.0.0 # via sphinx -sphinxcontrib-htmlhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 # via sphinx sphinxcontrib-jsmath==1.0.1 # via sphinx sphinxcontrib-log-cabinet==1.0.1 # via -r docs.in -sphinxcontrib-qthelp==1.0.3 +sphinxcontrib-qthelp==2.0.0 # via sphinx -sphinxcontrib-serializinghtml==1.1.5 +sphinxcontrib-serializinghtml==2.0.0 # via sphinx -typing-extensions==4.7.1 - # via importlib-metadata -urllib3==2.0.7 +urllib3==2.2.3 # via requests -zipp==3.15.0 - # via importlib-metadata