Skip to content

Commit

Permalink
documentation fix.
Browse files Browse the repository at this point in the history
  • Loading branch information
tanimislam committed Sep 8, 2023
1 parent 3fa10e5 commit 2680acf
Show file tree
Hide file tree
Showing 16 changed files with 210 additions and 278 deletions.
17 changes: 3 additions & 14 deletions docs/_static/_sphinx_javascript_frameworks_compat.js
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
/*
* _sphinx_javascript_frameworks_compat.js
* ~~~~~~~~~~
*
* Compatability shim for jQuery and underscores.js.
*
* WILL BE REMOVED IN Sphinx 6.0
* xref RemovedInSphinx60Warning
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/

/**
* select a different prefix for underscore
*/
$u = _.noConflict();


/**
* small helper function to urldecode strings
*
Expand Down
18 changes: 18 additions & 0 deletions docs/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -670,6 +670,16 @@ dd {
margin-left: 30px;
}

.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}

.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}

dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
Expand Down Expand Up @@ -738,6 +748,14 @@ abbr, acronym {
cursor: help;
}

.translated {
background-color: rgba(207, 255, 207, 0.2)
}

.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}

/* -- code displays --------------------------------------------------------- */

pre {
Expand Down
271 changes: 109 additions & 162 deletions docs/core_api.html

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/core_functionality.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down
31 changes: 16 additions & 15 deletions docs/email_api.html

Large diffs are not rendered by default.

51 changes: 15 additions & 36 deletions docs/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -93,7 +94,6 @@ <h1 id="index">Index</h1>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#W"><strong>W</strong></a>
| <a href="#Y"><strong>Y</strong></a>

</div>
<h2 id="A">A</h2>
Expand Down Expand Up @@ -202,8 +202,6 @@ <h2 id="G">G</h2>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.NPRStuffIMGClient.get_candidate_albums">get_candidate_albums() (nprstuff.npremail.email_imgur.NPRStuffIMGClient method)</a>
</li>
<li><a href="core_api.html#nprstuff.core.npr_utils.get_chrome_driver">get_chrome_driver() (in module nprstuff.core.npr_utils)</a>
</li>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.get_cloudconvert_api_key">get_cloudconvert_api_key() (in module nprstuff.core.convert_image_youtube)</a>
</li>
<li><a href="core_api.html#nprstuff.core.freshair_by_year.get_color">get_color() (in module nprstuff.core.freshair_by_year)</a>
</li>
Expand All @@ -227,10 +225,10 @@ <h2 id="G">G</h2>
</li>
<li><a href="core_api.html#nprstuff.core.freshair.get_freshair_valid_dates_remaining_tuples">get_freshair_valid_dates_remaining_tuples() (in module nprstuff.core.freshair)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.NPRStuffIMGClient.get_image_md5">get_image_md5() (nprstuff.npremail.email_imgur.NPRStuffIMGClient class method)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="email_api.html#nprstuff.npremail.get_imgurl_credentials">get_imgurl_credentials() (in module nprstuff.npremail)</a>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.NPRStuffIMGClient.get_main_album_name">get_main_album_name() (nprstuff.npremail.email_imgur.NPRStuffIMGClient method)</a>
Expand All @@ -255,6 +253,12 @@ <h2 id="G">G</h2>

<ul>
<li><a href="core_api.html#nprstuff.core.waitwait.get_title_mp3_urls_working">(in module nprstuff.core.waitwait)</a>
</li>
</ul></li>
<li><a href="core_api.html#nprstuff.core.freshair.get_title_mp3_urls_working_2023">get_title_mp3_urls_working_2023() (in module nprstuff.core.freshair)</a>

<ul>
<li><a href="core_api.html#nprstuff.core.waitwait.get_title_mp3_urls_working_2023">(in module nprstuff.core.waitwait)</a>
</li>
</ul></li>
<li><a href="core_api.html#nprstuff.core.waitwait.get_waitwait">get_waitwait() (in module nprstuff.core.waitwait)</a>
Expand All @@ -268,8 +272,6 @@ <h2 id="G">G</h2>
<li><a href="core_api.html#nprstuff.core.waitwait.get_waitwait_valid_dates_remaining_tuples">get_waitwait_valid_dates_remaining_tuples() (in module nprstuff.core.waitwait)</a>
</li>
<li><a href="core_api.html#nprstuff.core.npr_utils.get_weekday_times_in_year">get_weekday_times_in_year() (in module nprstuff.core.npr_utils)</a>
</li>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.get_youtube_file">get_youtube_file() (in module nprstuff.core.convert_image_youtube)</a>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicObject.getInfoGUI">getInfoGUI() (nprstuff.npremail.email_imgur.PNGPicObject method)</a>
</li>
Expand Down Expand Up @@ -322,8 +324,6 @@ <h2 id="M">M</h2>

<ul>
<li><a href="top_level_api.html#module-nprstuff">nprstuff</a>
</li>
<li><a href="core_api.html#module-nprstuff.core.convert_image_youtube">nprstuff.core.convert_image_youtube</a>
</li>
<li><a href="core_api.html#module-nprstuff.core.freshair">nprstuff.core.freshair</a>
</li>
Expand Down Expand Up @@ -363,13 +363,6 @@ <h2 id="N">N</h2>

<ul>
<li><a href="top_level_api.html#module-nprstuff">module</a>
</li>
</ul></li>
<li>
nprstuff.core.convert_image_youtube

<ul>
<li><a href="core_api.html#module-nprstuff.core.convert_image_youtube">module</a>
</li>
</ul></li>
<li>
Expand Down Expand Up @@ -468,10 +461,6 @@ <h2 id="O">O</h2>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.pdf2png">pdf2png() (in module nprstuff.core.convert_image_youtube)</a>
</li>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.png2png">png2png() (in module nprstuff.core.convert_image_youtube)</a>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicDelegate">PNGPicDelegate (class in nprstuff.npremail.email_imgur)</a>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicLabel">PNGPicLabel (class in nprstuff.npremail.email_imgur)</a>
Expand All @@ -480,10 +469,10 @@ <h2 id="P">P</h2>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicQSortFilterModel">PNGPicQSortFilterModel (class in nprstuff.npremail.email_imgur)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicTableModel">PNGPicTableModel (class in nprstuff.npremail.email_imgur)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGPicTableView">PNGPicTableView (class in nprstuff.npremail.email_imgur)</a>
</li>
<li><a href="email_api.html#nprstuff.npremail.email_imgur.PNGWidget">PNGWidget (class in nprstuff.npremail.email_imgur)</a>
Expand Down Expand Up @@ -585,8 +574,6 @@ <h2 id="S">S</h2>
<li><a href="core_api.html#nprstuff.core.npr_utils.store_waitwait_downloaddir">store_waitwait_downloaddir() (in module nprstuff.core.npr_utils)</a>
</li>
<li><a href="core_api.html#nprstuff.core.freshair_by_year.suncal">suncal() (in module nprstuff.core.freshair_by_year)</a>
</li>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.svg2png">svg2png() (in module nprstuff.core.convert_image_youtube)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -619,14 +606,6 @@ <h2 id="W">W</h2>
</ul></td>
</tr></table>

<h2 id="Y">Y</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="core_api.html#nprstuff.core.convert_image_youtube.youtube2gif">youtube2gif() (in module nprstuff.core.convert_image_youtube)</a>
</li>
</ul></td>
</tr></table>



</div>
Expand Down
9 changes: 5 additions & 4 deletions docs/graphics_functionality.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down
21 changes: 8 additions & 13 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down Expand Up @@ -193,15 +194,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.npr_utils.weekdays_of_month_of_year"><code class="docutils literal notranslate"><span class="pre">weekdays_of_month_of_year()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="core_api.html#convert-image-youtube-module">6.2. convert_image_youtube module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.get_cloudconvert_api_key"><code class="docutils literal notranslate"><span class="pre">get_cloudconvert_api_key()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.get_youtube_file"><code class="docutils literal notranslate"><span class="pre">get_youtube_file()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.pdf2png"><code class="docutils literal notranslate"><span class="pre">pdf2png()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.png2png"><code class="docutils literal notranslate"><span class="pre">png2png()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.svg2png"><code class="docutils literal notranslate"><span class="pre">svg2png()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.convert_image_youtube.youtube2gif"><code class="docutils literal notranslate"><span class="pre">youtube2gif()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="core_api.html#convert-image-youtube-module">6.2. convert_image_youtube module</a></li>
<li class="toctree-l2"><a class="reference internal" href="core_api.html#music-to-m4a-module">6.3. music_to_m4a module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.music_to_m4a.get_defaultname"><code class="docutils literal notranslate"><span class="pre">get_defaultname()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.music_to_m4a.music_to_m4a"><code class="docutils literal notranslate"><span class="pre">music_to_m4a()</span></code></a></li>
Expand All @@ -215,6 +208,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair.get_freshair_valid_dates_remaining_tuples"><code class="docutils literal notranslate"><span class="pre">get_freshair_valid_dates_remaining_tuples()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair.get_title_mp3_urls_attic"><code class="docutils literal notranslate"><span class="pre">get_title_mp3_urls_attic()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair.get_title_mp3_urls_working"><code class="docutils literal notranslate"><span class="pre">get_title_mp3_urls_working()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair.get_title_mp3_urls_working_2023"><code class="docutils literal notranslate"><span class="pre">get_title_mp3_urls_working_2023()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair.process_all_freshairs_by_year"><code class="docutils literal notranslate"><span class="pre">process_all_freshairs_by_year()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair_by_year.create_plot_year"><code class="docutils literal notranslate"><span class="pre">create_plot_year()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.freshair_by_year.find_occupied_days"><code class="docutils literal notranslate"><span class="pre">find_occupied_days()</span></code></a></li>
Expand All @@ -235,6 +229,7 @@ <h2>Table of Contents<a class="headerlink" href="#table-of-contents" title="Perm
<li class="toctree-l2"><a class="reference internal" href="core_api.html#waitwait-and-waitwait-realmedia-modules">6.6. waitwait and waitwait_realmedia modules</a><ul>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_all_waitwaits_year"><code class="docutils literal notranslate"><span class="pre">get_all_waitwaits_year()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_title_mp3_urls_working"><code class="docutils literal notranslate"><span class="pre">get_title_mp3_urls_working()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_title_mp3_urls_working_2023"><code class="docutils literal notranslate"><span class="pre">get_title_mp3_urls_working_2023()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_waitwait"><code class="docutils literal notranslate"><span class="pre">get_waitwait()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_waitwait_date_from_name"><code class="docutils literal notranslate"><span class="pre">get_waitwait_date_from_name()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="core_api.html#nprstuff.core.waitwait.get_waitwait_image"><code class="docutils literal notranslate"><span class="pre">get_waitwait_image()</span></code></a></li>
Expand Down
9 changes: 5 additions & 4 deletions docs/new_functionality.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down
Binary file modified docs/objects.inv
Binary file not shown.
9 changes: 5 additions & 4 deletions docs/oldstuff.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,10 +11,11 @@
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></script>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js?v=359c27e9"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=4825356b"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
Expand Down
Loading

0 comments on commit 2680acf

Please sign in to comment.