diff --git a/doc/nghttp.h2r b/doc/nghttp.h2r index 92a8fa73..9d2a90ef 100644 --- a/doc/nghttp.h2r +++ b/doc/nghttp.h2r @@ -12,7 +12,9 @@ implementation. When connection is established, nghttp sends 5 PRIORITY frames to idle streams 3, 5, 7, 9 and 11 to create "anchor" nodes in dependency -tree:: +tree: + +.. code-block:: text +-----+ |id=0 | diff --git a/doc/nghttpx.h2r b/doc/nghttpx.h2r index a0621d3f..f8dc305b 100644 --- a/doc/nghttpx.h2r +++ b/doc/nghttpx.h2r @@ -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 header field to initiate server push: -.. code-block:: http +.. code-block:: text Link: ; rel=preload Link: ; rel=preload diff --git a/doc/sources/building-android-binary.rst b/doc/sources/building-android-binary.rst index 7de375e5..27e6d7b3 100644 --- a/doc/sources/building-android-binary.rst +++ b/doc/sources/building-android-binary.rst @@ -17,7 +17,9 @@ installed in the following way. First, let us introduce under ``$ANDROID_HOME/toolchain``. An user can freely choose the path for ``ANDROID_HOME``. For example, to install toolchain under ``$ANDROID_HOME/toolchain``, do this in the the directory where NDK is -unpacked:: +unpacked: + +.. code-block:: text $ build/tools/make-standalone-toolchain.sh \ --install-dir=$ANDROID_HOME/toolchain \ @@ -45,7 +47,9 @@ spdylay as well. Before running ``android-config`` and ``android-make``, ``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 @@ -159,6 +163,8 @@ then ``android-make`` to compile nghttp2 source files. If all went well, application binaries, such as nghttpx, are created 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 diff --git a/doc/sources/nghttpx-howto.rst b/doc/sources/nghttpx-howto.rst index 109bdb4e..5fa3002e 100644 --- a/doc/sources/nghttpx-howto.rst +++ b/doc/sources/nghttpx-howto.rst @@ -48,12 +48,16 @@ explicitly. The backend is supposed to be Web server. For example, to make nghttpx listen to encrypted HTTP/2 requests at port 8443, and a 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 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/ @@ -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 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 -like this:: +like this: + +.. code-block:: text $ 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 -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 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 -configuration items to edit:: +configuration items to edit: + +.. code-block:: text CONFIG proxy.config.reverse_proxy.enabled 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 -encryption, use :option:`--tls-ticket-key-memcached-tls` for TLS -ticket key, and use :option:`--tls-session-cache-memcached-tls` for -TLS session cache. +encryption, use ``tls`` keyword in +:option:`--tls-ticket-key-memcached` for TLS ticket key, and +:option:`--tls-session-cache-memcached` for TLS session cache. Specifying additional server certificates ----------------------------------------- diff --git a/doc/sources/python-apiref.rst b/doc/sources/python-apiref.rst index d9d8494c..d0a0b331 100644 --- a/doc/sources/python-apiref.rst +++ b/doc/sources/python-apiref.rst @@ -140,7 +140,9 @@ HTTP/2 servers Python 3.4 or later is required to use these objects. To explicitly configure nghttp2 build to use Python 3.4, specify the ``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 diff --git a/doc/sources/tutorial-client.rst b/doc/sources/tutorial-client.rst index 67d8b026..2262f675 100644 --- a/doc/sources/tutorial-client.rst +++ b/doc/sources/tutorial-client.rst @@ -7,7 +7,9 @@ the end of this page. It also resides in the examples directory in the archive or repository. 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 diff --git a/doc/sources/tutorial-server.rst b/doc/sources/tutorial-server.rst index e18ef0e8..31428376 100644 --- a/doc/sources/tutorial-server.rst +++ b/doc/sources/tutorial-server.rst @@ -10,7 +10,9 @@ archive or repository. 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 -certificate file. The synopsis is:: +certificate file. The synopsis is: + +.. code-block:: text $ libevent-server PORT /path/to/server.key /path/to/server.crt diff --git a/help2rst.py b/help2rst.py index ff160222..7706274a 100755 --- a/help2rst.py +++ b/help2rst.py @@ -166,7 +166,8 @@ def format_text(text): else: text = re.sub(r'\*', r'\*', text) # 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 # backslash between ` and =. text = re.sub(r'(:option:`.*?`)(\S)', r'\1\\\2', text)