From 20ac34772aa9805ccbf082e700f2b033291ff5d2 Mon Sep 17 00:00:00 2001 From: Pablo Galindo Date: Mon, 12 Apr 2021 20:53:15 +0100 Subject: 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. --- .github/workflows/doc.yml | 2 +- .travis.yml | 2 +- Doc/c-api/init_config.rst | 2 +- Doc/tools/susp-ignored.csv | 1 + 4 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml index 864303bf..8924fc9 100644 --- a/.github/workflows/doc.yml +++ b/.github/workflows/doc.yml @@ -36,7 +36,7 @@ jobs: - name: 'Install build dependencies' run: make -C Doc/ PYTHON=../python venv - name: 'Build documentation' - run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html + run: xvfb-run make -C Doc/ PYTHON=../python SPHINXOPTS="-q -W --keep-going -j4" doctest html suspicious - name: 'Upload' uses: actions/upload-artifact@v2.2.2 with: diff --git a/.travis.yml b/.travis.yml index 7050d25..fc06321 100644 --- a/.travis.yml +++ b/.travis.yml @@ -53,7 +53,7 @@ matrix: - cd Doc - make venv PYTHON=python script: - - make check html SPHINXOPTS="-q -W -j4" + - make check html suspicious SPHINXOPTS="-q -W -j4" - name: "Documentation tests" os: linux language: c diff --git a/Doc/c-api/init_config.rst b/Doc/c-api/init_config.rst index 7ececeb..d364f4a 100644 --- a/Doc/c-api/init_config.rst +++ b/Doc/c-api/init_config.rst @@ -831,7 +831,7 @@ PyConfig Set by the :envvar:`PYTHONPLATLIBDIR` environment variable. Default: value of the ``PLATLIBDIR`` macro which is set by the - :option`configure --with-platlibdir option <--with-platlibdir>` (default: + :option:`configure --with-platlibdir option <--with-platlibdir>` (default: ``"lib"``). Part of the :ref:`Python Path Configuration ` input. diff --git a/Doc/tools/susp-ignored.csv b/Doc/tools/susp-ignored.csv index fd27ab5..325c5fa 100644 --- a/Doc/tools/susp-ignored.csv +++ b/Doc/tools/susp-ignored.csv @@ -365,3 +365,4 @@ whatsnew/changelog,,::,default::DeprecationWarning library/importlib.metadata,,:main,"EntryPoint(name='wheel', value='wheel.cli:main', group='console_scripts')" library/importlib.metadata,,`,loading the metadata for packages for the indicated ``context``. library/re,,`,"`" +using/configure,84,:db2,=db1:db2:... -- cgit v0.12