Skip to content

Commit

Permalink
Minor docs edits
Browse files Browse the repository at this point in the history
  • Loading branch information
@eliasdabbas
eliasdabbas committed Dec 18, 2024
1 parent 6808ec3 commit bdc6a84
Show file tree
Hide file tree
Showing 9 changed files with 918 additions and 7 deletions.
Binary file modified docs/_build/doctrees/advertools.cli.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
881 changes: 881 additions & 0 deletions docs/_build/html/_modules/advertools/cli.html
View file

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@
<h1>All modules for which code is available</h1>
<ul><li><a href="advertools/ad_create.html">advertools.ad_create</a></li>
<li><a href="advertools/ad_from_string.html">advertools.ad_from_string</a></li>
<li><a href="advertools/cli.html">advertools.cli</a></li>
<li><a href="advertools/crawlytics.html">advertools.crawlytics</a></li>
<li><a href="advertools/emoji.html">advertools.emoji</a></li>
<li><a href="advertools/extract.html">advertools.extract</a></li>
Expand Down
15 changes: 13 additions & 2 deletions docs/_build/html/advertools.cli.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,8 +123,19 @@
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="advertools-cli-module">
<h1>advertools.cli module<a class="headerlink" href="#advertools-cli-module" title="Link to this heading"></a></h1>
<section id="module-advertools.cli">
<span id="advertools-cli-module"></span><h1>advertools.cli module<a class="headerlink" href="#module-advertools.cli" title="Link to this heading"></a></h1>
<dl class="py class">
<dt class="sig sig-object py" id="advertools.cli.RawTextDefArgFormatter">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">RawTextDefArgFormatter</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">prog</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent_increment</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">2</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">max_help_position</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">24</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">width</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="_modules/advertools/cli.html#RawTextDefArgFormatter"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#advertools.cli.RawTextDefArgFormatter" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RawTextHelpFormatter</span></code>, <code class="xref py py-class docutils literal notranslate"><span class="pre">ArgumentDefaultsHelpFormatter</span></code></p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="advertools.cli.main">
<span class="sig-name descname"><span class="pre">main</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="_modules/advertools/cli.html#main"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#advertools.cli.main" title="Link to this definition"></a></dt>
<dd></dd></dl>

</section>

<script type="text/x-thebe-config">
Expand Down
21 changes: 17 additions & 4 deletions docs/_build/html/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,13 @@ <h2 id="A">A</h2>

<ul>
<li><a href="advertools.ad_from_string.html#module-advertools.ad_from_string">module</a>
</li>
</ul></li>
<li>
advertools.cli

<ul>
<li><a href="advertools.cli.html#module-advertools.cli">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -243,15 +250,15 @@ <h2 id="A">A</h2>
<li><a href="advertools.knowledge_graph.html#module-advertools.knowledge_graph">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
advertools.kw_generate

<ul>
<li><a href="advertools.kw_generate.html#module-advertools.kw_generate">module</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li>
advertools.logs

Expand Down Expand Up @@ -574,6 +581,8 @@ <h2 id="L">L</h2>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advertools.cli.html#advertools.cli.main">main() (in module advertools.cli)</a>
</li>
<li><a href="advertools.twitter.html#advertools.twitter.make_dataframe">make_dataframe() (in module advertools.twitter)</a>
</li>
<li>
Expand All @@ -585,6 +594,8 @@ <h2 id="M">M</h2>
<li><a href="advertools.ad_create.html#module-advertools.ad_create">advertools.ad_create</a>
</li>
<li><a href="advertools.ad_from_string.html#module-advertools.ad_from_string">advertools.ad_from_string</a>
</li>
<li><a href="advertools.cli.html#module-advertools.cli">advertools.cli</a>
</li>
<li><a href="advertools.cli_docs.html#module-advertools.cli_docs">advertools.cli_docs</a>
</li>
Expand Down Expand Up @@ -681,16 +692,18 @@ <h2 id="P">P</h2>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advertools.cli.html#advertools.cli.RawTextDefArgFormatter">RawTextDefArgFormatter (class in advertools.cli)</a>
</li>
<li><a href="advertools.crawlytics.html#advertools.crawlytics.redirects">redirects() (in module advertools.crawlytics)</a>
</li>
<li><a href="advertools.word_frequency.html#term-regex"><strong>regex</strong></a>
</li>
<li><a href="advertools.twitter.html#advertools.twitter.retweeted_of_me">retweeted_of_me() (in module advertools.twitter)</a>
</li>
<li><a href="advertools.reverse_dns_lookup.html#advertools.reverse_dns_lookup.reverse_dns_lookup">reverse_dns_lookup() (in module advertools.reverse_dns_lookup)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="advertools.reverse_dns_lookup.html#advertools.reverse_dns_lookup.reverse_dns_lookup">reverse_dns_lookup() (in module advertools.reverse_dns_lookup)</a>
</li>
<li><a href="advertools.word_frequency.html#term-rm_words"><strong>rm_words</strong></a>
</li>
<li><a href="advertools.robotstxt.html#advertools.robotstxt.robotstxt_test">robotstxt_test() (in module advertools.robotstxt)</a>
Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Binary file not shown.
5 changes: 5 additions & 0 deletions docs/_build/html/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,11 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="advertools.ad_from_string.html#module-advertools.ad_from_string"><code class="xref">advertools.ad_from_string</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="advertools.cli.html#module-advertools.cli"><code class="xref">advertools.cli</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit bdc6a84

Please sign in to comment.