Skip to content

Commit 676390a

Browse files
daguzman35daguzman35
committed
Update documentation v1.2.1, include examples
Included source code of examples in the documentation. Updated version numbering to v1.2.1.
1 parent 6344aef commit 676390a

File tree

18 files changed

+82
-72
lines changed

18 files changed

+82
-72
lines changed

‎PyAbacus_Documentation.pdf‎

46.6 KB
Binary file not shown.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ pyAbacus is built to simplify the usage of Tausand Abacus family of coincidence
55
Written in Python3, pyAbacus relies on the following modules:
66
- pyserial
77

8-
Library version: 1.2.0<br/>
8+
Library version: 1.2.1<br/>
99
Original release date: 12/28/2017 (mm/dd/yyyy)<br/>
10-
Current release date: 01/12/2023<br/>
10+
Current release date: 06/11/2024<br/>
1111
Supported models: AB1002, AB1004, AB1502, AB1504, AB2502, AB2504.
1212

1313
## About Tausand Abacus AB1000

‎docs/build/html/_sources/index.rst.txt‎

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,12 @@ pyAbacus was built to simplify the usage of Tausand_ Abacus family of coincidenc
1919
Contents
2020
-----------------------------------------
2121
.. toctree::
22-
:maxdepth: 2
22+
:maxdepth: 3
2323

2424
core
25-
26-
.. toctree::
27-
:maxdepth: 2
28-
29-
exceptions
30-
31-
.. toctree::
32-
:maxdepth: 2
33-
34-
constants
35-
25+
exceptions
26+
constants
27+
examples
3628

3729
Indices and tables
3830
==================

‎docs/build/html/_static/documentation_options.js‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
3-
VERSION: '1.2.0',
4-
LANGUAGE: 'None',
3+
VERSION: '1.2.1',
4+
LANGUAGE: 'en',
55
COLLAPSE_INDEX: false,
66
BUILDER: 'html',
77
FILE_SUFFIX: '.html',

‎docs/build/html/constants.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>pyAbacus.constants &mdash; PyAbacus Documentation 1.2.0 documentation</title>
7+
<title>pyAbacus.constants &mdash; PyAbacus Documentation 1.2.1 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<!--[if lt IE 9]>
@@ -240,7 +240,7 @@
240240
<hr/>
241241

242242
<div role="contentinfo">
243-
<p>&#169; Copyright 2022, Tausand Electronics.</p>
243+
<p>&#169; Copyright 2024, Tausand Electronics.</p>
244244
</div>
245245

246246
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/core.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>pyAbacus.core &mdash; PyAbacus Documentation 1.2.0 documentation</title>
7+
<title>pyAbacus.core &mdash; PyAbacus Documentation 1.2.1 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<!--[if lt IE 9]>
@@ -720,7 +720,7 @@
720720
<hr/>
721721

722722
<div role="contentinfo">
723-
<p>&#169; Copyright 2022, Tausand Electronics.</p>
723+
<p>&#169; Copyright 2024, Tausand Electronics.</p>
724724
</div>
725725

726726
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/exceptions.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>pyAbacus.exceptions &mdash; PyAbacus Documentation 1.2.0 documentation</title>
7+
<title>pyAbacus.exceptions &mdash; PyAbacus Documentation 1.2.1 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<!--[if lt IE 9]>
@@ -115,7 +115,7 @@
115115
<hr/>
116116

117117
<div role="contentinfo">
118-
<p>&#169; Copyright 2022, Tausand Electronics.</p>
118+
<p>&#169; Copyright 2024, Tausand Electronics.</p>
119119
</div>
120120

121121
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/genindex.html‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<head>
44
<meta charset="utf-8" />
55
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6-
<title>Index &mdash; PyAbacus Documentation 1.2.0 documentation</title>
6+
<title>Index &mdash; PyAbacus Documentation 1.2.1 documentation</title>
77
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
88
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
99
<!--[if lt IE 9]>
@@ -36,12 +36,9 @@
3636
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3737
<ul>
3838
<li class="toctree-l1"><a class="reference internal" href="core.html">pyAbacus.core</a></li>
39-
</ul>
40-
<ul>
4139
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">pyAbacus.exceptions</a></li>
42-
</ul>
43-
<ul>
4440
<li class="toctree-l1"><a class="reference internal" href="constants.html">pyAbacus.constants</a></li>
41+
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
4542
</ul>
4643

4744
</div>
@@ -478,7 +475,7 @@ <h2 id="W">W</h2>
478475
<hr/>
479476

480477
<div role="contentinfo">
481-
<p>&#169; Copyright 2022, Tausand Electronics.</p>
478+
<p>&#169; Copyright 2024, Tausand Electronics.</p>
482479
</div>
483480

484481
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/index.html‎

Lines changed: 12 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
55

66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Welcome to PyAbacus’s documentation! &mdash; PyAbacus Documentation 1.2.0 documentation</title>
7+
<title>Welcome to PyAbacus’s documentation! &mdash; PyAbacus Documentation 1.2.1 documentation</title>
88
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
99
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
1010
<!--[if lt IE 9]>
@@ -38,12 +38,9 @@
3838
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
3939
<ul>
4040
<li class="toctree-l1"><a class="reference internal" href="core.html">pyAbacus.core</a></li>
41-
</ul>
42-
<ul>
4341
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">pyAbacus.exceptions</a></li>
44-
</ul>
45-
<ul>
4642
<li class="toctree-l1"><a class="reference internal" href="constants.html">pyAbacus.constants</a></li>
43+
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
4744
</ul>
4845

4946
</div>
@@ -81,24 +78,24 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
8178
<div class="toctree-wrapper compound">
8279
<ul>
8380
<li class="toctree-l1"><a class="reference internal" href="core.html">pyAbacus.core</a></li>
84-
</ul>
85-
</div>
86-
<div class="toctree-wrapper compound">
87-
<ul>
8881
<li class="toctree-l1"><a class="reference internal" href="exceptions.html">pyAbacus.exceptions</a></li>
89-
</ul>
90-
</div>
91-
<div class="toctree-wrapper compound">
92-
<ul>
9382
<li class="toctree-l1"><a class="reference internal" href="constants.html">pyAbacus.constants</a></li>
83+
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
84+
<li class="toctree-l2"><a class="reference internal" href="examples.html#abacusexample-py">abacusExample.py</a></li>
85+
<li class="toctree-l2"><a class="reference internal" href="examples.html#multiplereadexample-py">multipleReadExample.py</a></li>
86+
<li class="toctree-l2"><a class="reference internal" href="examples.html#openportexample-py">openPortExample.py</a></li>
87+
<li class="toctree-l2"><a class="reference internal" href="examples.html#readspeedtestexample-py">readSpeedTestExample.py</a></li>
88+
<li class="toctree-l2"><a class="reference internal" href="examples.html#singlereadexample-py">singleReadExample.py</a></li>
89+
</ul>
90+
</li>
9491
</ul>
9592
</div>
9693
</section>
9794
</section>
9895
<section id="indices-and-tables">
9996
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
10097
<ul class="simple">
101-
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Índice</span></a></p></li>
98+
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
10299
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
103100
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
104101
</ul>
@@ -114,7 +111,7 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe
114111
<hr/>
115112

116113
<div role="contentinfo">
117-
<p>&#169; Copyright 2022, Tausand Electronics.</p>
114+
<p>&#169; Copyright 2024, Tausand Electronics.</p>
118115
</div>
119116

120117
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a

‎docs/build/html/objects.inv‎

5 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)