Merge pull request #145 from altendky/strict_sphinx

Author: altendky

.readthedocs.yml

@@ -8,6 +8,11 @@ formats:
 build:
   image: latest
 
+sphinx:
+  builder: html
+  configuration: docs/conf.py
+  fail_on_warning: true
+
 python:
   version: 3.8
   install:

docs/conf.py

@@ -1,6 +1,4 @@
 # -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 import os
 
 
@@ -12,6 +10,18 @@ def read(*names, **kwargs):
         return fh.read()
 
 
+# Warn about all references to unknown targets
+nitpicky = True
+# Except for these ones, which we expect to point to unknown targets:
+nitpick_ignore = [
+    # Perhaps this is "obvious" to those that know type hints.  Perhaps we should
+    # explain briefly with a link to the typing docs.
+    ("py:class", "desert.T"),
+    # TODO: get around to adding .. py:module to attrs somewhere
+    ("py:mod", "attrs"),
+]
+
+
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
@@ -72,8 +82,8 @@ def read(*names, **kwargs):
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
     "marshmallow": ("https://marshmallow.readthedocs.io/en/latest/", None),
-    "attrs": ("https://attrs.readthedocs.io/en/latest/", None),
-    "attr": ("https://attrs.readthedocs.io/en/latest/", None),
+    "attrs": ("https://www.attrs.org/en/latest/", None),
+    "attr": ("https://www.attrs.org/en/latest/", None),
     "marshmallow_union": (
         "https://python-marshmallow-union.readthedocs.io/en/latest/",
         None,

docs/reference/modules.rst

@@ -12,7 +12,7 @@ Basics
     :end-before: end-basic-usage
 
 
-Desert can be used with :mod:`dataclasses` or :mod:`attr`. With either module,
+Desert can be used with :mod:`dataclasses` or :mod:`attrs`. With either module,
 Desert is able to infer the appropriate :mod:`marshmallow` field
 for any of these types:
 
@@ -33,7 +33,7 @@ for any of these types:
 There are two syntaxes for
 specifying a field.
 
-In the more concise form, :func:`desert.field()` wraps :mod:`dataclasses.field()` and
+In the more concise form, :func:`desert.field()` wraps :func:`dataclasses.field()` and
 :func:`desert.ib()` wraps :func:`attr.ib()`. These functions take a
 :class:`marshmallow.fields.Field` as the first argument, and the remaining arguments are
 forwarded to the corresponding wrapped function.