Skip to content

Commit 114c232

Browse files
committed
update documentation
1 parent 5ab0b9b commit 114c232

File tree

10 files changed

+49
-6
lines changed

10 files changed

+49
-6
lines changed

doc/_build/doctrees/code.doctree

8.81 KB
Binary file not shown.
476 Bytes
Binary file not shown.

doc/_build/doctrees/intro.doctree

0 Bytes
Binary file not shown.

doc/_build/html/_sources/intro.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ Steps to get PastebinPython running
2929

3030
>>> import pastebin_python
3131
>>> pastebin_python.__version__
32-
'1.1'
32+
'1.2'

doc/_build/html/code.html

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,24 @@ <h3>Navigation</h3>
278278
</div>
279279
</dd></dl>
280280

281+
<dl class="method">
282+
<dt id="pastebin_python.pastebin.PastebinPython.getPasteRawOutput">
283+
<tt class="descname">getPasteRawOutput</tt><big>(</big><em>api_paste_key</em><big>)</big><a class="headerlink" href="#pastebin_python.pastebin.PastebinPython.getPasteRawOutput" title="Permalink to this definition"></a></dt>
284+
<dd><p>This will get the raw output of the paste</p>
285+
<table class="docutils field-list" frame="void" rules="none">
286+
<col class="field-name" />
287+
<col class="field-body" />
288+
<tbody valign="top">
289+
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>api_paste_key</strong> (<em>str</em>) &#8211; this is the paste key that which you can get in the <a class="reference internal" href="#pastebin_python.pastebin.PastebinPython.listUserPastes" title="pastebin_python.pastebin.PastebinPython.listUserPastes"><tt class="xref py py-meth docutils literal"><span class="pre">pastebin_python.pastebin.PastebinPython.listUserPastes()</span></tt></a> function</td>
290+
</tr>
291+
<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">str &#8211; raw output of the paste</td>
292+
</tr>
293+
<tr class="field-odd field"><th class="field-name">Raises :</th><td class="field-body"><a class="reference internal" href="#pastebin_python.pastebin_exceptions.PastebinHTTPErrorException" title="pastebin_python.pastebin_exceptions.PastebinHTTPErrorException"><tt class="xref py py-exc docutils literal"><span class="pre">pastebin_python.pastebin_exceptions.PastebinHTTPErrorException</span></tt></a></td>
294+
</tr>
295+
</tbody>
296+
</table>
297+
</dd></dl>
298+
281299
<dl class="method">
282300
<dt id="pastebin_python.pastebin.PastebinPython._PastebinPython__parsePaste">
283301
<tt class="descname">_PastebinPython__parsePaste</tt><big>(</big><em>xmlString</em><big>)</big><a class="headerlink" href="#pastebin_python.pastebin.PastebinPython._PastebinPython__parsePaste" title="Permalink to this definition"></a></dt>
@@ -381,10 +399,21 @@ <h3>Navigation</h3>
381399
<em class="property">exception </em><tt class="descclassname">pastebin_python.pastebin_exceptions.</tt><tt class="descname">PastebinFileException</tt><a class="headerlink" href="#pastebin_python.pastebin_exceptions.PastebinFileException" title="Permalink to this definition"></a></dt>
382400
<dd></dd></dl>
383401

