From f9a3aca8ae61448faf2349df14ce4175e2874be3 Mon Sep 17 00:00:00 2001 From: Todd Leonhardt Date: Thu, 9 Apr 2020 13:59:33 -0400 Subject: Added documentation about decorator order and updated an example Also: - Deal with warnings when building docs with Sphinx 3.0.0 --- docs/conf.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) (limited to 'docs/conf.py') diff --git a/docs/conf.py b/docs/conf.py index cd320f52..9bb2e855 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -169,3 +169,16 @@ intersphinx_mapping = {'http://docs.python.org/': None} autodoc_default_options = { 'member-order': 'bysource' } + +# Ignore nitpicky warnings from autodoc which are occurring for very new versions of Sphinx and autodoc +# They seem to be happening because autodoc is now trying to add hyperlinks to docs for typehint classes +nitpick_ignore = [ + ('py:class', 'Callable[[None], None]'), + ('py:class', 'cmd2.cmd2.Cmd'), + ('py:class', 'cmd2.parsing.Statement'), + ('py:class', 'IO'), + ('py:class', 'None'), + ('py:class', 'Optional[Callable[[...], argparse.Namespace]]'), + ('py:class', 'TextIO'), + ('py:class', 'Union[None, Iterable, Callable]'), +] -- cgit v1.2.1