Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tidy up toctree #7441

Merged
merged 8 commits into from
Jul 29, 2023
Merged

Tidy up toctree #7441

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
547c807
Tidy up toctree
Dreamsorcerer Jul 27, 2023
cf9d067
Update client.rst
Dreamsorcerer Jul 27, 2023
23ccdff
Update tracing_reference.rst
Dreamsorcerer Jul 27, 2023
d796fe9
Update web.rst
Dreamsorcerer Jul 27, 2023
3a56aa5
Update utilities.rst
Dreamsorcerer Jul 28, 2023
0260a34
Update tracing_reference.rst
Dreamsorcerer Jul 29, 2023
8885b9a
Update web_reference.rst
Dreamsorcerer Jul 29, 2023
689e0a3
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/client.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The page contains all information about aiohttp Client API:

.. toctree::
:name: client
:maxdepth: 3

Quickstart <client_quickstart>
Advanced Usage <client_advanced>
Expand Down
28 changes: 0 additions & 28 deletions docs/client_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -941,9 +941,6 @@ By default all *connectors* support *keep-alive connections* (behavior
is controlled by *force_close* constructor's parameter).


BaseConnector
^^^^^^^^^^^^^

.. class:: BaseConnector(*, keepalive_timeout=15, \
force_close=False, limit=100, limit_per_host=0, \
enable_cleanup_closed=False, loop=None)
Expand Down Expand Up @@ -1033,11 +1030,6 @@ BaseConnector
overridden in subclasses.




TCPConnector
^^^^^^^^^^^^

.. class:: TCPConnector(*, ssl=None, verify_ssl=True, fingerprint=None, \
use_dns_cache=True, ttl_dns_cache=10, \
family=0, ssl_context=None, local_addr=None, \
Expand Down Expand Up @@ -1173,9 +1165,6 @@ TCPConnector
clear all cache otherwise.


UnixConnector
^^^^^^^^^^^^^

.. class:: UnixConnector(path, *, conn_timeout=None, \
keepalive_timeout=30, limit=100, \
force_close=False, loop=None)
Expand Down Expand Up @@ -1208,9 +1197,6 @@ UnixConnector
Path to *UNIX socket*, read-only :class:`str` property.


Connection
^^^^^^^^^^

.. class:: Connection

Encapsulates single connection in connector object.
Expand Down Expand Up @@ -1696,9 +1682,6 @@ Utilities
---------


ClientTimeout
^^^^^^^^^^^^^

.. class:: ClientTimeout(*, total=None, connect=None, \
sock_connect=None, sock_read=None)

Expand Down Expand Up @@ -1764,9 +1747,6 @@ ClientTimeout
on production environment.


ETag
^^^^

.. class:: ETag(name, is_weak=False)

Represents `ETag` identifier.
Expand All @@ -1781,8 +1761,6 @@ ETag

.. versionadded:: 3.8

RequestInfo
^^^^^^^^^^^

.. class:: RequestInfo()

Expand All @@ -1808,9 +1786,6 @@ RequestInfo
.. versionadded:: 3.2


BasicAuth
^^^^^^^^^

.. class:: BasicAuth(login, password='', encoding='latin1')

HTTP basic authentication helper.
Expand Down Expand Up @@ -1851,9 +1826,6 @@ BasicAuth
:return: encoded authentication data, :class:`str`.


CookieJar
^^^^^^^^^

.. class:: CookieJar(*, unsafe=False, quote_cookie=True, treat_as_secure_origin = [])

The cookie jar instance is available as :attr:`ClientSession.cookie_jar`.
Expand Down
41 changes: 2 additions & 39 deletions docs/tracing_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,9 +121,8 @@ DNS resolving
}


TraceConfig
-----------

Classes
-------

.. class:: TraceConfig(trace_config_ctx_factory=SimpleNamespace)

Expand Down Expand Up @@ -278,8 +277,6 @@ TraceConfig

.. versionadded:: 3.8

TraceRequestStartParams
-----------------------

.. class:: TraceRequestStartParams

Expand All @@ -298,9 +295,6 @@ TraceRequestStartParams
Headers that will be used for the request, can be mutated.


TraceRequestChunkSentParams
---------------------------

.. class:: TraceRequestChunkSentParams

.. versionadded:: 3.1
Expand All @@ -320,9 +314,6 @@ TraceRequestChunkSentParams
Bytes of chunk sent


TraceResponseChunkReceivedParams
--------------------------------

.. class:: TraceResponseChunkReceivedParams

.. versionadded:: 3.1
Expand All @@ -342,9 +333,6 @@ TraceResponseChunkReceivedParams
Bytes of chunk received


TraceRequestEndParams
---------------------

.. class:: TraceRequestEndParams

See :attr:`TraceConfig.on_request_end` for details.
Expand All @@ -366,9 +354,6 @@ TraceRequestEndParams
Response :class:`ClientResponse`.


TraceRequestExceptionParams
---------------------------

.. class:: TraceRequestExceptionParams

See :attr:`TraceConfig.on_request_exception` for details.
Expand All @@ -389,8 +374,6 @@ TraceRequestExceptionParams

Exception raised during the request.

TraceRequestRedirectParams
--------------------------

.. class:: TraceRequestRedirectParams

Expand All @@ -412,53 +395,41 @@ TraceRequestRedirectParams

Response :class:`ClientResponse` got from the redirect.

TraceConnectionQueuedStartParams
--------------------------------

.. class:: TraceConnectionQueuedStartParams

See :attr:`TraceConfig.on_connection_queued_start` for details.

There are no attributes right now.

TraceConnectionQueuedEndParams
------------------------------

.. class:: TraceConnectionQueuedEndParams

See :attr:`TraceConfig.on_connection_queued_end` for details.

There are no attributes right now.

TraceConnectionCreateStartParams
--------------------------------

.. class:: TraceConnectionCreateStartParams

See :attr:`TraceConfig.on_connection_create_start` for details.

There are no attributes right now.

TraceConnectionCreateEndParams
------------------------------

.. class:: TraceConnectionCreateEndParams

See :attr:`TraceConfig.on_connection_create_end` for details.

There are no attributes right now.

TraceConnectionReuseconnParams
------------------------------

.. class:: TraceConnectionReuseconnParams

See :attr:`TraceConfig.on_connection_reuseconn` for details.

There are no attributes right now.

TraceDnsResolveHostStartParams
------------------------------

.. class:: TraceDnsResolveHostStartParams

Expand All @@ -468,8 +439,6 @@ TraceDnsResolveHostStartParams

Host that will be resolved.

TraceDnsResolveHostEndParams
----------------------------

.. class:: TraceDnsResolveHostEndParams

Expand All @@ -479,8 +448,6 @@ TraceDnsResolveHostEndParams

Host that has been resolved.

TraceDnsCacheHitParams
----------------------

.. class:: TraceDnsCacheHitParams

Expand All @@ -490,8 +457,6 @@ TraceDnsCacheHitParams

Host found in the cache.

TraceDnsCacheMissParams
-----------------------

.. class:: TraceDnsCacheMissParams

Expand All @@ -501,8 +466,6 @@ TraceDnsCacheMissParams

Host didn't find the cache.

TraceRequestHeadersSentParams
-----------------------------

.. class:: TraceRequestHeadersSentParams

Expand Down
1 change: 1 addition & 0 deletions docs/utilities.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Miscellaneous API Shared between Client And Server.

.. toctree::
:name: utilities
:maxdepth: 2

abc
multipart
Expand Down
1 change: 1 addition & 0 deletions docs/web.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ The page contains all information about aiohttp Server API:

.. toctree::
:name: server
:maxdepth: 3

Tutorial <https://demos.aiohttp.org>
Quickstart <web_quickstart>
Expand Down
Loading