Skip to content

Commit

Permalink
[7.4.x] Configure ReadTheDocs to fail on warnings (#11540)
Browse files Browse the repository at this point in the history
Co-authored-by: Bruno Oliveira <[email protected]>
  • Loading branch information
github-actions[bot] and nicoddemus authored Oct 23, 2023
1 parent 21fe071 commit a517827
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,10 @@ python:
path: .
- requirements: doc/en/requirements.txt

sphinx:
configuration: doc/en/conf.py
fail_on_warning: true

build:
os: ubuntu-20.04
tools:
Expand Down
2 changes: 1 addition & 1 deletion doc/en/reference/customize.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ and can also be used to hold pytest configuration if they have a ``[pytest]`` se
setup.cfg
~~~~~~~~~

``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
``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
if they have a ``[tool:pytest]`` section.

.. code-block:: ini
Expand Down

0 comments on commit a517827

Please sign in to comment.