Skip to content

Commit 499d9e0

Browse files
committed
update sphinx pages
1 parent 4de0b8c commit 499d9e0

35 files changed

Lines changed: 1011 additions & 990 deletions
15 Bytes
Binary file not shown.
15 Bytes
Binary file not shown.
15 Bytes
Binary file not shown.
15 Bytes
Binary file not shown.
15 Bytes
Binary file not shown.
425 Bytes
Binary file not shown.

docs/pages/doctrees/index.doctree

2.86 KB
Binary file not shown.
35 Bytes
Binary file not shown.

docs/pages/html/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 70247cefd91eb3908a42ad689a3f0ad2
3+
config: 12abab9ec9d9d437fdfa0d34968508ea
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/pages/html/Coding quality.html

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
1616
<script src="_static/jquery.js"></script>
1717
<script src="_static/underscore.js"></script>
18+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
1819
<script src="_static/doctools.js"></script>
1920
<script src="_static/js/theme.js"></script>
2021
<link rel="index" title="Index" href="genindex.html" />
@@ -102,14 +103,14 @@
102103
<div itemprop="articleBody">
103104

104105
<section id="coding-quality">
105-
<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink to this headline"></a></h1>
106+
<h1>Coding quality<a class="headerlink" href="#coding-quality" title="Permalink to this heading"></a></h1>
106107
<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.
107108
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%.
108109
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>
109110
<p>This library is therefore developed with several techniques, such as coding styling, low complexity, docstrings, reviews, and unit tests.
110111
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>
111112
<section id="library">
112-
<h2>library<a class="headerlink" href="#library" title="Permalink to this headline"></a></h2>
113+
<h2>library<a class="headerlink" href="#library" title="Permalink to this heading"></a></h2>
113114
<p>The file structure of the generated package looks like:</p>
114115
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>path/to/treeplot/
115116
├── .editorconfig
@@ -139,13 +140,13 @@ <h2>library<a class="headerlink" href="#library" title="Permalink to this headli
139140
</div>
140141
</section>
141142
<section id="style">
142-
<h2>Style<a class="headerlink" href="#style" title="Permalink to this headline"></a></h2>
143+
<h2>Style<a class="headerlink" href="#style" title="Permalink to this heading"></a></h2>
143144
<p>This library is compliant with the PEP-8 standards.
144145
PEP stands for Python Enhancement Proposal and sets a baseline for the readability of Python code.
145146
Each public function contains a docstring that is based on numpy standards.</p>
146147
</section>
147148
<section id="complexity">
148-
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this headline"></a></h2>
149+
<h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this heading"></a></h2>
149150
<p>This library has been developed by using measures that help decreasing technical debt.
150151
Developing software with low(er) technical dept may take extra development time, but has many advantages:</p>
151152
<ul class="simple">
@@ -156,7 +157,7 @@ <h2>Complexity<a class="headerlink" href="#complexity" title="Permalink to this
156157
</ul>
157158
</section>
158159
<section id="unit-tests">
159-
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this headline"></a></h2>
160+
<h2>Unit tests<a class="headerlink" href="#unit-tests" title="Permalink to this heading"></a></h2>
160161
<p>The use of unit tests is essential to garantee a consistent output of developed functions.
161162
The following tests are secured using <code class="xref py py-func docutils literal notranslate"><span class="pre">tests.test_treeplot()</span></code>:</p>
162163
<ul class="simple">

0 commit comments

Comments
 (0)