Skip to content

Commit

Permalink
update fd37b8e
Browse files Browse the repository at this point in the history
  • Loading branch information
GitHub Actions authored and GitHub Actions committed Nov 3, 2024
0 parents commit bb80b62
Show file tree
Hide file tree
Showing 224 changed files with 43,535 additions and 0 deletions.
Empty file added .nojekyll
Empty file.
321 changes: 321 additions & 0 deletions CodeCov/index.html

Large diffs are not rendered by default.

480 changes: 480 additions & 0 deletions Dependency.html

Large diffs are not rendered by default.

504 changes: 504 additions & 0 deletions Doc-License.html

Large diffs are not rendered by default.

327 changes: 327 additions & 0 deletions DocCov/index.html

Large diffs are not rendered by default.

313 changes: 313 additions & 0 deletions DocCoverage.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,313 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Documentation Coverage &mdash; sphinx_reports 0.7.4 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=77553476" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=4ae1632d" />
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" />
<link rel="stylesheet" type="text/css" href="_static/sphinx-reports.e44b1595f1e09d5e109d001839ba3f42.css?v=0b41afa8" />
<link rel="stylesheet" type="text/css" href="_static/css/override.css?v=6fa0b579" />


<link rel="shortcut icon" href="_static/icon.png"/>
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=020ce317"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/clipboard.min.js?v=a7894cd8"></script>
<script src="_static/copybutton.js?v=f281be69"></script>
<script src="_static/design-tabs.js?v=f930bc37"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Static Type Checking Report" href="typing/index.html" />
<link rel="prev" title="sphinx_reports.Unittest" href="coverage/sphinx_reports.Unittest.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="index.html">

