walkero
/
nghttp2
1
0
Fork 0
Code Issues Pull Requests Projects Releases 1 Wiki Activity

Update doc

This commit is contained in:
Tatsuhiro Tsujikawa 2020-12-29 18:27:07 +09:00
parent 22af8e782b
commit 2e35cdea6c
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -112,7 +112,7 @@ libnghttp2_asio C++ library requires the following packages:
The Python bindings require the following packages:
* cython >= 0.19
* python >= 2.7
* python >= 3.8
* python-setuptools
If you are using Ubuntu 16.04 LTS (Xenial Xerus) or Debian 8 (jessie)
@ -1422,7 +1422,7 @@ The extension module is called ``nghttp2``.
determined by the ``configure`` script. If the detected Python version is not
what you expect, specify a path to Python executable in a ``PYTHON``
variable as an argument to configure script (e.g., ``./configure
PYTHON=/usr/bin/python3.5``).
PYTHON=/usr/bin/python3.8``).
The following example code illustrates basic usage of the HPACK compressor
and decompressor in Python:
@ -1494,7 +1494,7 @@ BaseRequestHandler usage:
.. code-block:: python
#!/usr/bin/env python
#!/usr/bin/env python3
import io, ssl
import nghttp2

14
doc/sources/python-apiref.rst
View File

@ -13,7 +13,7 @@ The extension module is called ``nghttp2``.
determined by configure script. If the detected Python version is not
what you expect, specify a path to Python executable in ``PYTHON``
variable as an argument to configure script (e.g., ``./configure
PYTHON=/usr/bin/python3.5``).
PYTHON=/usr/bin/python3.8``).
HPACK API
---------
@ -137,14 +137,14 @@ HTTP/2 servers
.. note::
We use :py:mod:`asyncio` for HTTP/2 server classes, and ALPN.
Therefore, Python 3.5 or later is required to use these objects.
To explicitly configure nghttp2 build to use Python 3.5, specify
the ``PYTHON`` variable to the path to Python 3.5 executable when
Therefore, Python 3.8 or later is required to use these objects.
To explicitly configure nghttp2 build to use Python 3.8, specify
the ``PYTHON`` variable to the path to Python 3.8 executable when
invoking configure script like this:
.. code-block:: text
$ ./configure PYTHON=/usr/bin/python3.5
$ ./configure PYTHON=/usr/bin/python3.8
.. py:class:: HTTP2Server(address, RequestHandlerClass, ssl=None)
@ -336,7 +336,7 @@ The following example illustrates :py:class:`HTTP2Server` and
.. code-block:: python
#!/usr/bin/env python
#!/usr/bin/env python3
import io, ssl
@ -367,7 +367,7 @@ response body generation. This is simplified reverse proxy:
.. code-block:: python
#!/usr/bin/env python
#!/usr/bin/env python3
import ssl
import os