[PR #5714/f5e418a6 backport][3.8] Fix broken references in `docs/web_…

…advanced.rst` (#5771) * Fix broken references * Add references to ignore * Add a tilde when rendering `RequestHandler` Co-authored-by: Sviatoslav Sydorenko <[email protected]> (cherry picked from commit f5e418a) Co-authored-by: Olexiy Pohorely <[email protected]>
aio-libs · Jun 6, 2021 · 35a600b · 35a600b
1 parent c7e23e0
commit 35a600b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 5 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -376,4 +376,6 @@
     ("py:class", "aiohttp.abc.AbstractAsyncAccessLogger"),  # undocumented
     ("py:meth", "aiohttp.payload.Payload.set_content_disposition"),  # undocumented
     ("py:class", "cgi.FieldStorage"),  # undocumented
+    ("py:meth", "aiohttp.web.UrlDispatcher.register_resource"),  # undocumented
+    ("py:func", "aiohttp_debugtoolbar.setup"),  # undocumented
 ]
diff --git a/docs/web_advanced.rst b/docs/web_advanced.rst
@@ -431,7 +431,7 @@ the keyword-only ``middlewares`` parameter::
 
 Internally, a single :ref:`request handler <aiohttp-web-handler>` is constructed
 by applying the middleware chain to the original handler in reverse order,
-and is called by the :class:`RequestHandler` as a regular *handler*.
+and is called by the :class:`~aiohttp.web.RequestHandler` as a regular *handler*.
 
 Since *middlewares* are themselves coroutines, they may perform extra
 ``await`` calls when creating a new handler, e.g. call database etc.
@@ -748,7 +748,7 @@ header::
 Custom resource implementation
 ------------------------------
 
-To register custom resource use :meth:`UrlDispatcher.register_resource`.
+To register custom resource use :meth:`~aiohttp.web.UrlDispatcher.register_resource`.
 Resource instance must implement `AbstractResource` interface.
 
 .. _aiohttp-web-app-runners:
@@ -849,9 +849,9 @@ sources (e.g. ZeroMQ, Redis Pub/Sub, AMQP, etc.) to react to received messages
 within the application.
 
 For example the background task could listen to ZeroMQ on
-:data:`zmq.SUB` socket, process and forward retrieved messages to
+``zmq.SUB`` socket, process and forward retrieved messages to
 clients connected via WebSocket that are stored somewhere in the
-application (e.g. in the :obj:`application['websockets']` list).
+application (e.g. in the ``application['websockets']`` list).
 
 To run such short and long running background tasks aiohttp provides an
 ability to register :attr:`Application.on_startup` signal handler(s) that
@@ -893,7 +893,7 @@ signal handlers as shown in the example below::
   web.run_app(app)
 
 
-The task :func:`listen_to_redis` will run forever.
+The task ``listen_to_redis`` will run forever.
 To shut it down correctly :attr:`Application.on_cleanup` signal handler
 may be used to send a cancellation to it.