docs 3

andgineer · Apr 10, 2019 · 239da5d · 239da5d
1 parent 58119cb
commit 239da5d
Show file tree

Hide file tree

Showing 9 changed files with 118 additions and 91 deletions.
diff --git a/README.rst b/README.rst
@@ -29,6 +29,6 @@ line (see ``--help``).
     :alt: MIT license
 
 .. |readthedocs| image:: https://readthedocs.org/projects/bombard/badge/?version=latest
-:target: https://bombard.readthedocs.io/en/latest/?badge=latest
-:alt: Documentation Status
+    :target: https://bombard.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
 
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -1,17 +1,29 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
-<!DOCTYPE html>
 
 <html xmlns="http://www.w3.org/1999/xhtml">
   <head>
-    <meta charset="utf-8" />
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+
     <title>bombard your app &#8212; bombard 1.2 documentation</title>
+
     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
+
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    './',
+        VERSION:     '1.2',
+        COLLAPSE_INDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+      };
+    </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/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
 
@@ -20,14 +32,13 @@
 
   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
 
-  </head><body>
+  </head>
+  <body role="document">
 
 
     <div class="document">
       <div class="documentwrapper">
         <div class="bodywrapper">
-
-
           <div class="body" role="main">
 
   <div class="section" id="bombard-your-app">
@@ -42,35 +53,39 @@ <h1>bombard your app<a class="headerlink" href="#bombard-your-app" title="Permal
 it in your IDE.</p>
 <p>The simplest (but not very useful) example</p>
 <blockquote>
-<div><dl class="simple">
-<dt>ammo:</dt><dd><dl class="simple">
-<dt>postsList:</dt><dd><p>url: “<a class="reference external" href="https://jsonplaceholder.typicode.com/posts">https://jsonplaceholder.typicode.com/posts</a>”</p>
-</dd>
+<div><dl class="docutils">
+<dt>ammo:</dt>
+<dd><dl class="first last docutils">
+<dt>postsList:</dt>
+<dd>url: &#8220;<a class="reference external" href="https://jsonplaceholder.typicode.com/posts">https://jsonplaceholder.typicode.com/posts</a>&#8220;</dd>
 </dl>
 </dd>
 </dl>
 </div></blockquote>
 <p>More complex example</p>
 <blockquote>
-<div><dl>
-<dt>supply:  # you can redefine it from command line (–supply)</dt><dd><p>host: <a class="reference external" href="https://jsonplaceholder.typicode.com/">https://jsonplaceholder.typicode.com/</a></p>
-</dd>
-<dt>prepare:</dt><dd><dl>
-<dt>postsList:</dt><dd><p>url: “{host}posts”
+<div><dl class="docutils">
+<dt>supply:  # you can redefine it from command line (&#8211;supply)</dt>
+<dd>host: <a class="reference external" href="https://jsonplaceholder.typicode.com/">https://jsonplaceholder.typicode.com/</a></dd>
+<dt>prepare:</dt>
+<dd><dl class="first last docutils">
+<dt>postsList:</dt>
+<dd><p class="first">url: &#8220;{host}posts&#8221;
 script: |</p>
