Skip to content

Commit a517827

Browse files
[7.4.x] Configure ReadTheDocs to fail on warnings (#11540)
Co-authored-by: Bruno Oliveira <[email protected]>
1 parent 21fe071 commit a517827

File tree

2 files changed

+5
-1
lines changed

2 files changed

+5
-1
lines changed

Diff for: .readthedocs.yml

+4
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ python:
99
path: .
1010
- requirements: doc/en/requirements.txt
1111

12+
sphinx:
13+
configuration: doc/en/conf.py
14+
fail_on_warning: true
15+
1216
build:
1317
os: ubuntu-20.04
1418
tools:

Diff for: doc/en/reference/customize.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
9090
setup.cfg
9191
~~~~~~~~~
9292

93-
``setup.cfg`` files are general purpose configuration files, used originally by :doc:`distutils <python:distutils/configfile>`, and can also be used to hold pytest configuration
93+
``setup.cfg`` files are general purpose configuration files, used originally by ``distutils`` (now deprecated) and `setuptools <https://setuptools.pypa.io/en/latest/userguide/declarative_config.html>`__, and can also be used to hold pytest configuration
9494
if they have a ``[tool:pytest]`` section.
9595

9696
.. code-block:: ini

0 commit comments

Comments
 (0)