Skip to content

Commit 82dfd83

Browse files
committed
Improve index page for topic guides.
1 parent e60e04c commit 82dfd83

File tree

2 files changed

+15
-7
lines changed

2 files changed

+15
-7
lines changed

docs/topics/authentication.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -313,8 +313,8 @@ To authenticate a websockets client with HTTP Basic Authentication
313313
async with connect(f"wss://{username}:{password}@.../") as websocket:
314314
...
315315
316-
(You must :func:`~urllib.parse.quote` ``username`` and ``password`` if they
317-
contain unsafe characters.)
316+
You must :func:`~urllib.parse.quote` ``username`` and ``password`` if they
317+
contain unsafe characters.
318318

319319
To authenticate a websockets client with HTTP Bearer Authentication
320320
(:rfc:`6750`), add a suitable ``Authorization`` header:

docs/topics/index.rst

+13-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
11
Topic guides
22
============
33

4-
Get a deeper understanding of how websockets is built and why.
4+
These documents discuss how websockets is designed and how to make the best of
5+
its features when building applications.
56

67
.. toctree::
7-
:titlesonly:
8+
:maxdepth: 2
89

910
authentication
1011
broadcast
12+
logging
13+
proxies
14+
routing
15+
16+
These guides describe how to optimize the configuration of websockets
17+
applications for performance and reliability.
18+
19+
.. toctree::
20+
:maxdepth: 2
21+
1122
compression
1223
keepalive
13-
logging
1424
memory
1525
security
1626
performance
17-
proxies
18-
routing

0 commit comments

Comments
 (0)