Browse Source

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.
pull/25363/head
Pablo Galindo 5 years ago
committed by GitHub
parent
commit
20ac34772a
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 2
      .github/workflows/doc.yml
  2. 2
      .travis.yml
  3. 2
      Doc/c-api/init_config.rst
  4. 1
      Doc/tools/susp-ignored.csv

2
.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:

2
.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

2
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 <init-path-config>` input.

1
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:...
Loading…
Cancel
Save