pubish sdist and wheel to pypi; increment version

cs01 · Jun 14, 2019 · c94add5 · c94add5
1 parent 6308ee9
commit c94add5
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 45 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@ pygdbmi - Get Structured Output from GDB's Machine Interface
 </a>
 
 <a href="https://pypi.org/project/pygdbmi/">
-<img src="https://img.shields.io/badge/pypi-v0.9.0.1-blue.svg"/>
+<img src="https://img.shields.io/badge/pypi-v0.9.0.2-blue.svg"/>
 </a>
 
 <img src="https://img.shields.io/badge/python-2.7,3.4,3.5,3.6,pypy-blue.svg"/>

diff --git a/docs/gdbcontroller.html b/docs/gdbcontroller.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.5.5.dev14+gca359aa" />
+<meta name="generator" content="pdoc 0.6.2" />
 <title>pygdbmi.gdbcontroller API documentation</title>
 <meta name="description" content="GdbController class to programatically run gdb and get structured output" />
 <link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
@@ -17,7 +17,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title"><code>pygdbmi.gdbcontroller</code> module</h1>
+<h1 class="title">Module <code>pygdbmi.gdbcontroller</code></h1>
 </header>
 <section id="section-intro">
 <p>GdbController class to programatically run gdb and get structured output</p>
@@ -559,7 +559,10 @@ <h2 id="args">Args</h2>
 <dd>Print verbose output if True</dd>
 </dl>
 <h2 id="returns">Returns</h2>
-<p>New GdbController object</p></section>
+<dl>
+<dt><code>New</code> <a title="pygdbmi.gdbcontroller.GdbController" href="#pygdbmi.gdbcontroller.GdbController"><code>GdbController</code></a> <code>object</code></dt>
+<dd>&nbsp;</dd>
+</dl></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">class GdbController:
@@ -960,11 +963,8 @@ <h3>Methods</h3>
 <span>def <span class="ident">exit</span></span>(<span>self)</span>
 </code></dt>
 <dd>
-<section class="desc"><dl>
-<dt>Terminate gdb process</dt>
-<dt><strong><code>Returns</code></strong> :&ensp;<code>None</code></dt>
-<dd>&nbsp;</dd>
-</dl></section>
+<section class="desc"><p>Terminate gdb process
+Returns: None</p></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def exit(self):
@@ -992,12 +992,21 @@ <h2 id="args">Args</h2>
 </dl>
 <p>after timeout_sec</p>
 <h2 id="returns">Returns</h2>
-<p>List of parsed GDB responses, returned from gdbmiparser.parse_response, with the
-additional key 'stream' which is either 'stdout' or 'stderr'</p>
+<dl>
+<dt><code>List</code> of <code>parsed</code> <code>GDB</code> <code>responses</code>, <code>returned</code> <code>from</code> <code>gdbmiparser.parse_response</code>, <code>with</code> <code>the</code></dt>
+<dd>&nbsp;</dd>
+<dt><code>additional</code> <code>key</code> <code>'stream'</code> <code>which</code> <code>is</code> <code>either</code> <code>'stdout'</code> or <code>'stderr'</code></dt>
+<dd>&nbsp;</dd>
+</dl>
 <h2 id="raises">Raises</h2>