402+
<dl class="exception">
403+
<dt id="pastebin_python.pastebin_exceptions.PastebinHTTPErrorException">
404+
<em class="property">exception </em><tt class="descclassname">pastebin_python.pastebin_exceptions.</tt><tt class="descname">PastebinHTTPErrorException</tt><a class="headerlink" href="#pastebin_python.pastebin_exceptions.PastebinHTTPErrorException" title="Permalink to this definition"></a></dt>
405+
<dd></dd></dl>
406+
384407
</div>
385408
<div class="section" id="module-pastebin_python.pastebin_constants">
386409
<span id="pastebin-constants"></span><h2>pastebin_constants<a class="headerlink" href="#module-pastebin_python.pastebin_constants" title="Permalink to this headline"></a></h2>
387410
<span class="target" id="module-pastebin_constants"></span><dl class="data">
411+
<dt id="pastebin_python.pastebin_constants.PASTEBIN_URL">
412+
<tt class="descclassname">pastebin_python.pastebin_constants.</tt><tt class="descname">PASTEBIN_URL</tt><em class="property"> = 'http://pastebin.com/'</em><a class="headerlink" href="#pastebin_python.pastebin_constants.PASTEBIN_URL" title="Permalink to this definition"></a></dt>
413+
<dd><p>The pastebin.com base url</p>
414+
</dd></dl>
415+
416+
<dl class="data">
388417
<dt id="pastebin_python.pastebin_constants.PASTEBIN_API_URL">
389418
<tt class="descclassname">pastebin_python.pastebin_constants.</tt><tt class="descname">PASTEBIN_API_URL</tt><em class="property"> = 'http://pastebin.com/api/'</em><a class="headerlink" href="#pastebin_python.pastebin_constants.PASTEBIN_API_URL" title="Permalink to this definition"></a></dt>
390419
<dd><p>The pastebin.com API base URL</p>

doc/_build/html/genindex.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1058,6 +1058,12 @@ <h2 id="G">G</h2>
10581058
<table style="width: 100%" class="indextable genindextable"><tr>
10591059
<td style="width: 33%" valign="top"><dl>
10601060

1061+
<dt><a href="code.html#pastebin_python.pastebin.PastebinPython.getPasteRawOutput">getPasteRawOutput() (pastebin_python.pastebin.PastebinPython method)</a>
1062+
</dt>
1063+
1064+
</dl></td>
1065+
<td style="width: 33%" valign="top"><dl>
1066+
10611067
<dt><a href="code.html#pastebin_python.pastebin.PastebinPython.getUserInfos">getUserInfos() (pastebin_python.pastebin.PastebinPython method)</a>
10621068
</dt>
10631069

@@ -1155,12 +1161,12 @@ <h2 id="P">P</h2>
11551161
<dt><a href="code.html#module-pastebin_options">pastebin_options (module)</a>
11561162
</dt>
11571163

1158-
</dl></td>
1159-
<td style="width: 33%" valign="top"><dl>
11601164

11611165
<dt><a href="code.html#module-pastebin_python">pastebin_python (module)</a>
11621166
</dt>
11631167

1168+
</dl></td>
1169+
<td style="width: 33%" valign="top"><dl>
11641170

11651171
<dt><a href="code.html#module-pastebin_python.pastebin">pastebin_python.pastebin (module)</a>
11661172
</dt>
@@ -1182,6 +1188,10 @@ <h2 id="P">P</h2>
11821188
</dt>
11831189

11841190

1191+
<dt><a href="code.html#pastebin_python.pastebin_constants.PASTEBIN_URL">PASTEBIN_URL (in module pastebin_python.pastebin_constants)</a>
1192+
</dt>
1193+
1194+
11851195
<dt><a href="code.html#pastebin_python.pastebin_exceptions.PastebinBadRequestException">PastebinBadRequestException</a>
11861196
</dt>
11871197

@@ -1190,6 +1200,10 @@ <h2 id="P">P</h2>
11901200
</dt>
11911201

11921202

1203+
<dt><a href="code.html#pastebin_python.pastebin_exceptions.PastebinHTTPErrorException">PastebinHTTPErrorException</a>
1204+
</dt>
1205+
1206+
11931207
<dt><a href="code.html#pastebin_python.pastebin_exceptions.PastebinNoPastesException">PastebinNoPastesException</a>
11941208
</dt>
11951209

doc/_build/html/intro.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ <h2>Steps to get PastebinPython running<a class="headerlink" href="#steps-to-get
8585
<li><p class="first">You can verify if the installation is successfull by running this command with no errors in Python interactive shell:</p>
8686
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">pastebin_python</span>
8787
<span class="gp">&gt;&gt;&gt; </span><span class="n">pastebin_python</span><span class="o">.</span><span class="n">__version__</span>
88-
<span class="go">&#39;1.1&#39;</span>
88+
<span class="go">&#39;1.2&#39;</span>
8989
</pre></div>
9090
</div>
9191
</li>

doc/_build/html/objects.inv

26 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)