Skip to content

Commit 20ac347

Browse files
authored
Fix Sphinx errors in the documentation and re-activate the suspicious check (GH-25368)
The suspicious check is still executed as part of the release process and release managers have been lately fixing some actual errors that the suspicious target can find. For this reason, reactivate the suspicious until we decide what to do in a coordinated fashion.
1 parent a9cf69d commit 20ac347

File tree

4 files changed

+4
-3
lines changed

4 files changed

+4
-3
lines changed

.github/workflows/doc.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ jobs:
3636
- name: 'Install build dependencies'
3737
run: make -C Doc/ PYTHON=../python venv
3838
- name: 'Build documentation'
39-
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html
39+
run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html suspicious
4040
- name: 'Upload'
4141
uses: actions/[email protected]
4242
with:

.travis.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ matrix:
5353
- cd Doc
5454
- make venv PYTHON=python
5555
script:
56-
- make check html SPHINXOPTS="-q -W -j4"
56+
- make check html suspicious SPHINXOPTS="-q -W -j4"
5757
- name: "Documentation tests"
5858
os: linux
5959
language: c

Doc/c-api/init_config.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -831,7 +831,7 @@ PyConfig
831831
Set by the :envvar:`PYTHONPLATLIBDIR` environment variable.
832832
833833
Default: value of the ``PLATLIBDIR`` macro which is set by the
834-
:option`configure --with-platlibdir option <--with-platlibdir>` (default:
834+
:option:`configure --with-platlibdir option <--with-platlibdir>` (default:
835835
``"lib"``).
836836
837837
Part of the :ref:`Python Path Configuration <init-path-config>` input.

Doc/tools/susp-ignored.csv

+1
Original file line numberDiff line numberDiff line change
@@ -365,3 +365,4 @@ whatsnew/changelog,,::,default::DeprecationWarning
365365
library/importlib.metadata,,:main,"EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')"
366366
library/importlib.metadata,,`,loading the metadata for packages for the indicated ``context``.
367367
library/re,,`,"`"
368+
using/configure,84,:db2,=db1:db2:...

0 commit comments

Comments
 (0)