-<p>GdbTimeoutError if response is not received within timeout_sec
-ValueError if select returned unexpected file number
-NoGdbProcessError if there is no gdb subprocess running</p></section>
+<dl>
+<dt><a title="pygdbmi.gdbcontroller.GdbTimeoutError" href="#pygdbmi.gdbcontroller.GdbTimeoutError"><code>GdbTimeoutError</code></a> <code>if</code> <code>response</code> <code>is</code> <code>not</code> <code>received</code> <code>within</code> <code>timeout_sec</code></dt>
+<dd>&nbsp;</dd>
+<dt><code>ValueError</code> <code>if</code> <code>select</code> <code>returned</code> <code>unexpected</code> <code>file</code> <code>number</code></dt>
+<dd>&nbsp;</dd>
+<dt><a title="pygdbmi.gdbcontroller.NoGdbProcessError" href="#pygdbmi.gdbcontroller.NoGdbProcessError"><code>NoGdbProcessError</code></a> <code>if</code> <code>there</code> <code>is</code> <code>no</code> <code>gdb</code> <code>subprocess</code> <code>running</code></dt>
+<dd>&nbsp;</dd>
+</dl></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def get_gdb_response(
@@ -1198,10 +1207,17 @@ <h2 id="args">Args</h2>
 </dl>
 <p>this can be false, and the reading thread read the output.</p>
 <h2 id="returns">Returns</h2>
-<p>List of parsed gdb responses if read_response is True, otherwise []</p>
+<dl>
+<dt><code>List</code> of <code>parsed</code> <code>gdb</code> <code>responses</code> <code>if</code> <code>read_response</code> <code>is</code> <code>True</code>, <code>otherwise</code> []</dt>
+<dd>&nbsp;</dd>
+</dl>
 <h2 id="raises">Raises</h2>
-<p>NoGdbProcessError if there is no gdb subprocess running
-TypeError if mi_cmd_to_write is not valid</p></section>
+<dl>
+<dt><a title="pygdbmi.gdbcontroller.NoGdbProcessError" href="#pygdbmi.gdbcontroller.NoGdbProcessError"><code>NoGdbProcessError</code></a> <code>if</code> <code>there</code> <code>is</code> <code>no</code> <code>gdb</code> <code>subprocess</code> <code>running</code></dt>
+<dd>&nbsp;</dd>
+<dt><code>TypeError</code> <code>if</code> <code>mi_cmd_to_write</code> <code>is</code> <code>not</code> <code>valid</code></dt>
+<dd>&nbsp;</dd>
+</dl></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def write(
@@ -1358,7 +1374,7 @@ <h4><code><a title="pygdbmi.gdbcontroller.NoGdbProcessError" href="#pygdbmi.gdbc
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.5.dev14+gca359aa</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.2</a>.</p>
 </footer>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 <script>hljs.initHighlightingOnLoad()</script>

diff --git a/docs/gdbmiparser.html b/docs/gdbmiparser.html
@@ -3,7 +3,7 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.5.5.dev14+gca359aa" />
+<meta name="generator" content="pdoc 0.6.2" />
 <title>pygdbmi.gdbmiparser API documentation</title>
 <meta name="description" content="Python parser for gdb&#39;s machine interface interpreter …" />
 <link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
@@ -17,7 +17,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title"><code>pygdbmi.gdbmiparser</code> module</h1>
+<h1 class="title">Module <code>pygdbmi.gdbmiparser</code></h1>
 </header>
 <section id="section-intro">
 <p>Python parser for gdb's machine interface interpreter.</p>
@@ -409,12 +409,9 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 <span>def <span class="ident">assert_match</span></span>(<span>actual_char_or_str, expected_char_or_str)</span>
 </code></dt>
 <dd>
-<section class="desc"><dl>
-<dt>If values don't match, print them and raise a ValueError, otherwise,</dt>
-<dt>continue</dt>
-<dt><strong><code>Raises</code></strong> :&ensp;<code>ValueError</code> <code>if</code> <code>arguments</code> <code>do</code> <code>not</code> <code>match</code></dt>
-<dd>&nbsp;</dd>
-</dl></section>
+<section class="desc"><p>If values don't match, print them and raise a ValueError, otherwise,
+continue
+Raises: ValueError if arguments do not match</p></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def assert_match(actual_char_or_str, expected_char_or_str):
@@ -443,10 +440,16 @@ <h2 id="args">Args</h2>
 <dd>String output from gdb</dd>
 </dl>
 <h2 id="returns">Returns</h2>
-<p>dict with the following keys:
-type (either 'notify', 'result', 'console', 'log', 'target', 'done'),
-message (str or None),
-payload (str, list, dict, or None)</p></section>
+<dl>
+<dt><code>dict</code> <code>with</code> <code>the</code> <code>following</code> <code>keys</code>:</dt>
+<dd>&nbsp;</dd>
+<dt><code>type</code> (<code>either</code> <code>'notify'</code>, <code>'result'</code>, <code>'console'</code>, <code>'log'</code>, <code>'target'</code>, <code>'done'</code>),</dt>
+<dd>&nbsp;</dd>
+<dt><code>message</code> (<code>str</code> or <code>None</code>),</dt>
+<dd>&nbsp;</dd>
+<dt><code>payload</code> (<code>str</code>, <code>list</code>, <code>dict</code>, or <code>None</code>)</dt>
+<dd>&nbsp;</dd>
+</dl></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def parse_response(gdb_mi_text):
@@ -518,11 +521,8 @@ <h2 id="returns">Returns</h2>
 <span>def <span class="ident">response_is_finished</span></span>(<span>gdb_mi_text)</span>
 </code></dt>
 <dd>
-<section class="desc"><dl>
-<dt>Return true if the gdb mi response is ending</dt>
-<dt><strong><code>Returns</code></strong> :&ensp;<code>True</code> <code>if</code> <code>gdb</code> <code>response</code> <code>is</code> <code>finished</code></dt>
-<dd>&nbsp;</dd>
-</dl></section>
+<section class="desc"><p>Return true if the gdb mi response is ending
+Returns: True if gdb response is finished</p></section>
 <details class="source">
 <summary>Source code</summary>
 <pre><code class="python">def response_is_finished(gdb_mi_text):
@@ -562,7 +562,7 @@ <h1>Index</h1>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.5.dev14+gca359aa</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.2</a>.</p>
 </footer>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 <script>hljs.initHighlightingOnLoad()</script>

diff --git a/docs/index.html b/docs/index.html
@@ -3,9 +3,11 @@
 <head>
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
-<meta name="generator" content="pdoc 0.5.5.dev14+gca359aa" />
+<meta name="generator" content="pdoc 0.6.2" />
 <title>pygdbmi API documentation</title>
-<meta name="description" content=".. include:: ../README.md" />
+<meta name="description" content="&lt;h1 align=&#34;center&#34;&gt;
+pygdbmi - Get Structured Output from GDB&#39;s Machine Interface
+&lt;/h1&gt; …" />
 <link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
 <link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
 <link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
@@ -17,7 +19,7 @@
 <main>
 <article id="content">
 <header>
-<h1 class="title"><code>pygdbmi</code> module</h1>
+<h1 class="title">Module <code>pygdbmi</code></h1>
 </header>
 <section id="section-intro">
 <h1 align="center">
@@ -28,7 +30,7 @@ <h1 align="center">
 <img src="https://travis-ci.org/cs01/pygdbmi.svg?branch=master" />
 </a>
 <a href="https://pypi.org/project/pygdbmi/">
-<img src="https://img.shields.io/badge/pypi-v0.9.0.1-blue.svg"/>
+<img src="https://img.shields.io/badge/pypi-v0.9.0.2-blue.svg"/>
 </a>
 <img src="https://img.shields.io/badge/python-2.7,3.4,3.5,3.6,pypy-blue.svg"/>
 <a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" /></a>
@@ -168,7 +170,7 @@ <h2 id="authors">Authors</h2>
 .. include:: ../README.md
 &#34;&#34;&#34;
 __title__ = &#34;pygdbmi&#34;
-__version__ = &#34;0.9.0.1&#34;
+__version__ = &#34;0.9.0.2&#34;
 __author__ = &#34;Chad Smith&#34;
 __copyright__ = &#34;Copyright Chad Smith&#34;
 __pdoc__ = {&#34;StringStream&#34;: False, &#34;printcolor&#34;: False}</code></pre>
@@ -197,7 +199,21 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
 <nav id="sidebar">
 <h1>Index</h1>
 <div class="toc">
-<ul></ul>
+<ul>
+<li><a href="#whats-in-the-box">What's in the box?</a></li>
+<li><a href="#installation">Installation</a></li>
+<li><a href="#compatibility">Compatibility</a><ul>
+<li><a href="#operating-systems">Operating Systems</a></li>
+<li><a href="#gdb-versions">gdb versions</a></li>
+</ul>
+</li>
+<li><a href="#examples">Examples</a></li>
+<li><a href="#programmatic-control-over-gdb">Programmatic Control Over gdb</a></li>
+<li><a href="#parsed-output-format">Parsed Output Format</a></li>
+<li><a href="#contributing">Contributing</a></li>
+<li><a href="#projects-using-pygdbmi">Projects Using pygdbmi</a></li>
+<li><a href="#authors">Authors</a></li>
+</ul>
 </div>
 <ul id="index">
 <li><h3><a href="#header-submodules">Sub-modules</a></h3>
@@ -210,7 +226,7 @@ <h1>Index</h1>
 </nav>
 </main>
 <footer id="footer">
-<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.5.dev14+gca359aa</a>.</p>
+<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.2</a>.</p>
 </footer>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 <script>hljs.initHighlightingOnLoad()</script>

diff --git a/makefile b/makefile
@@ -15,7 +15,7 @@ build: clean
 	python setup.py --quiet sdist bdist_wheel
 	twine check dist/*
 
-publish: test build
+publish:  build
 	twine upload dist/*
 
 testpublish: test clean

diff --git a/pygdbmi/__init__.py b/pygdbmi/__init__.py
@@ -2,7 +2,7 @@
 .. include:: ../README.md
 """
 __title__ = "pygdbmi"
-__version__ = "0.9.0.1"
+__version__ = "0.9.0.2"
 __author__ = "Chad Smith"
 __copyright__ = "Copyright Chad Smith"
 __pdoc__ = {"StringStream": False, "printcolor": False}