[PR #5778/b141f8b7 backport][3.8] Ensure all sphinx-build invocations…

… are strict (#5779) * Ensure all sphinx-build invocations are strict (#5778) (cherry picked from commit b141f8b) * Fix the spelling of `ClientSession` * Fix the ref to aiohttp.test_utils * Ignore undocumented exceptions in Sphinx * Mark `testing.rst` as `aiohttp.test_utils` mod Co-authored-by: Sviatoslav Sydorenko <[email protected]> Co-authored-by: Sviatoslav Sydorenko <[email protected]>
aio-libs · Jun 7, 2021 · 8c20611 · 8c20611
1 parent 6044b4b
commit 8c20611
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 6 deletions.
diff --git a/Makefile b/Makefile
@@ -133,12 +133,12 @@ clean:
 
 .PHONY: doc
 doc:
-	@make -C docs html SPHINXOPTS="-W --keep-going -E"
+	@make -C docs html SPHINXOPTS="-W --keep-going -n -E"
 	@echo "open file://`pwd`/docs/_build/html/index.html"
 
 .PHONY: doc-spelling
 doc-spelling:
-	@make -C docs spelling SPHINXOPTS="-W -E"
+	@make -C docs spelling SPHINXOPTS="-W --keep-going -n -E"
 
 .PHONY: compile-deps
 compile-deps: .update-pip

diff --git a/docs/client_quickstart.rst b/docs/client_quickstart.rst
@@ -180,7 +180,7 @@ JSON Request
 ============
 
 Any of session's request methods like :func:`request`,
-:meth:`ClientSession.get`, :meth:`ClientSesssion.post` etc. accept
+:meth:`ClientSession.get`, :meth:`ClientSession.post` etc. accept
 `json` parameter::
 
   async with aiohttp.ClientSession() as session:

diff --git a/docs/conf.py b/docs/conf.py
@@ -391,4 +391,18 @@
     ("py:class", "cgi.FieldStorage"),  # undocumented
     ("py:meth", "aiohttp.web.UrlDispatcher.register_resource"),  # undocumented
     ("py:func", "aiohttp_debugtoolbar.setup"),  # undocumented
+    ("py:exc", "HTTPInternalServerError"),  # undocumented
+    ("py:exc", "HTTPForbidden"),  # undocumented
+    ("py:exc", "HTTPExpectationFailed"),  # undocumented
+    ("py:class", "HTTPFound"),  # undocumented
+    ("py:class", "HTTPMultipleChoices"),  # undocumented
+    ("py:class", "HTTPMovedPermanently"),  # undocumented
+    ("py:class", "HTTPSeeOther"),  # undocumented
+    ("py:class", "HTTPUseProxy"),  # undocumented
+    ("py:class", "HTTPTemporaryRedirect"),  # undocumented
+    ("py:class", "HTTPMethodNotAllowed"),  # undocumented
+    ("py:class", "FileResponse"),  # undocumented
+    ("py:exc", "HTTPNotFound"),  # undocumented
+    ("py:exc", "HTTPMethodNotAllowed"),  # undocumented
+    ("py:class", "HTTPMethodNotAllowed"),  # undocumented
 ]
diff --git a/docs/testing.rst b/docs/testing.rst
@@ -1,10 +1,10 @@
+.. module:: aiohttp.test_utils
+
 .. _aiohttp-testing:
 
 Testing
 =======
 
-.. currentmodule:: aiohttp.test_utils
-
 Testing aiohttp web servers
 ---------------------------
 
@@ -513,7 +513,7 @@ basis, the TestClient object can be used directly::
 
 
 A full list of the utilities provided can be found at the
-:data:`api reference <aiohttp.test_utils>`
+:mod:`api reference <aiohttp.test_utils>`
 
 
 Testing API Reference