summaryrefslogtreecommitdiff
path: root/doc/development/tutorials
diff options
context:
space:
mode:
authorAdam Turner <9087854+aa-turner@users.noreply.github.com>2023-04-06 23:11:39 +0100
committerAdam Turner <9087854+aa-turner@users.noreply.github.com>2023-04-06 23:11:39 +0100
commit7ecf0372809825b97082a73587b3c27660db01a7 (patch)
tree20163c51f9a454be529db79e20cf341ffded8443 /doc/development/tutorials
parentb2349254fcb1f852ba62bd1f81f22783271bac34 (diff)
downloadsphinx-git-7ecf0372809825b97082a73587b3c27660db01a7.tar.gz
Enable 'nit-picky mode' for Sphinx's documentation
Fix several reference errors throughout the documentation and set ``nitpick_ignore`` in ``doc/conf.py``.
Diffstat (limited to 'doc/development/tutorials')
-rw-r--r--doc/development/tutorials/autodoc_ext.rst7
-rw-r--r--doc/development/tutorials/todo.rst2
2 files changed, 5 insertions, 4 deletions
diff --git a/doc/development/tutorials/autodoc_ext.rst b/doc/development/tutorials/autodoc_ext.rst
index 8de2e4d4a..cfd23e7e6 100644
--- a/doc/development/tutorials/autodoc_ext.rst
+++ b/doc/development/tutorials/autodoc_ext.rst
@@ -54,9 +54,10 @@ Start with ``setup`` function for the extension.
:pyobject: setup
-The :meth:`~Sphinx.setup_extension` method will pull the autodoc extension
-because our new extension depends on autodoc. :meth:`~Sphinx.add_autodocumenter`
-is the method that registers our new auto documenter class.
+The :meth:`~sphinx.application.Sphinx.setup_extension` method will pull the
+autodoc extension because our new extension depends on autodoc.
+:meth:`~sphinx.application.Sphinx.add_autodocumenter` is the method that
+registers our new auto documenter class.
We want to import certain objects from the autodoc extension:
diff --git a/doc/development/tutorials/todo.rst b/doc/development/tutorials/todo.rst
index c0a5c0d87..f23d8adaf 100644
--- a/doc/development/tutorials/todo.rst
+++ b/doc/development/tutorials/todo.rst
@@ -112,7 +112,7 @@ is just a "general" node.
It is important to know that while you can extend Sphinx without
leaving your ``conf.py``, if you declare an inherited node right
- there, you'll hit an unobvious :py:class:`PickleError`. So if
+ there, you'll hit an unobvious :py:class:`~pickle.PickleError`. So if
something goes wrong, please make sure that you put inherited nodes
into a separate Python module.