doc: Fix Sphinx build warnings
This commit is contained in:
parent
53e1623ab3
commit
7506a93179
|
@ -12,7 +12,9 @@ implementation.
|
||||||
|
|
||||||
When connection is established, nghttp sends 5 PRIORITY frames to idle
|
When connection is established, nghttp sends 5 PRIORITY frames to idle
|
||||||
streams 3, 5, 7, 9 and 11 to create "anchor" nodes in dependency
|
streams 3, 5, 7, 9 and 11 to create "anchor" nodes in dependency
|
||||||
tree::
|
tree:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
+-----+
|
+-----+
|
||||||
|id=0 |
|
|id=0 |
|
||||||
|
|
|
@ -85,7 +85,7 @@ backend server and extracts URI-reference with parameter
|
||||||
and pushes those URIs to the frontend client. Here is a sample Link
|
and pushes those URIs to the frontend client. Here is a sample Link
|
||||||
header field to initiate server push:
|
header field to initiate server push:
|
||||||
|
|
||||||
.. code-block:: http
|
.. code-block:: text
|
||||||
|
|
||||||
Link: </fonts/font.woff>; rel=preload
|
Link: </fonts/font.woff>; rel=preload
|
||||||
Link: </css/theme.css>; rel=preload
|
Link: </css/theme.css>; rel=preload
|
||||||
|
|
|
@ -17,7 +17,9 @@ installed in the following way. First, let us introduce
|
||||||
under ``$ANDROID_HOME/toolchain``. An user can freely choose the path
|
under ``$ANDROID_HOME/toolchain``. An user can freely choose the path
|
||||||
for ``ANDROID_HOME``. For example, to install toolchain under
|
for ``ANDROID_HOME``. For example, to install toolchain under
|
||||||
``$ANDROID_HOME/toolchain``, do this in the the directory where NDK is
|
``$ANDROID_HOME/toolchain``, do this in the the directory where NDK is
|
||||||
unpacked::
|
unpacked:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ build/tools/make-standalone-toolchain.sh \
|
$ build/tools/make-standalone-toolchain.sh \
|
||||||
--install-dir=$ANDROID_HOME/toolchain \
|
--install-dir=$ANDROID_HOME/toolchain \
|
||||||
|
@ -45,7 +47,9 @@ spdylay as well.
|
||||||
|
|
||||||
Before running ``android-config`` and ``android-make``,
|
Before running ``android-config`` and ``android-make``,
|
||||||
``ANDROID_HOME`` environment variable must be set to point to the
|
``ANDROID_HOME`` environment variable must be set to point to the
|
||||||
correct path. Also add ``$ANDROID_HOME/toolchain/bin`` to ``PATH``::
|
correct path. Also add ``$ANDROID_HOME/toolchain/bin`` to ``PATH``:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ export PATH=$PATH:$ANDROID_HOME/toolchain/bin
|
$ export PATH=$PATH:$ANDROID_HOME/toolchain/bin
|
||||||
|
|
||||||
|
@ -159,6 +163,8 @@ then ``android-make`` to compile nghttp2 source files.
|
||||||
|
|
||||||
If all went well, application binaries, such as nghttpx, are created
|
If all went well, application binaries, such as nghttpx, are created
|
||||||
under src directory. Strip debugging information from the binary
|
under src directory. Strip debugging information from the binary
|
||||||
using the following command::
|
using the following command:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ arm-linux-androideabi-strip src/nghttpx
|
$ arm-linux-androideabi-strip src/nghttpx
|
||||||
|
|
|
@ -48,12 +48,16 @@ explicitly.
|
||||||
The backend is supposed to be Web server. For example, to make
|
The backend is supposed to be Web server. For example, to make
|
||||||
nghttpx listen to encrypted HTTP/2 requests at port 8443, and a
|
nghttpx listen to encrypted HTTP/2 requests at port 8443, and a
|
||||||
backend Web server is configured to listen to HTTP request at port
|
backend Web server is configured to listen to HTTP request at port
|
||||||
8080 in the same host, run nghttpx command-line like this::
|
8080 in the same host, run nghttpx command-line like this:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ nghttpx -f0.0.0.0,8443 -b127.0.0.1,8080 /path/to/server.key /path/to/server.crt
|
$ nghttpx -f0.0.0.0,8443 -b127.0.0.1,8080 /path/to/server.key /path/to/server.crt
|
||||||
|
|
||||||
Then HTTP/2 enabled client can access to the nghttpx in HTTP/2. For
|
Then HTTP/2 enabled client can access to the nghttpx in HTTP/2. For
|
||||||
example, you can send GET request to the server using nghttp::
|
example, you can send GET request to the server using nghttp:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ nghttp -nv https://localhost:8443/
|
$ nghttp -nv https://localhost:8443/
|
||||||
|
|
||||||
|
@ -89,7 +93,9 @@ connection, use :option:`--backend` option, and specify ``h2`` in
|
||||||
For example, to make nghttpx listen to encrypted HTTP/2 requests at
|
For example, to make nghttpx listen to encrypted HTTP/2 requests at
|
||||||
port 8443, and a backend HTTP proxy server is configured to listen to
|
port 8443, and a backend HTTP proxy server is configured to listen to
|
||||||
HTTP/1 request at port 8080 in the same host, run nghttpx command-line
|
HTTP/1 request at port 8080 in the same host, run nghttpx command-line
|
||||||
like this::
|
like this:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ nghttpx -s -f'*,8443' -b127.0.0.1,8080 /path/to/server.key /path/to/server.crt
|
$ nghttpx -s -f'*,8443' -b127.0.0.1,8080 /path/to/server.key /path/to/server.crt
|
||||||
|
|
||||||
|
@ -118,13 +124,17 @@ to proxy.pac file, something like this:
|
||||||
|
|
||||||
file:///path/to/proxy.pac
|
file:///path/to/proxy.pac
|
||||||
|
|
||||||
For Chromium, use following command-line::
|
For Chromium, use following command-line:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
|
$ google-chrome --proxy-pac-url=file:///path/to/proxy.pac --use-npn
|
||||||
|
|
||||||
As HTTP/1 proxy server, Squid may work as out-of-box. Traffic server
|
As HTTP/1 proxy server, Squid may work as out-of-box. Traffic server
|
||||||
requires to be configured as forward proxy. Here is the minimum
|
requires to be configured as forward proxy. Here is the minimum
|
||||||
configuration items to edit::
|
configuration items to edit:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
CONFIG proxy.config.reverse_proxy.enabled INT 0
|
CONFIG proxy.config.reverse_proxy.enabled INT 0
|
||||||
CONFIG proxy.config.url_remap.remap_required INT 0
|
CONFIG proxy.config.url_remap.remap_required INT 0
|
||||||
|
@ -152,9 +162,9 @@ Enable SSL/TLS on memcached connection
|
||||||
--------------------------------------
|
--------------------------------------
|
||||||
|
|
||||||
By default, memcached connection is not encrypted. To enable
|
By default, memcached connection is not encrypted. To enable
|
||||||
encryption, use :option:`--tls-ticket-key-memcached-tls` for TLS
|
encryption, use ``tls`` keyword in
|
||||||
ticket key, and use :option:`--tls-session-cache-memcached-tls` for
|
:option:`--tls-ticket-key-memcached` for TLS ticket key, and
|
||||||
TLS session cache.
|
:option:`--tls-session-cache-memcached` for TLS session cache.
|
||||||
|
|
||||||
Specifying additional server certificates
|
Specifying additional server certificates
|
||||||
-----------------------------------------
|
-----------------------------------------
|
||||||
|
|
|
@ -140,7 +140,9 @@ HTTP/2 servers
|
||||||
Python 3.4 or later is required to use these objects. To
|
Python 3.4 or later is required to use these objects. To
|
||||||
explicitly configure nghttp2 build to use Python 3.4, specify the
|
explicitly configure nghttp2 build to use Python 3.4, specify the
|
||||||
``PYTHON`` variable to the path to Python 3.4 executable when
|
``PYTHON`` variable to the path to Python 3.4 executable when
|
||||||
invoking configure script like this::
|
invoking configure script like this:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ ./configure PYTHON=/usr/bin/python3.4
|
$ ./configure PYTHON=/usr/bin/python3.4
|
||||||
|
|
||||||
|
|
|
@ -7,7 +7,9 @@ the end of this page. It also resides in the examples directory in
|
||||||
the archive or repository.
|
the archive or repository.
|
||||||
|
|
||||||
This simple client takes a single HTTPS URI and retrieves the resource
|
This simple client takes a single HTTPS URI and retrieves the resource
|
||||||
at the URI. The synopsis is::
|
at the URI. The synopsis is:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ libevent-client HTTPS_URI
|
$ libevent-client HTTPS_URI
|
||||||
|
|
||||||
|
|
|
@ -10,7 +10,9 @@ archive or repository.
|
||||||
|
|
||||||
This simple server takes 3 arguments: The port number to listen on,
|
This simple server takes 3 arguments: The port number to listen on,
|
||||||
the path to your SSL/TLS private key file, and the path to your
|
the path to your SSL/TLS private key file, and the path to your
|
||||||
certificate file. The synopsis is::
|
certificate file. The synopsis is:
|
||||||
|
|
||||||
|
.. code-block:: text
|
||||||
|
|
||||||
$ libevent-server PORT /path/to/server.key /path/to/server.crt
|
$ libevent-server PORT /path/to/server.key /path/to/server.crt
|
||||||
|
|
||||||
|
|
|
@ -166,7 +166,8 @@ def format_text(text):
|
||||||
else:
|
else:
|
||||||
text = re.sub(r'\*', r'\*', text)
|
text = re.sub(r'\*', r'\*', text)
|
||||||
# markup option reference
|
# markup option reference
|
||||||
text = re.sub(r'(^|\s)(-[a-zA-Z0-9-]+)', r'\1:option:`\2`', text)
|
text = re.sub(r'(^|\s)(-[a-zA-Z0-9]|--[a-zA-Z0-9-]+)',
|
||||||
|
r'\1:option:`\2`', text)
|
||||||
# sphinx does not like markup like ':option:`-f`='. We need
|
# sphinx does not like markup like ':option:`-f`='. We need
|
||||||
# backslash between ` and =.
|
# backslash between ` and =.
|
||||||
text = re.sub(r'(:option:`.*?`)(\S)', r'\1\\\2', text)
|
text = re.sub(r'(:option:`.*?`)(\S)', r'\1\\\2', text)
|
||||||
|
|
Loading…
Reference in New Issue