Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stephendiadamo committed Feb 27, 2020
1 parent 9789f39 commit b79150d
Show file tree
Hide file tree
Showing 22 changed files with 73 additions and 71 deletions.
2 changes: 1 addition & 1 deletion docs/_build/.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: 99ebc53a558f7db984f4096823bed80a
config: bccdc9a187675bfcb7d70717ac25d551
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified docs/_build/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/.doctrees/examples.doctree
Binary file not shown.
Binary file modified docs/_build/.doctrees/examples/create_and_measure.doctree
Binary file not shown.
Binary file modified docs/_build/.doctrees/examples/epr_creation.doctree
Binary file not shown.
Binary file modified docs/_build/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/_build/.doctrees/install.doctree
Binary file not shown.
Binary file modified docs/_build/.doctrees/intro.doctree
Binary file not shown.
6 changes: 1 addition & 5 deletions docs/_build/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -672,10 +672,6 @@ div.code-block-caption + div > div.highlight > pre {
margin-top: 0;
}

div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
}

div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
Expand Down
7 changes: 3 additions & 4 deletions docs/_build/_static/doctools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -283,11 +283,10 @@ var Documentation = {
},

initOnKeyListeners: function() {
$(document).keydown(function(event) {
$(document).keyup(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box or textarea
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) {
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
Expand Down
1 change: 0 additions & 1 deletion docs/_build/_static/documentation_options.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ var DOCUMENTATION_OPTIONS = {
VERSION: '',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/_static/language_data.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down
28 changes: 11 additions & 17 deletions docs/_build/_static/searchtools.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
* :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
Expand Down Expand Up @@ -63,11 +63,6 @@ var Search = {
htmlElement.innerHTML = htmlString;
$(htmlElement).find('.headerlink').remove();
docContent = $(htmlElement).find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");
return "";
}
return docContent.textContent || docContent.innerText;
},

Expand Down Expand Up @@ -250,32 +245,31 @@ var Search = {
if (results.length) {
var item = results.pop();
var listItem = $('<li style="display:none"></li>');
var requestUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;

listItem.append($('<a/>').attr('href',
DOCUMENTATION_OPTIONS.URL_ROOT + dirname +
highlightstring + item[2]).html(item[1]));
} else {
// normal html builders
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
}
listItem.append($('<a/>').attr('href',
requestUrl +
listItem.append($('<a/>').attr('href',
item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
highlightstring + item[2]).html(item[1]));
}
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
listItem.slideDown(5, function() {
displayNextItem();
});
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: requestUrl,
$.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
Expand Down Expand Up @@ -430,15 +424,15 @@ var Search = {
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {};
scoreMap[file] = {}
scoreMap[file][word] = o.score;
}
});

// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap && fileMap[file].indexOf(word) === -1)
if (file in fileMap)
fileMap[file].push(word);
else
fileMap[file] = [word];
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/examples.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down
21 changes: 13 additions & 8 deletions docs/_build/examples/create_and_measure.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>

<script type="text/javascript" src="../_static/js/theme.js"></script>

Expand All @@ -36,7 +36,9 @@
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="EPR State Creation" href="epr_creation.html" />
<link rel="prev" title="Examples" href="../examples.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -85,10 +87,11 @@


<p class="caption"><span class="caption-text">Contents</span></p>
<ul>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="../examples.html">Examples</a><ul>
<li class="toctree-l1 current"><a class="reference internal" href="../examples.html">Examples</a><ul class="current">
<li class="toctree-l2 current"><a class="current reference internal" href="#">Create Qubit and Measure</a></li>
<li class="toctree-l2"><a class="reference internal" href="epr_creation.html">EPR State Creation</a></li>
</ul>
</li>
Expand Down Expand Up @@ -137,6 +140,8 @@

<li><a href="../index.html">Docs</a> &raquo;</li>

<li><a href="../examples.html">Examples</a> &raquo;</li>

<li>Create Qubit and Measure</li>


Expand Down Expand Up @@ -174,7 +179,7 @@ <h1>Create Qubit and Measure<a class="headerlink" href="#create-qubit-and-measur
<span class="c1"># Measure the Qubit with id A</span>
<span class="n">m</span> <span class="o">=</span> <span class="n">eqsn</span><span class="o">.</span><span class="n">measure</span><span class="p">(</span><span class="s1">&#39;A&#39;</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Measured Qubit with id &#39;A&#39; with result </span><span class="si">%d</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="n">m</span><span class="p">)</span>
<span class="k">print</span><span class="p">(</span><span class="s2">&quot;Measured Qubit with id &#39;A&#39; with result </span><span class="si">%d</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="n">m</span><span class="p">)</span>
</pre></div>
</td></tr></table></div>
</div>
Expand Down
13 changes: 7 additions & 6 deletions docs/_build/examples/epr_creation.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="../" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/language_data.js"></script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<script type="text/javascript" src="../_static/language_data.js"></script>

<script type="text/javascript" src="../_static/js/theme.js"></script>

Expand All @@ -37,7 +37,7 @@
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="prev" title="Examples" href="../examples.html" />
<link rel="prev" title="Create Qubit and Measure" href="create_and_measure.html" />
</head>

<body class="wy-body-for-nav">
Expand Down Expand Up @@ -90,6 +90,7 @@
<li class="toctree-l1"><a class="reference internal" href="../intro.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../install.html">Install</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../examples.html">Examples</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="create_and_measure.html">Create Qubit and Measure</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">EPR State Creation</a></li>
</ul>
</li>
Expand Down Expand Up @@ -194,7 +195,7 @@ <h1>EPR State Creation<a class="headerlink" href="#epr-state-creation" title="Pe
<span class="n">m1</span> <span class="o">=</span> <span class="n">eqsn</span><span class="o">.</span><span class="n">measure</span><span class="p">(</span><span class="s1">&#39;A&#39;</span><span class="p">)</span>
<span class="n">m2</span> <span class="o">=</span> <span class="n">eqsn</span><span class="o">.</span><span class="n">measure</span><span class="p">(</span><span class="s1">&#39;B&#39;</span><span class="p">)</span>

<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;measured </span><span class="si">%d</span><span class="s2"> and </span><span class="si">%d</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">m1</span><span class="p">,</span> <span class="n">m2</span><span class="p">))</span>
<span class="k">print</span><span class="p">(</span><span class="s2">&quot;measured </span><span class="si">%d</span><span class="s2"> and </span><span class="si">%d</span><span class="s2">.&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">m1</span><span class="p">,</span> <span class="n">m2</span><span class="p">))</span>
</pre></div>
</td></tr></table></div>
</div>
Expand Down
8 changes: 4 additions & 4 deletions docs/_build/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down
8 changes: 4 additions & 4 deletions docs/_build/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down
14 changes: 9 additions & 5 deletions docs/_build/install.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down Expand Up @@ -90,7 +90,11 @@
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="intro.html">Introduction</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/create_and_measure.html">Create Qubit and Measure</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/epr_creation.html">EPR State Creation</a></li>
</ul>
</li>
</ul>


Expand Down
14 changes: 9 additions & 5 deletions docs/_build/intro.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down Expand Up @@ -90,7 +90,11 @@
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="install.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples/create_and_measure.html">Create Qubit and Measure</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples/epr_creation.html">EPR State Creation</a></li>
</ul>
</li>
</ul>


Expand Down
10 changes: 5 additions & 5 deletions docs/_build/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@


<script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/language_data.js"></script>
<script src="_static/searchtools.js"></script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/language_data.js"></script>
<script type="text/javascript" src="_static/searchtools.js"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

Expand Down
Loading

0 comments on commit b79150d

Please sign in to comment.