File tree Expand file tree Collapse file tree 4 files changed +64
-5
lines changed Expand file tree Collapse file tree 4 files changed +64
-5
lines changed Original file line number Diff line number Diff line change 7979 # Build docs with the '-n' (nit-picky) option, convert warnings to errors (-W)
8080 make -C Doc/ PYTHON=../python SPHINXOPTS="-q -n -W --keep-going" html 2>&1
8181
82+ # This build doesn't use problem matchers or check annotations
83+ # It also does not run 'make check', as sphinx-lint is not installed into the
84+ # environment.
85+ build_doc_oldest_supported_sphinx :
86+ name : ' Docs (Oldest Sphinx)'
87+ runs-on : ubuntu-latest
88+ timeout-minutes : 60
89+ steps :
90+ - uses : actions/checkout@v3
91+ - name : ' Set up Python'
92+ uses : actions/setup-python@v4
93+ with :
94+ python-version : ' 3.11' # known to work with Sphinx 3.2
95+ cache : ' pip'
96+ cache-dependency-path : ' Doc/requirements-oldest-sphinx.txt'
97+ - name : ' Install build dependencies'
98+ run : make -C Doc/ venv REQUIREMENTS="requirements-oldest-sphinx.txt"
99+ - name : ' Build HTML documentation'
100+ run : make -C Doc/ SPHINXOPTS="-q" SPHINXERRORHANDLING="-W --keep-going" html
101+
82102 # Run "doctest" on HEAD as new syntax doesn't exist in the latest stable release
83103 doctest :
84104 name : ' Doctest'
Original file line number Diff line number Diff line change @@ -13,6 +13,7 @@ JOBS = auto
1313PAPER =
1414SOURCES =
1515DISTVERSION = $(shell $(PYTHON ) tools/extensions/patchlevel.py)
16+ REQUIREMENTS = requirements.txt
1617SPHINXERRORHANDLING = -W
1718
1819# Internal variables.
@@ -154,8 +155,8 @@ venv:
154155 echo " To recreate it, remove it first with \` make clean-venv'." ; \
155156 else \
156157 $(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 ) ; \
159160 echo " The venv has been created in the $( VENVDIR) directory" ; \
160161 fi
161162
Original file line number Diff line number Diff line change @@ -310,7 +310,7 @@ Module functions
310310 to avoid data corruption.
311311 See :attr: `threadsafety ` for more information.
312312
313- :param Connection factory:
313+ :param ~sqlite3. Connection factory:
314314 A custom subclass of :class: `Connection ` to create the connection with,
315315 if not the default :class: `Connection ` class.
316316
@@ -337,7 +337,7 @@ Module functions
337337 The default will change to ``False `` in a future Python release.
338338 :type autocommit: bool
339339
340- :rtype: Connection
340+ :rtype: ~sqlite3. Connection
341341
342342 .. audit-event :: sqlite3.connect database sqlite3.connect
343343 .. audit-event :: sqlite3.connect/handle connection_handle sqlite3.connect
@@ -1129,7 +1129,7 @@ Connection objects
11291129 Works even if the database is being accessed by other clients
11301130 or concurrently by the same connection.
11311131
1132- :param Connection target:
1132+ :param ~sqlite3. Connection target:
11331133 The database connection to save the backup to.
11341134
11351135 :param int pages:
Original file line number Diff line number Diff line change 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
You can’t perform that action at this time.
0 commit comments