GeezerVison

The World Wide Web, restored to 800 pixels of glory.

GeezerVison is showing github.com — [3.11] GH-103903: Test the minimum Sphinx version in CI (#103904) (#1… · python/cpython@dbc44fa

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

.github/workflows
- doc.yml
Doc
- Makefile
- library
  - sqlite3.rst
- requirements-oldest-sphinx.txt

Expand file treeCollapse file tree

Open diff view settings

Collapse file

`‎.github/workflows/doc.yml‎`

Copy file name to clipboardExpand all lines: .github/workflows/doc.yml

+20Lines changed: 20 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -59,6 +59,26 @@ jobs:`
`59`	`59`	`name: doc-html`
`60`	`60`	`path: Doc/build/html`
`61`	`61`
	`62`	`+ # This build doesn't use problem matchers or check annotations`
	`63`	`+ # It also does not run 'make check', as sphinx-lint is not installed into the`
	`64`	`+ # environment.`
	`65`	`+ build_doc_oldest_supported_sphinx:`
	`66`	`+ name: 'Docs (Oldest Sphinx)'`
	`67`	`+ runs-on: ubuntu-latest`
	`68`	`+ timeout-minutes: 60`
	`69`	`+ steps:`
	`70`	`+ - uses: actions/checkout@v3`
	`71`	`+ - name: 'Set up Python'`
	`72`	`+ uses: actions/setup-python@v4`
	`73`	`+ with:`
	`74`	`+ python-version: '3.11' # known to work with Sphinx 3.2`
	`75`	`+ cache: 'pip'`
	`76`	`+ cache-dependency-path: 'Doc/requirements-oldest-sphinx.txt'`
	`77`	`+ - name: 'Install build dependencies'`
	`78`	`+ run: make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt"`
	`79`	`+ - name: 'Build HTML documentation'`
	`80`	`+ run: make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html`
	`81`	`+`
`62`	`82`	`# Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release`
`63`	`83`	`doctest:`
`64`	`84`	`name: 'Doctest'`

Collapse file

`‎Doc/Makefile‎`

Copy file name to clipboardExpand all lines: Doc/Makefile

+3-2Lines changed: 3 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@ JOBS = auto`
`13`	`13`	`PAPER =`
`14`	`14`	`SOURCES =`
`15`	`15`	`DISTVERSION = $(shell $(PYTHON) tools/extensions/patchlevel.py)`
	`16`	`+REQUIREMENTS = requirements.txt`
`16`	`17`	`SPHINXERRORHANDLING = -W`
`17`	`18`
`18`	`19`	`# Internal variables.`
`@@ -154,8 +155,8 @@ venv:`
`154`	`155`	echo "To recreate it, remove it first with \`make clean-venv'."; \
`155`	`156`	`else \`
`156`	`157`	`$(PYTHON) -m venv $(VENVDIR); \`
`157`		`- $(VENVDIR)/bin/python3 -m pip install -U pip setuptools; \`
`158`		`- $(VENVDIR)/bin/python3 -m pip install -r requirements.txt; \`
	`158`	`+ $(VENVDIR)/bin/python3 -m pip install --upgrade pip; \`
	`159`	`+ $(VENVDIR)/bin/python3 -m pip install -r $(REQUIREMENTS); \`
`159`	`160`	`echo "The venv has been created in the $(VENVDIR) directory"; \`
`160`	`161`	`fi`
`161`	`162`

Collapse file

`‎Doc/library/sqlite3.rst‎`

Copy file name to clipboardExpand all lines: Doc/library/sqlite3.rst

+3-3Lines changed: 3 additions & 3 deletions

Display the source diff
Display the rich diff

Original file line number	Diff line number	Diff line change
`@@ -307,7 +307,7 @@ Module functions`
`307`	`307`	`to avoid data corruption.`
`308`	`308`	See :attr:`threadsafety` for more information.
`309`	`309`
`310`		`- :param Connection factory:`
	`310`	`+ :param ~sqlite3.Connection factory:`
`311`	`311`	A custom subclass of :class:`Connection` to create the connection with,
`312`	`312`	if not the default :class:`Connection` class.
`313`	`313`
`@@ -325,7 +325,7 @@ Module functions`
`325`	`325`	`The query string allows passing parameters to SQLite,`
`326`	`326`	enabling various :ref:`sqlite3-uri-tricks`.
`327`	`327`
`328`		`- :rtype: Connection`
	`328`	`+ :rtype: ~sqlite3.Connection`
`329`	`329`
`330`	`330`	`.. audit-event:: sqlite3.connect database sqlite3.connect`
`331`	`331`	`.. audit-event:: sqlite3.connect/handle connection_handle sqlite3.connect`
`@@ -1035,7 +1035,7 @@ Connection objects`
`1035`	`1035`	`Works even if the database is being accessed by other clients`
`1036`	`1036`	`or concurrently by the same connection.`
`1037`	`1037`
`1038`		`- :param Connection target:`
	`1038`	`+ :param ~sqlite3.Connection target:`
`1039`	`1039`	`The database connection to save the backup to.`
`1040`	`1040`
`1041`	`1041`	`:param int pages:`

Collapse file

`‎Doc/requirements-oldest-sphinx.txt‎`

Copy file name to clipboard

+38Lines changed: 38 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,38 @@`
	`1`	`+# Requirements to build the Python documentation, for the oldest supported`
	`2`	`+# Sphinx version.`
	`3`	`+#`
	`4`	`+# We pin Sphinx and all of its dependencies to ensure a consistent environment.`
	`5`	`+`
	`6`	`+blurb`
	`7`	`+python-docs-theme>=2022.1`
	`8`	`+`
	`9`	`+# Generated from:`
	`10`	`+# pip install "Sphinx~=3.2.0" "docutils<0.17" "Jinja2<3" "MarkupSafe<2"`
	`11`	`+# pip freeze`
	`12`	`+#`
	`13`	+# Sphinx 3.2 comes from ``needs_sphinx = '3.2'`` in ``Doc/conf.py``.
	`14`	`+# Docutils<0.17, Jinja2<3, and MarkupSafe<2 are additionally specified as`
	`15`	`+# Sphinx 3.2 is incompatible with newer releases of these packages.`
	`16`	`+`
	`17`	`+Sphinx==3.2.1`
	`18`	`+alabaster==0.7.13`
	`19`	`+Babel==2.12.1`
	`20`	`+certifi==2022.12.7`
	`21`	`+charset-normalizer==3.1.0`
	`22`	`+colorama==0.4.6`
	`23`	`+docutils==0.16`
	`24`	`+idna==3.4`
	`25`	`+imagesize==1.4.1`
	`26`	`+Jinja2==2.11.3`
	`27`	`+MarkupSafe==1.1.1`
	`28`	`+packaging==23.1`
	`29`	`+Pygments==2.15.1`
	`30`	`+requests==2.29.0`
	`31`	`+snowballstemmer==2.2.0`
	`32`	`+sphinxcontrib-applehelp==1.0.4`
	`33`	`+sphinxcontrib-devhelp==1.0.2`
	`34`	`+sphinxcontrib-htmlhelp==2.0.1`
	`35`	`+sphinxcontrib-jsmath==1.0.1`
	`36`	`+sphinxcontrib-qthelp==1.0.3`
	`37`	`+sphinxcontrib-serializinghtml==1.1.5`
	`38`	`+urllib3==1.26.15`

0 commit comments

Comments

0 (0)

You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.