📚 Enable nitpicky mode (chrisjsewell#56)

Author: chrisjsewell

docs/source/conf.py

@@ -37,7 +37,7 @@
 version = ".".join(release.split(".")[:2])
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.6", None),
+    "python": ("https://docs.python.org/3.8", None),
     "_pytest": ("https://doc.pytest.org/en/latest/", None),
     # "PIL": ("http://pillow.readthedocs.org/en/latest/", None),
     "nbclient": ("https://nbclient.readthedocs.io/en/latest/", None),
@@ -47,35 +47,21 @@
 }
 
 intersphinx_aliases = {
-    ("py:class", "List"): ("py:class", "list"),
-    ("py:class", "Sequence"): ("py:class", "list"),
-    ("py:class", "Mapping"): ("py:class", "dict"),
-    ("py:class", "Tuple"): ("py:class", "tuple"),
-    ("py:class", "Callable"): ("py:class", "collections.abc.Callable"),
-    ("py:class", "callable"): ("py:class", "collections.abc.Callable"),
-    ("py:class", "_pytest.nodes.File"): ("py:class", "_pytest.nodes.Node"),
     ("py:class", "NotebookNode"): ("py:class", "nbformat.NotebookNode"),
-    ("py:class", "nbformat.notebooknode.NotebookNode"): (
-        "py:class",
-        "nbformat.NotebookNode",
-    ),
-    ("py:class", "nbconvert.preprocessors.execute.ExecutePreprocessor"): (
-        "py:class",
-        "nbconvert.preprocessors.ExecutePreprocessor",
-    ),
-    ("py:class", "coverage.control.Coverage"): ("py:class", "coverage.Coverage"),
+    ("py:class", "Path"): ("py:class", "pathlib.Path"),
 }
 
+nitpicky = True
 nitpick_ignore = [
-    ("py:class", "NoneType"),
+    ("py:class", "t.Any"),
     ("py:class", "Config"),
-    ("py:class", "TextIO"),
     ("py:class", "attr.ib"),
     ("py:class", "attr.s"),
-    ("py:class", "ruamel.yaml.dumper.RoundTripDumper"),
+    ("py:class", "Session"),
     ("py:exc", "nbconvert.preprocessors.CellExecutionError"),
     ("py:class", "nbdime.diff_format.DiffEntry"),
-    ("py:class", "_pytest.nodes.Item"),
+    ("py:class", "_pytest._py.path.LocalPath"),
+    ("py:meth", "Item.reportinfo"),
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.

docs/source/user_guide/tutorial_coverage.md

@@ -116,6 +116,8 @@ This is also the case, when using the pytest file collection approach.
 [pytest]
 nb_coverage = True
 nb_test_files = True
+nb_diff_ignore =
+    /metadata/language_info
 ---
 
 ***

pyproject.toml

@@ -60,6 +60,7 @@ docs = [
   "myst-nb~=1.0",
   "coverage~=5.0",
   "pytest-cov",
+  "black",
 ]
 
 [project.entry-points."pytest11"]

tox.ini

@@ -20,6 +20,8 @@ commands = pytest {posargs}
 extras = docs
 changedir = docs
 whitelist_externals = make
+setenv =
+    PYDEVD_DISABLE_FILE_VALIDATION = 1
 commands =
     clean: make clean
     make