Skip to content

Commit

Permalink
include readme in pdoc docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@cs01
cs01 committed Apr 30, 2019
1 parent 534286d commit 6308ee9
Show file tree
Hide file tree
Showing 6 changed files with 175 additions and 89 deletions.
4 changes: 3 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ pygdbmi - Get Structured Output from GDB's Machine Interface
<a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" /></a>
</p>

**API Documentation**: https://cs01.github.io/pygdbmi/
**Documentation** https://cs01.github.io/pygdbmi

**Source Code** https://github.com/cs01/pygdbmi

---

Expand Down
77 changes: 18 additions & 59 deletions docs/gdbcontroller.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
<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.4" />
<meta name="generator" content="pdoc 0.5.5.dev14+gca359aa" />
<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'>
<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">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.name small{font-weight:normal}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
Expand Down Expand Up @@ -540,6 +540,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pygdbmi.gdbcontroller.GdbController"><code class="flex name class">
<span>class <span class="ident">GdbController</span></span>
<span>(</span><span>gdb_path='gdb', gdb_args=None, time_to_check_for_additional_output_sec=0.2, rr=False, verbose=False)</span>
</code></dt>
<dd>
<section class="desc"><p>Run gdb as a subprocess. Send commands and receive structured output.
Expand Down Expand Up @@ -955,59 +956,6 @@ <h2 id="returns">Returns</h2>
</details>
<h3>Methods</h3>
<dl>
<dt id="pygdbmi.gdbcontroller.GdbController.__init__"><code class="name flex">
<span>def <span class="ident">__init__</span></span>(<span>self, gdb_path=&#39;gdb&#39;, gdb_args=None, time_to_check_for_additional_output_sec=0.2, rr=False, verbose=False)</span>
</code></dt>
<dd>
<section class="desc"><p>Initialize self.
See help(type(self)) for accurate signature.</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def __init__(
self,
gdb_path=&#34;gdb&#34;,
gdb_args=None,
time_to_check_for_additional_output_sec=DEFAULT_TIME_TO_CHECK_FOR_ADDITIONAL_OUTPUT_SEC,
rr=False,
verbose=False,
):
if gdb_args is None:
default_gdb_args = [&#34;--nx&#34;, &#34;--quiet&#34;, &#34;--interpreter=mi2&#34;]
gdb_args = default_gdb_args

self.verbose = verbose
self.abs_gdb_path = None # abs path to gdb executable
self.cmd = [] # the shell command to run gdb
self.time_to_check_for_additional_output_sec = (
time_to_check_for_additional_output_sec
)
self.gdb_process = None
self._allow_overwrite_timeout_times = (
self.time_to_check_for_additional_output_sec &gt; 0
)

if rr:
self.cmd = [&#34;rr&#34;, &#34;replay&#34;] + gdb_args

else:
if not gdb_path:
raise ValueError(&#34;a valid path to gdb must be specified&#34;)

else:
abs_gdb_path = find_executable(gdb_path)
if abs_gdb_path is None:
raise ValueError(
&#39;gdb executable could not be resolved from &#34;%s&#34;&#39; % gdb_path
)

else:
self.abs_gdb_path = abs_gdb_path
self.cmd = [self.abs_gdb_path] + gdb_args

self._attach_logger(verbose)
self.spawn_new_gdb_subprocess()</code></pre>
</details>
</dd>
<dt id="pygdbmi.gdbcontroller.GdbController.exit"><code class="name flex">
<span>def <span class="ident">exit</span></span>(<span>self)</span>
</code></dt>
Expand Down Expand Up @@ -1329,7 +1277,7 @@ <h2 id="raises">Raises</h2>
</dd>
<dt id="pygdbmi.gdbcontroller.GdbTimeoutError"><code class="flex name class">
<span>class <span class="ident">GdbTimeoutError</span></span>
<span>(</span><span><small>ancestors:</small> builtins.ValueError, builtins.Exception, builtins.BaseException)</span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<section class="desc"><p>Raised when no response is recieved from gdb after the timeout has been triggered</p></section>
Expand All @@ -1340,10 +1288,16 @@ <h2 id="raises">Raises</h2>

pass</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>builtins.ValueError</li>
<li>builtins.Exception</li>
<li>builtins.BaseException</li>
</ul>
</dd>
<dt id="pygdbmi.gdbcontroller.NoGdbProcessError"><code class="flex name class">
<span>class <span class="ident">NoGdbProcessError</span></span>
<span>(</span><span><small>ancestors:</small> builtins.ValueError, builtins.Exception, builtins.BaseException)</span>
<span>(</span><span>*args, **kwargs)</span>
</code></dt>
<dd>
<section class="desc"><p>Raise when trying to interact with gdb subprocess, but it does not exist.
Expand All @@ -1356,6 +1310,12 @@ <h2 id="raises">Raises</h2>

pass</code></pre>
</details>
<h3>Ancestors</h3>
<ul class="hlist">
<li>builtins.ValueError</li>
<li>builtins.Exception</li>
<li>builtins.BaseException</li>
</ul>
</dd>
</dl>
</section>
Expand All @@ -1376,7 +1336,6 @@ <h1>Index</h1>
<li>
<h4><code><a title="pygdbmi.gdbcontroller.GdbController" href="#pygdbmi.gdbcontroller.GdbController">GdbController</a></code></h4>
<ul class="">
<li><code><a title="pygdbmi.gdbcontroller.GdbController.__init__" href="#pygdbmi.gdbcontroller.GdbController.__init__">__init__</a></code></li>
<li><code><a title="pygdbmi.gdbcontroller.GdbController.exit" href="#pygdbmi.gdbcontroller.GdbController.exit">exit</a></code></li>
<li><code><a title="pygdbmi.gdbcontroller.GdbController.get_gdb_response" href="#pygdbmi.gdbcontroller.GdbController.get_gdb_response">get_gdb_response</a></code></li>
<li><code><a title="pygdbmi.gdbcontroller.GdbController.get_subprocess_cmd" href="#pygdbmi.gdbcontroller.GdbController.get_subprocess_cmd">get_subprocess_cmd</a></code></li>
Expand All @@ -1399,7 +1358,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.4</a>.</p>
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.5.5.dev14+gca359aa</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
Expand Down
Loading

0 comments on commit 6308ee9

Please sign in to comment.