-<blockquote>
-<div><dl class="simple">
-<dt>for post in resp[:3]:  # add getPost requests for 1st ten posts in the list</dt><dd><p>reload(ammo.getPost, id=post[‘id’])</p>
-</dd>
+<blockquote class="last">
+<div><dl class="docutils">
+<dt>for post in resp[:3]:  # add getPost requests for 1st ten posts in the list</dt>
+<dd>reload(ammo.getPost, id=post[&#8216;id&#8217;])</dd>
 </dl>
 </div></blockquote>
 </dd>
 </dl>
 </dd>
-<dt>ammo:</dt><dd><dl class="simple">
-<dt>getPost:</dt><dd><p>url: “{host}posts/{id}”
-headers: json</p>
-</dd>
+<dt>ammo:</dt>
+<dd><dl class="first last docutils">
+<dt>getPost:</dt>
+<dd>url: &#8220;{host}posts/{id}&#8221;
+headers: json</dd>
 </dl>
 </dd>
 </dl>
@@ -80,56 +95,50 @@ <h1>bombard your app<a class="headerlink" href="#bombard-your-app" title="Permal
 <div class="section" id="indices-and-tables">
 <h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
+<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
+<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
+<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
 </ul>
 </div>
 </div>
 
 
           </div>
-
         </div>
       </div>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="#">bombard</a></h1>
-
-
-
-
-
-
-
-
-<h3>Navigation</h3>
-
+  <h3><a href="contents.html">Table Of Contents</a></h3>
+  <ul>
+<li><a class="reference internal" href="#">bombard your app</a><ul>
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
+</ul>
+</li>
+</ul>
 <div class="relations">
 <h3>Related Topics</h3>
 <ul>
-  <li><a href="#">Documentation overview</a><ul>
+  <li><a href="contents.html">Documentation overview</a><ul>
   </ul></li>
 </ul>
 </div>
+  <div role="note" aria-label="source link">
+    <h3>This Page</h3>
+    <ul class="this-page-menu">
+      <li><a href="_sources/index.rst.txt"
+            rel="nofollow">Show Source</a></li>
+    </ul>
+   </div>
 <div id="searchbox" style="display: none" role="search">
   <h3>Quick search</h3>
-    <div class="searchformwrapper">
     <form class="search" action="search.html" method="get">
-      <input type="text" name="q" />
-      <input type="submit" value="Go" />
+      <div><input type="text" name="q" /></div>
+      <div><input type="submit" value="Go" /></div>
+      <input type="hidden" name="check_keywords" value="yes" />
+      <input type="hidden" name="area" value="default" />
     </form>
-    </div>
 </div>
 <script type="text/javascript">$('#searchbox').show(0);</script>
-
-
-
-
-
-
-
-
         </div>
       </div>
       <div class="clearer"></div>
@@ -138,8 +147,8 @@ <h3>Quick search</h3>
       &copy;2019, Andrey Sorokin.
 
       |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 2.0.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
+      Powered by <a href="http://sphinx-doc.org/">Sphinx 1.5.1</a>
+      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
 
       |
       <a href="_sources/index.rst.txt"

diff --git a/docs/_build/html/objects.inv b/docs/_build/html/objects.inv
diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js
diff --git a/docs/contents.rst b/docs/contents.rst
@@ -1,42 +1,13 @@
-bombard your app
-================
-Bombard is a pure Python application to bombard with
-hundreds of HTTP-requests.
+bombard
+=======
 
-This is tool for stress-testing with extremely simple
-configuration.
-
-You write requests in simple yaml-file (`bombard campaign book`).
-And can include a couple of Python lines in it.
-
-If you need more logic you can include external Python file and debug
-it in your IDE.
-
-The simplest (but not very useful) example
-
-   ammo:
-      postsList:
-         url: "https://jsonplaceholder.typicode.com/posts"
-
-More complex example
-
-   supply:  # you can redefine it from command line (--supply)
-     host: https://jsonplaceholder.typicode.com/
-   prepare:
-     postsList:
-       url: "{host}posts"
-       script: |
-         for post in resp[:3]:  # add getPost requests for 1st ten posts in the list
-           reload(ammo.getPost, id=post['id'])
-   ammo:
-     getPost:
-       url: "{host}posts/{id}"
-       headers: json
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
+   index
+
 
 
 Indices and tables

diff --git a/docs/index.rst b/docs/index.rst
@@ -0,0 +1,47 @@
+bombard your app
+================
+Bombard is a pure Python application to bombard with
+hundreds of HTTP-requests.
+
+This is tool for stress-testing with extremely simple
+configuration.
+
+You write requests in simple yaml-file (`bombard campaign book`).
+And can include a couple of Python lines in it.
+
+If you need more logic you can include external Python file and debug
+it in your IDE.
+
+The simplest (but not very useful) example
+
+   ammo:
+      postsList:
+         url: "https://jsonplaceholder.typicode.com/posts"
+
+More complex example
+
+   supply:  # you can redefine it from command line (--supply)
+     host: https://jsonplaceholder.typicode.com/
+   prepare:
+     postsList:
+       url: "{host}posts"
+       script: |
+         for post in resp[:3]:  # add getPost requests for 1st ten posts in the list
+           reload(ammo.getPost, id=post['id'])
+   ammo:
+     getPost:
+       url: "{host}posts/{id}"
+       headers: json
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+------------------
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
diff --git a/setup.py b/setup.py
@@ -6,7 +6,7 @@
 
 setuptools.setup(
     name='bombard',
-    version='1.1',
+    version='1.2',
     # scripts=['bin/bombard'],
     entry_points={
         'console_scripts': [