Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
tatsuhiro-t committed Dec 29, 2020
1 parent 22af8e7 commit 2e35cde
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -1494,7 +1494,7 @@ BaseRequestHandler usage:

.. code-block:: python
#!/usr/bin/env python
#!/usr/bin/env python3
import io, ssl
import nghttp2
Expand Down
14 changes: 7 additions & 7 deletions doc/sources/python-apiref.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------
Expand Down Expand Up @@ -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)
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit 2e35cde

Please sign in to comment.