add codeautolink (#250)

Author: jakkdl

.readthedocs.yaml

@@ -19,6 +19,7 @@ build:
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
     configuration: docs/conf.py
+    fail_on_warning: true
 
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:

docs/conf.py

@@ -27,6 +27,7 @@
 
 extensions: list[str] = [
     "sphinx.ext.intersphinx",
+    "sphinx_codeautolink",
 ]
 
 intersphinx_mapping = {
@@ -38,6 +39,11 @@
     # see https://github.com/encode/httpx/discussions/1220
     # we only have a few references to httpx though, so can just link manually.
 }
+
+# these are disabled by default, might re-disable them if they turn out to be noisy
+codeautolink_warn_on_missing_inventory = True
+codeautolink_warn_on_failed_resolve = True
+
 templates_path = ["_templates"]
 exclude_patterns: list[str] = ["_build", "Thumbs.db", ".DS_Store"]
 

docs/requirements.txt

@@ -1 +1,2 @@
 libcst
+sphinx-codeautolink