<img src="_static/logo.png" class="logo" alt="Logo"/>
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Overview</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Installation.html">Installation/Updates</a></li>
<li class="toctree-l1"><a class="reference internal" href="Dependency.html">Dependencies</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Examples</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Examples/Documentation.html">Documentation Coverage</a></li>
<li class="toctree-l1"><a class="reference internal" href="Examples/Dependency.html">Dependency Trees</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Supported Reports</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="Overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="Unittest/index.html">Unit Test Summary</a></li>
<li class="toctree-l1"><a class="reference internal" href="CodeCov/index.html">Code Coverage</a></li>
<li class="toctree-l1"><a class="reference internal" href="DocCov/index.html">Documentation Coverage</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">References and Reports</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="sphinx_reports/sphinx_reports.html">Python Class Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="unittests/index.html">Unittest Summary Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="coverage/index.html">Code Coverage Report</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Doc. Coverage Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="typing/index.html">Static Type Check Report ➚</a></li>
</ul>
<p class="caption" role="heading"><span class="caption-text">Appendix</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="License.html">Apache License 2.0</a></li>
<li class="toctree-l1"><a class="reference internal" href="Doc-License.html">Creative Commons Attribution 4.0 International</a></li>
<li class="toctree-l1"><a class="reference internal" href="Glossary.html">Glossary</a></li>
<li class="toctree-l1"><a class="reference internal" href="genindex.html">Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="py-modindex.html">Python Module Index</a></li>
<li class="toctree-l1"><a class="reference internal" href="TODO.html">TODOs</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">sphinx_reports</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Documentation Coverage</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/DocCoverage.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<style type="text/css">
span.bolditalic {font-weight: bold; font-style: italic; }
span.underline {text-decoration: underline; }
span.strike {text-decoration: line-through; }
span.xlarge {font-size: x-large; }
span.colorred {color: #CC0000; }
span.colorgreen {color: #009933; }
span.colorblue {color: #0066FF; }
span.colorpurple {color: #9900CC; }
</style><section id="documentation-coverage">
<h1>Documentation Coverage<a class="headerlink" href="#documentation-coverage" title="Link to this heading"></a></h1>
<p>Documentation coverage generated by <a class="reference external" href="https://github.com/HunterMcGushion/docstr_coverage">docstr-coverage</a>.</p>
<div class="docutils container">
<table class="report-doccov-legend docutils align-default">
<thead>
<tr class="row-odd"><th class="head" rowspan="2"><p>Documentation Coverage:</p></th>
<th class="head" rowspan="2"><p>≤30 %</p></th>
<th class="head" rowspan="2"><p>≤50 %</p></th>
<th class="head" rowspan="2"><p>≤80 %</p></th>
<th class="head" rowspan="2"><p>≤90 %</p></th>
<th class="head" rowspan="2"><p>≤100 %</p></th>
</tr>
</thead>
<tbody>
<tr class="report-doccov-legend-row row-even"><td><p>Coverage Level:</p></td>
<td class="report-cov-below30"><p>almost undocumented</p></td>
<td class="report-cov-below50"><p>poorly documented</p></td>
<td class="report-cov-below80"><p>roughly documented</p></td>
<td class="report-cov-below90"><p>well documented</p></td>
<td class="report-cov-below100"><p>excellent documented</p></td>
</tr>
</tbody>
</table>
</div>
<div class="docutils container">
<table class="report-doccov-table docutils align-default">
<thead>
<tr class="row-odd"><th class="head" rowspan="2"><p>Filename</p></th>
<th class="head" rowspan="2"><p>Total</p></th>
<th class="head" rowspan="2"><p>Covered</p></th>
<th class="head" rowspan="2"><p>Missing</p></th>
<th class="head" rowspan="2"><p>Coverage in %</p></th>
</tr>
</thead>
<tbody>
<tr class="report-doccov-table-row report-doccov-package report-cov-below80 row-even"><td><p>📦sphinx_reports</p></td>
<td><p>8</p></td>
<td><p>6</p></td>
<td><p>2</p></td>
<td><p>75.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-package report-cov-below100 row-odd"><td><p> 📦Adapter</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
<td><p>100.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below80 row-even"><td><p>    Coverage</p></td>
<td><p>8</p></td>
<td><p>5</p></td>
<td><p>3</p></td>
<td><p>62.5%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-odd"><td><p>    Dependency</p></td>
<td><p>4</p></td>
<td><p>0</p></td>
<td><p>4</p></td>
<td><p>0.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-package report-cov-below100 row-even"><td><p> 📦DataModel</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
<td><p>100.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-odd"><td><p>    CodeCoverage</p></td>
<td><p>25</p></td>
<td><p>1</p></td>
<td><p>24</p></td>
<td><p>4.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-even"><td><p>    Dependency</p></td>
<td><p>10</p></td>
<td><p>0</p></td>
<td><p>10</p></td>
<td><p>0.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-package report-cov-below100 row-odd"><td><p> 📦static</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
<td><p>100.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below50 row-even"><td><p>   CodeCoverage</p></td>
<td><p>26</p></td>
<td><p>8</p></td>
<td><p>18</p></td>
<td><p>30.8%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-odd"><td><p>   Common</p></td>
<td><p>4</p></td>
<td><p>1</p></td>
<td><p>3</p></td>
<td><p>25.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below80 row-even"><td><p>   Dependency</p></td>
<td><p>7</p></td>
<td><p>4</p></td>
<td><p>3</p></td>
<td><p>57.1%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-odd"><td><p>   DocCoverage</p></td>
<td><p>20</p></td>
<td><p>5</p></td>
<td><p>15</p></td>
<td><p>25.0%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below30 row-even"><td><p>   Sphinx</p></td>
<td><p>8</p></td>
<td><p>1</p></td>
<td><p>7</p></td>
<td><p>12.5%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-module report-cov-below50 row-odd"><td><p>   Unittest</p></td>
<td><p>16</p></td>
<td><p>5</p></td>
<td><p>11</p></td>
<td><p>31.2%</p></td>
</tr>
<tr class="report-doccov-table-row report-doccov-summary report-cov-below50 row-even"><td><p>Overall (14 files):</p></td>
<td><p>92</p></td>
<td><p>33</p></td>
<td><p>59</p></td>
<td><p>35.9%</p></td>
</tr>
</tbody>
</table>
</div>
<div class="docutils container">
<table class="report-doccov-legend docutils align-default">
<thead>
<tr class="row-odd"><th class="head" rowspan="2"><p>Documentation Coverage</p></th>
<th class="head" rowspan="2"><p>Coverage Level</p></th>
</tr>
</thead>
<tbody>
<tr class="report-doccov-legend-row report-cov-below30 row-even"><td><p>≤30 %</p></td>
<td><p>almost undocumented</p></td>
</tr>
<tr class="report-doccov-legend-row report-cov-below50 row-odd"><td><p>≤50 %</p></td>
<td><p>poorly documented</p></td>
</tr>
<tr class="report-doccov-legend-row report-cov-below80 row-even"><td><p>≤80 %</p></td>
<td><p>roughly documented</p></td>
</tr>
<tr class="report-doccov-legend-row report-cov-below90 row-odd"><td><p>≤90 %</p></td>
<td><p>well documented</p></td>
</tr>
<tr class="report-doccov-legend-row report-cov-below100 row-even"><td><p>≤100 %</p></td>
<td><p>excellent documented</p></td>
</tr>
</tbody>
</table>
</div>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="coverage/sphinx_reports.Unittest.html" class="btn btn-neutral float-left" title="sphinx_reports.Unittest" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="typing/index.html" class="btn btn-neutral float-right" title="Static Type Checking Report" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2023-2024, Patrick Lehmann.
<span class="lastupdated">Last updated on 03.11.2024.
</span></p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading

0 comments on commit bb80b62

Please sign in to comment.