Update xrefs in docs.

domdfcoding · Jul 22, 2021 · 6141537 · 6141537
1 parent b5b2011
commit 6141537
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 5 deletions.
diff --git a/apeye/rate_limiter.py b/apeye/rate_limiter.py
@@ -112,7 +112,7 @@ def rate_limit_wrapper(*args, **kwargs):
 
 class RateLimitAdapter(CacheControlAdapter):
 	r"""
-	Custom :class:`~.CacheControlAdapter` to limit the rate of requests to 5 per second.
+	Custom :class:`cachecontrol.adapter.CacheControlAdapter` to limit the rate of requests to 5 per second.
 
 	:param cache:
 	:param cache_etags:
@@ -155,7 +155,7 @@ def send(self, request: requests.PreparedRequest, cacheable_methods=None, **kwar
 	@rate_limit(0.2)
 	def rate_limited_send(self, *args, **kwargs) -> requests.Response:
 		"""
-		Wrapper around :meth:`CacheControlAdapter.send <CacheControl.CacheControlAdapter.send>`
+		Wrapper around :meth:`CacheControlAdapter.send <cachecontrol.adapter.CacheControlAdapter.send>`
 		to limit the rate of requests.
 		"""  # noqa: D400
 

diff --git a/apeye/requests_url.py b/apeye/requests_url.py
@@ -37,7 +37,7 @@
 # this package
 from apeye.url import URL
 
-__all__ = ["RequestsURL", "TrailingRequestsURL"]
+__all__ = ["RequestsURL", "TrailingRequestsURL", "_R"]
 
 _ParamsMappingValueType = Union[str, bytes, int, float, Iterable[Union[str, bytes, int, float]]]
 _Data = Union[None, str, bytes, MutableMapping[str, Any], Iterable[Tuple[str, Optional[str]]], IO]

diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -75,3 +75,10 @@ def setup(app):
 	from sphinx_toolbox.latex import better_header_layout
 
 	app.connect("config-inited", lambda app, config: better_header_layout(config))
+
+
+nitpicky = True
+ignore_missing_xrefs = [
+		"^requests.structures.CaseInsensitiveDict$",
+		"^cachecontrol.adapter.CacheControlAdapter",
+		]
diff --git a/pyproject.toml b/pyproject.toml
@@ -65,7 +65,7 @@ extensions = [
     "sphinx_toolbox_experimental.autosummary_widths",
     "sphinx_toolbox_experimental.needspace",
     "sphinx_toolbox_experimental.peps",
-    "sphinx_toolbox_experimental.toml",
+    "sphinx_toolbox_experimental.missing_xref",
 ]
 sphinxemoji_style = "twemoji"
 gitstamp_fmt = "%d %b %Y"

diff --git a/repo_helper.yml b/repo_helper.yml
@@ -56,10 +56,17 @@ extra_sphinx_extensions:
  - sphinx_toolbox_experimental.autosummary_widths
  - sphinx_toolbox_experimental.needspace
  - sphinx_toolbox_experimental.peps
- - sphinx_toolbox_experimental.toml
+ - sphinx_toolbox_experimental.missing_xref
 
 conda_extras:
  - limiter
 
 manifest_additional:
  - include apeye/public_suffix_list.dat
+
+sphinx_conf_epilogue:
+ - nitpicky = True
+ - "ignore_missing_xrefs = ["
+ - "    '^requests.structures.CaseInsensitiveDict$',"
+ - "    '^cachecontrol.adapter.CacheControlAdapter',"
+ - "]"