/usr/share/doc/php-guzzlehttp-ringphp/html/spec.html is in php-guzzlehttp-ringphp-doc 1.1.0-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 | <!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Specification — RingPHP</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="top" title="RingPHP" href="index.html"/>
<link rel="next" title="Futures" href="futures.html"/>
<link rel="prev" title="RingPHP" href="index.html"/>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> RingPHP
</a>
<div class="version">
1.0.0-alpha
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="">Specification</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#handlers">Handlers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#requests">Requests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#client-specific-options">Client Specific Options</a></li>
<li class="toctree-l3"><a class="reference internal" href="#server-specific-options">Server Specific Options</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#responses">Responses</a></li>
<li class="toctree-l2"><a class="reference internal" href="#middleware">Middleware</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="futures.html">Futures</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_middleware.html">Client Middleware</a></li>
<li class="toctree-l1"><a class="reference internal" href="client_handlers.html">Client Handlers</a></li>
<li class="toctree-l1"><a class="reference internal" href="testing.html">Testing</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">RingPHP</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li>Specification</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/spec.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="specification">
<h1>Specification<a class="headerlink" href="#specification" title="Permalink to this headline">¶</a></h1>
<p>RingPHP applications consist of handlers, requests, responses, and
middleware.</p>
<div class="section" id="handlers">
<h2>Handlers<a class="headerlink" href="#handlers" title="Permalink to this headline">¶</a></h2>
<p>Handlers are implemented as a PHP <code class="docutils literal"><span class="pre">callable</span></code> that accept a request array
and return a response array (<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureArrayInterface</span></code>).</p>
<p>For example:</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Future\CompletedFutureArray</span><span class="p">;</span>
<span class="nv">$mockHandler</span> <span class="o">=</span> <span class="k">function</span> <span class="p">(</span><span class="k">array</span> <span class="nv">$request</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">new</span> <span class="nx">CompletedFutureArray</span><span class="p">([</span>
<span class="s1">'status'</span> <span class="o">=></span> <span class="mi">200</span><span class="p">,</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'X-Foo'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'Bar'</span><span class="p">]],</span>
<span class="s1">'body'</span> <span class="o">=></span> <span class="s1">'Hello!'</span>
<span class="p">]);</span>
<span class="p">};</span>
</pre></div>
</div>
<p>This handler returns the same response each time it is invoked. All RingPHP
handlers must return a <code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureArrayInterface</span></code>. Use
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\CompletedFutureArray</span></code> when returning a response that
has already completed.</p>
</div>
<div class="section" id="requests">
<h2>Requests<a class="headerlink" href="#requests" title="Permalink to this headline">¶</a></h2>
<p>A request array is a PHP associative array that contains the configuration
settings need to send a request.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="nv">$request</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">'http_method'</span> <span class="o">=></span> <span class="s1">'GET'</span><span class="p">,</span>
<span class="s1">'scheme'</span> <span class="o">=></span> <span class="s1">'http'</span><span class="p">,</span>
<span class="s1">'uri'</span> <span class="o">=></span> <span class="s1">'/'</span><span class="p">,</span>
<span class="s1">'body'</span> <span class="o">=></span> <span class="s1">'hello!'</span><span class="p">,</span>
<span class="s1">'client'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'timeout'</span> <span class="o">=></span> <span class="mf">1.0</span><span class="p">],</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span>
<span class="s1">'host'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'httpbin.org'</span><span class="p">],</span>
<span class="s1">'X-Foo'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'baz'</span><span class="p">,</span> <span class="s1">'bar'</span><span class="p">]</span>
<span class="p">]</span>
<span class="p">];</span>
</pre></div>
</div>
<p>The request array contains the following key value pairs:</p>
<dl class="docutils">
<dt>request_method</dt>
<dd>(string, required) The HTTP request method, must be all caps corresponding
to a HTTP request method, such as <code class="docutils literal"><span class="pre">GET</span></code> or <code class="docutils literal"><span class="pre">POST</span></code>.</dd>
<dt>scheme</dt>
<dd>(string) The transport protocol, must be one of <code class="docutils literal"><span class="pre">http</span></code> or <code class="docutils literal"><span class="pre">https</span></code>.
Defaults to <code class="docutils literal"><span class="pre">http</span></code>.</dd>
<dt>uri</dt>
<dd>(string, required) The request URI excluding the query string. Must
start with “/”.</dd>
<dt>query_string</dt>
<dd>(string) The query string, if present (e.g., <code class="docutils literal"><span class="pre">foo=bar</span></code>).</dd>
<dt>version</dt>
<dd>(string) HTTP protocol version. Defaults to <code class="docutils literal"><span class="pre">1.1</span></code>.</dd>
<dt>headers</dt>
<dd>(required, array) Associative array of headers. Each key represents the
header name. Each value contains an array of strings where each entry of
the array SHOULD be sent over the wire on a separate header line.</dd>
<dt>body</dt>
<dd>(string, fopen resource, <code class="docutils literal"><span class="pre">Iterator</span></code>, <code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code>)
The body of the request, if present. Can be a string, resource returned
from fopen, an <code class="docutils literal"><span class="pre">Iterator</span></code> that yields chunks of data, an object that
implemented <code class="docutils literal"><span class="pre">__toString</span></code>, or a <code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code>.</dd>
<dt>future</dt>
<dd><p class="first">(bool, string) Controls the asynchronous behavior of a response.</p>
<p>Set to <code class="docutils literal"><span class="pre">true</span></code> or omit the <code class="docutils literal"><span class="pre">future</span></code> option to <em>request</em> that a request
will be completed asynchronously. Keep in mind that your request might not
necessarily be completed asynchronously based on the handler you are using.
Set the <code class="docutils literal"><span class="pre">future</span></code> option to <code class="docutils literal"><span class="pre">false</span></code> to request that a synchronous
response be provided.</p>
<p>You can provide a string value to specify fine-tuned future behaviors that
may be specific to the underlying handlers you are using. There are,
however, some common future options that handlers should implement if
possible.</p>
<dl class="docutils">
<dt>lazy</dt>
<dd>Requests that the handler does not open and send the request
immediately, but rather only opens and sends the request once the
future is dereferenced. This option is often useful for sending a large
number of requests concurrently to allow handlers to take better
advantage of non-blocking transfers by first building up a pool of
requests.</dd>
</dl>
<p>If an handler does not implement or understand a provided string value,
then the request MUST be treated as if the user provided <code class="docutils literal"><span class="pre">true</span></code> rather
than the string value.</p>
<p class="last">Future responses created by asynchronous handlers MUST attempt to complete
any outstanding future responses when they are destructed. Asynchronous
handlers MAY choose to automatically complete responses when the number
of outstanding requests reaches an handler-specific threshold.</p>
</dd>
</dl>
<div class="section" id="client-specific-options">
<h3>Client Specific Options<a class="headerlink" href="#client-specific-options" title="Permalink to this headline">¶</a></h3>
<p>The following options are only used in ring client handlers.</p>
<dl class="docutils" id="client-options">
<dt>client</dt>
<dd><p class="first">(array) Associative array of client specific transfer options. The
<code class="docutils literal"><span class="pre">client</span></code> request key value pair can contain the following keys:</p>
<dl class="last docutils">
<dt>cert</dt>
<dd>(string, array) Set to a string to specify the path to a file
containing a PEM formatted SSL client side certificate. If a password
is required, then set <code class="docutils literal"><span class="pre">cert</span></code> to an array containing the path to the
PEM file in the first array element followed by the certificate
password in the second array element.</dd>
<dt>connect_timeout</dt>
<dd>(float) Float describing the number of seconds to wait while trying to
connect to a server. Use <code class="docutils literal"><span class="pre">0</span></code> to wait indefinitely (the default
behavior).</dd>
<dt>debug</dt>
<dd><p class="first">(bool, fopen() resource) Set to true or set to a PHP stream returned by
fopen() to enable debug output with the handler used to send a request.
If set to <code class="docutils literal"><span class="pre">true</span></code>, the output is written to PHP’s STDOUT. If a PHP
<code class="docutils literal"><span class="pre">fopen</span></code> resource handle is provided, the output is written to the
stream.</p>
<p class="last">“Debug output” is handler specific: different handlers will yield
different output and various various level of detail. For example, when
using cURL to transfer requests, cURL’s <a class="reference external" href="http://curl.haxx.se/libcurl/c/CURLOPT_VERBOSE.html">CURLOPT_VERBOSE</a>
will be used. When using the PHP stream wrapper, <a class="reference external" href="http://php.net/manual/en/function.stream-notification-callback.php">stream notifications</a>
will be emitted.</p>
</dd>
<dt>decode_content</dt>
<dd>(bool) Specify whether or not <code class="docutils literal"><span class="pre">Content-Encoding</span></code> responses
(gzip, deflate, etc.) are automatically decoded. Set to <code class="docutils literal"><span class="pre">true</span></code> to
automatically decode encoded responses. Set to <code class="docutils literal"><span class="pre">false</span></code> to not decode
responses. By default, content is <em>not</em> decoded automatically.</dd>
<dt>delay</dt>
<dd>(int) The number of milliseconds to delay before sending the request.
This is often used for delaying before retrying a request. Handlers
SHOULD implement this if possible, but it is not a strict requirement.</dd>
<dt>progress</dt>
<dd><p class="first">(function) Defines a function to invoke when transfer progress is made.
The function accepts the following arguments:</p>
<ol class="last arabic simple">
<li>The total number of bytes expected to be downloaded</li>
<li>The number of bytes downloaded so far</li>
<li>The number of bytes expected to be uploaded</li>
<li>The number of bytes uploaded so far</li>
</ol>
</dd>
<dt>proxy</dt>
<dd><p class="first">(string, array) Pass a string to specify an HTTP proxy, or an
associative array to specify different proxies for different protocols
where the scheme is the key and the value is the proxy address.</p>
<div class="last highlight-php"><div class="highlight"><pre><span class="nv">$request</span> <span class="o">=</span> <span class="p">[</span>
<span class="s1">'http_method'</span> <span class="o">=></span> <span class="s1">'GET'</span><span class="p">,</span>
<span class="s1">'headers'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'host'</span> <span class="o">=></span> <span class="p">[</span><span class="s1">'httpbin.org'</span><span class="p">]],</span>
<span class="s1">'client'</span> <span class="o">=></span> <span class="p">[</span>
<span class="c1">// Use different proxies for different URI schemes.</span>
<span class="s1">'proxy'</span> <span class="o">=></span> <span class="p">[</span>
<span class="s1">'http'</span> <span class="o">=></span> <span class="s1">'http://proxy.example.com:5100'</span><span class="p">,</span>
<span class="s1">'https'</span> <span class="o">=></span> <span class="s1">'https://proxy.example.com:6100'</span>
<span class="p">]</span>
<span class="p">]</span>
<span class="p">];</span>
</pre></div>
</div>
</dd>
<dt>ssl_key</dt>
<dd>(string, array) Specify the path to a file containing a private SSL key
in PEM format. If a password is required, then set to an array
containing the path to the SSL key in the first array element followed
by the password required for the certificate in the second element.</dd>
<dt>save_to</dt>
<dd>(string, fopen resource, <code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code>)
Specifies where the body of the response is downloaded. Pass a string to
open a local file on disk and save the output to the file. Pass an fopen
resource to save the output to a PHP stream resource. Pass a
<code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code> to save the output to a Guzzle
StreamInterface. Omitting this option will typically save the body of a
response to a PHP temp stream.</dd>
<dt>stream</dt>
<dd>(bool) Set to true to stream a response rather than download it all
up-front. This option will only be utilized when the corresponding
handler supports it.</dd>
<dt>timeout</dt>
<dd>(float) Float describing the timeout of the request in seconds. Use 0 to
wait indefinitely (the default behavior).</dd>
<dt>verify</dt>
<dd>(bool, string) Describes the SSL certificate verification behavior of a
request. Set to true to enable SSL certificate verification using the
system CA bundle when available (the default). Set to false to disable
certificate verification (this is insecure!). Set to a string to provide
the path to a CA bundle on disk to enable verification using a custom
certificate.</dd>
<dt>version</dt>
<dd>(string) HTTP protocol version to use with the request.</dd>
</dl>
</dd>
</dl>
</div>
<div class="section" id="server-specific-options">
<h3>Server Specific Options<a class="headerlink" href="#server-specific-options" title="Permalink to this headline">¶</a></h3>
<p>The following options are only used in ring server handlers.</p>
<dl class="docutils">
<dt>server_port</dt>
<dd>(integer) The port on which the request is being handled. This is only
used with ring servers, and is required.</dd>
<dt>server_name</dt>
<dd>(string) The resolved server name, or the server IP address. Required when
using a Ring server.</dd>
<dt>remote_addr</dt>
<dd>(string) The IP address of the client or the last proxy that sent the
request. Required when using a Ring server.</dd>
</dl>
</div>
</div>
<div class="section" id="responses">
<h2>Responses<a class="headerlink" href="#responses" title="Permalink to this headline">¶</a></h2>
<p>A response is an array-like object that implements
<code class="docutils literal"><span class="pre">GuzzleHttp\Ring\Future\FutureArrayInterface</span></code>. Responses contain the
following key value pairs:</p>
<dl class="docutils">
<dt>body</dt>
<dd>(string, fopen resource, <code class="docutils literal"><span class="pre">Iterator</span></code>, <code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code>)
The body of the response, if present. Can be a string, resource returned
from fopen, an <code class="docutils literal"><span class="pre">Iterator</span></code> that yields chunks of data, an object that
implemented <code class="docutils literal"><span class="pre">__toString</span></code>, or a <code class="docutils literal"><span class="pre">GuzzleHttp\Stream\StreamInterface</span></code>.</dd>
<dt>effective_url</dt>
<dd>(string) The URL that returned the resulting response.</dd>
<dt>error</dt>
<dd>(<code class="docutils literal"><span class="pre">\Exception</span></code>) Contains an exception describing any errors that were
encountered during the transfer.</dd>
<dt>headers</dt>
<dd>(Required, array) Associative array of headers. Each key represents the
header name. Each value contains an array of strings where each entry of
the array is a header line. The headers array MAY be an empty array in the
event an error occurred before a response was received.</dd>
<dt>reason</dt>
<dd>(string) Optional reason phrase. This option should be provided when the
reason phrase does not match the typical reason phrase associated with the
<code class="docutils literal"><span class="pre">status</span></code> code. See <a class="reference external" href="http://tools.ietf.org/html/rfc7231#section-6.1">RFC 7231</a>
for a list of HTTP reason phrases mapped to status codes.</dd>
<dt>status</dt>
<dd>(Required, integer) The HTTP status code. The status code MAY be set to
<code class="docutils literal"><span class="pre">null</span></code> in the event an error occurred before a response was received
(e.g., a networking error).</dd>
<dt>transfer_stats</dt>
<dd>(array) Provides an associative array of arbitrary transfer statistics if
provided by the underlying handler.</dd>
<dt>version</dt>
<dd>(string) HTTP protocol version. Defaults to <code class="docutils literal"><span class="pre">1.1</span></code>.</dd>
</dl>
</div>
<div class="section" id="middleware">
<h2>Middleware<a class="headerlink" href="#middleware" title="Permalink to this headline">¶</a></h2>
<p>Ring middleware augments the functionality of handlers by invoking them in the
process of generating responses. Middleware is typically implemented as a
higher-order function that takes one or more handlers as arguments followed by
an optional associative array of options as the last argument, returning a new
handler with the desired compound behavior.</p>
<p>Here’s an example of a middleware that adds a Content-Type header to each
request.</p>
<div class="highlight-php"><div class="highlight"><pre><span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Client\CurlHandler</span><span class="p">;</span>
<span class="k">use</span> <span class="nx">GuzzleHttp\Ring\Core</span><span class="p">;</span>
<span class="nv">$contentTypeHandler</span> <span class="o">=</span> <span class="k">function</span><span class="p">(</span><span class="nx">callable</span> <span class="nv">$handler</span><span class="p">,</span> <span class="nv">$contentType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="k">function</span> <span class="p">(</span><span class="k">array</span> <span class="nv">$request</span><span class="p">)</span> <span class="k">use</span> <span class="p">(</span><span class="nv">$handler</span><span class="p">,</span> <span class="nv">$contentType</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="nv">$handler</span><span class="p">(</span><span class="nx">Core</span><span class="o">::</span><span class="na">setHeader</span><span class="p">(</span><span class="s1">'Content-Type'</span><span class="p">,</span> <span class="nv">$contentType</span><span class="p">));</span>
<span class="p">};</span>
<span class="p">};</span>
<span class="nv">$baseHandler</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">CurlHandler</span><span class="p">();</span>
<span class="nv">$wrappedHandler</span> <span class="o">=</span> <span class="nv">$contentTypeHandler</span><span class="p">(</span><span class="nv">$baseHandler</span><span class="p">,</span> <span class="s1">'text/html'</span><span class="p">);</span>
<span class="nv">$response</span> <span class="o">=</span> <span class="nv">$wrappedHandler</span><span class="p">([</span><span class="sd">/** request hash **/</span><span class="p">]);</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="futures.html" class="btn btn-neutral float-right" title="Futures" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="RingPHP" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2014, Michael Dowling.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.StickyNav.enable();
});
</script>
</body>
</html>
|