Skip to content

Fail sphinx build on warnings #762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srittau merged 1 commit into from
Jun 11, 2026
+7 −7
Merged

Fail sphinx build on warnings #762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -W -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
2 changes: 1 addition & 1 deletion doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

# This should usually point to /3, unless there is a necessity to link to
# features in future versions of Python.
intersphinx_mapping = {'py': ('https://docs.python.org/3.14', None)}
intersphinx_mapping = {'py': ('https://docs.python.org/3', None)}

add_module_names = False

Expand Down
10 changes: 5 additions & 5 deletions doc/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:data:`types.NoneType`, and passing no value for the parameter would
to :py:class:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand All @@ -318,7 +318,7 @@ Special typing primitives
.. class:: ParamSpecArgs
ParamSpecKwargs

See :py:data:`typing.ParamSpecArgs` and :py:data:`typing.ParamSpecKwargs`.
See :py:class:`typing.ParamSpecArgs` and :py:class:`typing.ParamSpecKwargs`.
In ``typing`` since 3.10.

.. class:: Protocol
Expand Down Expand Up @@ -529,7 +529,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:data:`types.NoneType`, and passing no value for the parameter would
to :py:class:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand Down Expand Up @@ -560,7 +560,7 @@ Special typing primitives
``default=None`` is passed, and to :data:`NoDefault` if no value is passed.

Previously, passing ``None`` would result in :attr:`!__default__` being set
to :py:data:`types.NoneType`, and passing no value for the parameter would
to :py:class:`types.NoneType`, and passing no value for the parameter would
result in :attr:`!__default__` being set to ``None``.

.. versionchanged:: 4.12.0
Expand Down Expand Up @@ -802,7 +802,7 @@ Functions
* Raises :exc:`TypeError` when it encounters certain objects that are
not valid type hints.
* Replaces type hints that evaluate to :const:`!None` with
:data:`types.NoneType`.
:class:`types.NoneType`.
* Supports the :attr:`Format.FORWARDREF` and
:attr:`Format.STRING` formats.

Expand Down
Loading