Skip to content

Commit

Permalink
Merge pull request #198 from JaimePSantos/docs
Browse files Browse the repository at this point in the history
Docs
  • Loading branch information
JaimePSantos authored Feb 8, 2024
2 parents 27f13af + 9c068c7 commit babbe1b
Show file tree
Hide file tree
Showing 156 changed files with 3,671 additions and 123 deletions.
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +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: 15b27e59b7da2801ad652eaa40d4813a
config: 2dc599ecb69f66bb34265008383d8b01
tags: 645f666f9bcd5a90fca523b33c5a78b7
10 changes: 8 additions & 2 deletions docs/_modules/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,15 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../utils.html">utils package</a></li>
</ul>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/Errors.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/Operator.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/ProbabilityDistribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/QuantumWalk.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/State.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/StochasticOperator.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
11 changes: 9 additions & 2 deletions docs/_modules/qwak/StochasticProbabilityDistribution.html
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,16 @@
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../usage.html">Usage</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../usage.html">Usage</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Usage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../searchingQWAK.html">Searching With QWAK</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../perfectStateTransfer.html">Perfect State Transfer</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../orientedQuantumWalk.html">Oriented Quantum Walk</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../stochasticQWAK.html">Stochastic Qwak on a Maze</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../../contributing.html">Contributing</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l1 has-children"><a class="reference internal" href="../../modules.html">Modules</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Modules</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../../qwak.html">qwak package</a></li>
<li class="toctree-l2"><a class="reference internal" href="../../utils.html">utils package</a></li>
</ul>
</li>
Expand Down
Loading

0 comments on commit babbe1b

Please sign in to comment.