-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
GitHub Actions
authored and
GitHub Actions
committed
Jan 9, 2024
0 parents
commit e0ca564
Showing
117 changed files
with
18,183 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
# Sphinx build info version 1 | ||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
config: 155e268896939ab9dc8d72fa56cef832 | ||
tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,221 @@ | ||
<!DOCTYPE html> | ||
<html class="writer-html5" lang="en" data-content_root="./"> | ||
<head> | ||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> | ||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
<title>Documentation Coverage — sphinx_reports 0.1.0 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=19f00094" /> | ||
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" /> | ||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> | ||
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" /> | ||
<link rel="stylesheet" type="text/css" href="_static/css/override.css?v=0157af8c" /> | ||
|
||
|
||
<link rel="shortcut icon" href="_static/icon.png"/> | ||
<!--[if lt IE 9]> | ||
<script src="_static/js/html5shiv.min.js"></script> | ||
<![endif]--> | ||
|
||
<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=01f34227"></script> | ||
<script src="_static/doctools.js?v=888ff710"></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=36754332"></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="Coverage Report" href="coverage/index.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 class="version"> | ||
0.1 | ||
</div> | ||
<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">References and Reports</span></p> | ||
<ul class="current"> | ||
<li class="toctree-l1"><a class="reference internal" href="unittests/index.html">Unittest 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="https://github.com/pyTooling/sphinx-reports/blob/dev/doc/DocCoverage.rst" class="fa fa-github"> Edit on GitHub</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="doccov-table docutils align-default"> | ||
<thead> | ||
<tr class="row-odd"><th class="head"><p>Filename</p></th> | ||
<th class="head"><p>Total</p></th> | ||
<th class="head"><p>Covered</p></th> | ||
<th class="head"><p>Missing</p></th> | ||
<th class="head"><p>Coverage in %</p></th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr class="doccov-table-row doccov-below30 row-even"><td><p>sphinx_reports (../sphinx_reports/__init__.py)</p></td> | ||
<td><p>1</p></td> | ||
<td><p>0</p></td> | ||
<td><p>1</p></td> | ||
<td><p>0.0%</p></td> | ||
</tr> | ||
<tr class="doccov-table-row doccov-below100 row-odd"><td><p>CoverageReports (CoverageReports.py)</p></td> | ||
<td><p>21</p></td> | ||
<td><p>3</p></td> | ||
<td><p>18</p></td> | ||
<td><p>1428.6%</p></td> | ||
</tr> | ||
<tr class="doccov-table-row doccov-below100 row-even"><td><p>DataModel (DataModel.py)</p></td> | ||
<td><p>39</p></td> | ||
<td><p>1</p></td> | ||
<td><p>38</p></td> | ||
<td><p>256.4%</p></td> | ||
</tr> | ||
<tr class="doccov-table-row doccov-below100 row-odd"><td><p>DocStrCoverage (DocStrCoverage.py)</p></td> | ||
<td><p>11</p></td> | ||
<td><p>1</p></td> | ||
<td><p>10</p></td> | ||
<td><p>909.1%</p></td> | ||
</tr> | ||
<tr class="doccov-summary-row doccov-below30 row-even"><td><p>Overall (4 files):</p></td> | ||
<td><p>1</p></td> | ||
<td><p>0</p></td> | ||
<td><p>1</p></td> | ||
<td><p>0.0%</p></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<p class="rubric">Legend</p> | ||
<table class="doccov-legend docutils align-default"> | ||
<thead> | ||
<tr class="row-odd"><th class="head"><p>%</p></th> | ||
<th class="head"><p>Coverage Level</p></th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr class="doccov-legend-row doccov-below30 row-even"><td><p>≤30%</p></td> | ||
<td><p>almost undocumented</p></td> | ||
</tr> | ||
<tr class="doccov-legend-row doccov-below50 row-odd"><td><p>≤50%</p></td> | ||
<td><p>poorly documented</p></td> | ||
</tr> | ||
<tr class="doccov-legend-row doccov-below80 row-even"><td><p>≤80%</p></td> | ||
<td><p>roughly documented</p></td> | ||
</tr> | ||
<tr class="doccov-legend-row doccov-below90 row-odd"><td><p>≤90%</p></td> | ||
<td><p>well documented</p></td> | ||
</tr> | ||
<tr class="doccov-legend-row doccov-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/index.html" class="btn btn-neutral float-left" title="Coverage Report" 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>© Copyright 2023-2024, Patrick Lehmann. | ||
<span class="lastupdated">Last updated on 09.01.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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,163 @@ | ||
<!DOCTYPE html> | ||
<html class="writer-html5" lang="en" data-content_root="./"> | ||
<head> | ||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" /> | ||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
<title>Glossary — sphinx_reports 0.1.0 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=19f00094" /> | ||
<link rel="stylesheet" type="text/css" href="_static/graphviz.css?v=eafc0fe6" /> | ||
<link rel="stylesheet" type="text/css" href="_static/copybutton.css?v=76b2166b" /> | ||
<link rel="stylesheet" type="text/css" href="_static/design-style.1e8bd061cd6da7fc9cf755528e8ffc24.min.css?v=0a3b3ea7" /> | ||
<link rel="stylesheet" type="text/css" href="_static/css/override.css?v=0157af8c" /> | ||
|
||
|
||
<link rel="shortcut icon" href="_static/icon.png"/> | ||
<!--[if lt IE 9]> | ||
<script src="_static/js/html5shiv.min.js"></script> | ||
<![endif]--> | ||
|
||
<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=01f34227"></script> | ||
<script src="_static/doctools.js?v=888ff710"></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=36754332"></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="Index" href="genindex.html" /> | ||
<link rel="prev" title="Creative Commons Attribution 4.0 International" href="Doc-License.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 class="version"> | ||
0.1 | ||
</div> | ||
<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">References and Reports</span></p> | ||
<ul> | ||
<li class="toctree-l1"><a class="reference internal" href="unittests/index.html">Unittest Report ➚</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="coverage/index.html">Code Coverage Report ➚</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="DocCoverage.html">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 class="current"> | ||
<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 current"><a class="current reference internal" href="#">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">Glossary</li> | ||
<li class="wy-breadcrumbs-aside"> | ||
<a href="https://github.com/pyTooling/sphinx-reports/blob/dev/doc/Glossary.rst" class="fa fa-github"> Edit on GitHub</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="glossary"> | ||
<h1>Glossary<a class="headerlink" href="#glossary" title="Link to this heading"></a></h1> | ||
<dl class="simple glossary"> | ||
<dt id="term-Branch-Coverage">Branch Coverage<a class="headerlink" href="#term-Branch-Coverage" title="Link to this term"></a></dt><dd><p>tbd</p> | ||
</dd> | ||
<dt id="term-Code-Coverage">Code Coverage<a class="headerlink" href="#term-Code-Coverage" title="Link to this term"></a></dt><dd><p>tbd</p> | ||
</dd> | ||
<dt id="term-Documentation-Coverage">Documentation Coverage<a class="headerlink" href="#term-Documentation-Coverage" title="Link to this term"></a></dt><dd><p>tbd</p> | ||
</dd> | ||
<dt id="term-Python-doc-string">Python doc-string<a class="headerlink" href="#term-Python-doc-string" title="Link to this term"></a></dt><dd><p>tbd</p> | ||
</dd> | ||
<dt id="term-Statement-Coverage">Statement Coverage<a class="headerlink" href="#term-Statement-Coverage" title="Link to this term"></a></dt><dd><p>tbd</p> | ||
</dd> | ||
</dl> | ||
</section> | ||
|
||
|
||
</div> | ||
</div> | ||
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> | ||
<a href="Doc-License.html" class="btn btn-neutral float-left" title="Creative Commons Attribution 4.0 International" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a> | ||
<a href="genindex.html" class="btn btn-neutral float-right" title="Index" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a> | ||
</div> | ||
|
||
<hr/> | ||
|
||
<div role="contentinfo"> | ||
<p>© Copyright 2023-2024, Patrick Lehmann. | ||
<span class="lastupdated">Last updated on 09.01.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> |
Oops, something went wrong.