Skip to content

Commit

Permalink
update sphinx pages
Browse files Browse the repository at this point in the history
  • Loading branch information
erdogant committed Oct 7, 2022
1 parent 62252dd commit 56236f0
Show file tree
Hide file tree
Showing 32 changed files with 1,089 additions and 1,015 deletions.
Binary file modified docs/pages/doctrees/Coding quality.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/Documentation.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/Examples.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/Installation.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/Tutorials.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/pages/doctrees/index.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/scatterd.scatterd.doctree
Binary file not shown.
Binary file modified docs/pages/doctrees/sponsor.doctree
Binary file not shown.
14 changes: 8 additions & 6 deletions docs/pages/html/Coding quality.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></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 All @@ -31,7 +33,7 @@
<a href="index.html" class="icon icon-home"> scatterd
</a>
<div class="version">
1.1.3
1.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -103,14 +105,14 @@
<div itemprop="articleBody">

<section id="coding-quality">
<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink to this headline"></a></h1>
<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink to this heading"></a></h1>
<p>I value software quality. Higher quality software has fewer defects, better security, and better performance, which leads to happier users who can work more effectively.
Code reviews are an effective method for improving software quality. McConnell (2004) suggests that unit testing finds approximately 25% of defects, function testing 35%, integration testing 45%, and code review 55-60%.
While this means that none of these methods are good enough on their own and that they should be combined, clearly code review is an essential tool here.</p>
<p>This library is therefore developed with several techniques, such as coding styling, low complexity, docstrings, reviews, and unit tests.
Such conventions are helpfull to improve the quality, make the code cleaner and more understandable but alos to trace future bugs, and spot syntax errors.</p>
<section id="library">
<h2>library<a class="headerlink" href="#library" title="Permalink to this headline"></a></h2>
<h2>library<a class="headerlink" href="#library" title="Permalink to this heading"></a></h2>
<p>The file structure of the generated package looks like:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>path/to/scatterd/
├── .editorconfig
Expand Down Expand Up @@ -140,13 +142,13 @@ <h2>library<a class="headerlink" href="#library" title="Permalink to this headli
</div>
</section>
<section id="style">
<h2>Style<a class="headerlink" href="#style" title="Permalink to this headline"></a></h2>
<h2>Style<a class="headerlink" href="#style" title="Permalink to this heading"></a></h2>
<p>This library is compliant with the PEP-8 standards.
PEP stands for Python Enhancement Proposal and sets a baseline for the readability of Python code.
Each public function contains a docstring that is based on numpy standards.</p>
</section>
<section id="complexity">
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this headline"></a></h2>
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this heading"></a></h2>
<p>This library has been developed by using measures that help decreasing technical debt.
Developing software with low(er) technical dept may take extra development time, but has many advantages:</p>
<ul class="simple">
Expand All @@ -157,7 +159,7 @@ <h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this
</ul>
</section>
<section id="unit-tests">
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this headline"></a></h2>
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading"></a></h2>
<p>The use of unit tests is essential to garantee a consistent output of developed functions.
The following tests are secured using <code class="xref py py-func docutils literal notranslate"><span class="pre">tests.test_scatterd()</span></code>:</p>
<ul class="simple">
Expand Down
12 changes: 7 additions & 5 deletions docs/pages/html/Documentation.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/sphinx_highlight.js"></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 All @@ -31,7 +33,7 @@
<a href="index.html" class="icon icon-home"> scatterd
</a>
<div class="version">
1.1.3
1.2.0
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
Expand Down Expand Up @@ -97,7 +99,7 @@
<div itemprop="articleBody">

<section id="sponsor">
<h1>Sponsor<a class="headerlink" href="#sponsor" title="Permalink to this headline"></a></h1>
<h1>Sponsor<a class="headerlink" href="#sponsor" title="Permalink to this heading"></a></h1>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>If you ❤️ this project, you can help in various ways.</p>
Expand All @@ -113,21 +115,21 @@ <h1>Sponsor<a class="headerlink" href="#sponsor" title="Permalink to this headli
</div>
<iframe src="https://github.com/sponsors/erdogant/button" title="Sponsor erdogant" height="35" width="116" style="border: 0;"></iframe></section>
<section id="medium-blog">
<h1>Medium Blog<a class="headerlink" href="#medium-blog" title="Permalink to this headline"></a></h1>
<h1>Medium Blog<a class="headerlink" href="#medium-blog" title="Permalink to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><a class="reference external" href="https://towardsdatascience.com/creating-beautiful-stand-alone-interactive-d3-charts-with-python-804117cb95a7">Medium Blog: Coming soon (Wishfull thinking)</a></p>
</div>
</section>
<section id="github">
<h1>Github<a class="headerlink" href="#github" title="Permalink to this headline"></a></h1>
<h1>Github<a class="headerlink" href="#github" title="Permalink to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p><a class="reference external" href="https://github.com/erdogant/scatterd/">Source code of scatterd can be found at Github</a></p>
</div>
</section>
<section id="citing">
<h1>Citing<a class="headerlink" href="#citing" title="Permalink to this headline"></a></h1>
<h1>Citing<a class="headerlink" href="#citing" title="Permalink to this heading"></a></h1>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Bibtex can be found at the right side at the <a class="reference external" href="https://github.com/erdogant/scatterd/">github page</a>.</p>
Expand Down
Loading

0 comments on commit 56236f0

Please sign in to comment.