Enable 'nit-picky mode' for Sphinx's documentation

Fix several reference errors throughout the documentation and set
``nitpick_ignore`` in ``doc/conf.py``.
This commit is contained in:
Adam Turner committed 2023-04-06 23:11:39 +01:00
1 parent b2349254fc
commit 7ecf037280
31 files changed
+206 -133

No files matched your search

+2 -2
View File
@@ -4,11 +4,11 @@ Setuptools integration
======================
Sphinx supports integration with setuptools and distutils through a custom
command - :class:`~sphinx.setup_command.BuildDoc`.
command - :class:`!sphinx.setup_command.BuildDoc`.
.. deprecated:: 5.0
This feature will be removed in v7.0.
This feature will be removed in Sphinx 7.0.
Using setuptools integration
----------------------------
+1 -1
View File
@@ -252,4 +252,4 @@ class when instantiating your support object::
support = WebSupport(..., moderation_callback=moderation_callback)
The moderation callback must take one argument, which will be the same comment
dict that is returned by :meth:`add_comment`.
dict that is returned by :meth:`.WebSupport.add_comment`.