restructure to account for new theme, add new build process, update readme
768
docs/_build/dirhtml/_static/basic.css
vendored
Normal file
@@ -0,0 +1,768 @@
|
||||
/*
|
||||
* basic.css
|
||||
* ~~~~~~~~~
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/* -- main layout ----------------------------------------------------------- */
|
||||
|
||||
div.clearer {
|
||||
clear: both;
|
||||
}
|
||||
|
||||
/* -- relbar ---------------------------------------------------------------- */
|
||||
|
||||
div.related {
|
||||
width: 100%;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
div.related h3 {
|
||||
display: none;
|
||||
}
|
||||
|
||||
div.related ul {
|
||||
margin: 0;
|
||||
padding: 0 0 0 10px;
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.related li {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
div.related li.right {
|
||||
float: right;
|
||||
margin-right: 5px;
|
||||
}
|
||||
|
||||
/* -- sidebar --------------------------------------------------------------- */
|
||||
|
||||
div.sphinxsidebarwrapper {
|
||||
padding: 10px 5px 0 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar {
|
||||
float: left;
|
||||
width: 230px;
|
||||
margin-left: -100%;
|
||||
font-size: 90%;
|
||||
word-wrap: break-word;
|
||||
overflow-wrap : break-word;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul {
|
||||
list-style: none;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul,
|
||||
div.sphinxsidebar ul.want-points {
|
||||
margin-left: 20px;
|
||||
list-style: square;
|
||||
}
|
||||
|
||||
div.sphinxsidebar ul ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
div.sphinxsidebar form {
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
div.sphinxsidebar input {
|
||||
border: 1px solid #98dbcc;
|
||||
font-family: sans-serif;
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox form.search {
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="text"] {
|
||||
float: left;
|
||||
width: 80%;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
div.sphinxsidebar #searchbox input[type="submit"] {
|
||||
float: left;
|
||||
width: 20%;
|
||||
border-left: none;
|
||||
padding: 0.25em;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
|
||||
img {
|
||||
border: 0;
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
/* -- search page ----------------------------------------------------------- */
|
||||
|
||||
ul.search {
|
||||
margin: 10px 0 0 20px;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
ul.search li {
|
||||
padding: 5px 0 5px 20px;
|
||||
background-image: url(file.png);
|
||||
background-repeat: no-repeat;
|
||||
background-position: 0 7px;
|
||||
}
|
||||
|
||||
ul.search li a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
ul.search li div.context {
|
||||
color: #888;
|
||||
margin: 2px 0 0 30px;
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
ul.keywordmatches li.goodmatch a {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- index page ------------------------------------------------------------ */
|
||||
|
||||
table.contentstable {
|
||||
width: 90%;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.contentstable p.biglink {
|
||||
line-height: 150%;
|
||||
}
|
||||
|
||||
a.biglink {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
span.linkdescr {
|
||||
font-style: italic;
|
||||
padding-top: 5px;
|
||||
font-size: 90%;
|
||||
}
|
||||
|
||||
/* -- general index --------------------------------------------------------- */
|
||||
|
||||
table.indextable {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
table.indextable td {
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
table.indextable ul {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
list-style-type: none;
|
||||
}
|
||||
|
||||
table.indextable > tbody > tr > td > ul {
|
||||
padding-left: 0em;
|
||||
}
|
||||
|
||||
table.indextable tr.pcap {
|
||||
height: 10px;
|
||||
}
|
||||
|
||||
table.indextable tr.cap {
|
||||
margin-top: 10px;
|
||||
background-color: #f2f2f2;
|
||||
}
|
||||
|
||||
img.toggler {
|
||||
margin-right: 3px;
|
||||
margin-top: 3px;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
div.modindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
div.genindex-jumpbox {
|
||||
border-top: 1px solid #ddd;
|
||||
border-bottom: 1px solid #ddd;
|
||||
margin: 1em 0 1em 0;
|
||||
padding: 0.4em;
|
||||
}
|
||||
|
||||
/* -- domain module index --------------------------------------------------- */
|
||||
|
||||
table.modindextable td {
|
||||
padding: 2px;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
/* -- general body styles --------------------------------------------------- */
|
||||
|
||||
div.body {
|
||||
min-width: 450px;
|
||||
max-width: 800px;
|
||||
}
|
||||
|
||||
div.body p, div.body dd, div.body li, div.body blockquote {
|
||||
-moz-hyphens: auto;
|
||||
-ms-hyphens: auto;
|
||||
-webkit-hyphens: auto;
|
||||
hyphens: auto;
|
||||
}
|
||||
|
||||
a.headerlink {
|
||||
visibility: hidden;
|
||||
}
|
||||
|
||||
a.brackets:before,
|
||||
span.brackets > a:before{
|
||||
content: "[";
|
||||
}
|
||||
|
||||
a.brackets:after,
|
||||
span.brackets > a:after {
|
||||
content: "]";
|
||||
}
|
||||
|
||||
h1:hover > a.headerlink,
|
||||
h2:hover > a.headerlink,
|
||||
h3:hover > a.headerlink,
|
||||
h4:hover > a.headerlink,
|
||||
h5:hover > a.headerlink,
|
||||
h6:hover > a.headerlink,
|
||||
dt:hover > a.headerlink,
|
||||
caption:hover > a.headerlink,
|
||||
p.caption:hover > a.headerlink,
|
||||
div.code-block-caption:hover > a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
div.body p.caption {
|
||||
text-align: inherit;
|
||||
}
|
||||
|
||||
div.body td {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.first {
|
||||
margin-top: 0 !important;
|
||||
}
|
||||
|
||||
p.rubric {
|
||||
margin-top: 30px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
img.align-left, .figure.align-left, object.align-left {
|
||||
clear: left;
|
||||
float: left;
|
||||
margin-right: 1em;
|
||||
}
|
||||
|
||||
img.align-right, .figure.align-right, object.align-right {
|
||||
clear: right;
|
||||
float: right;
|
||||
margin-left: 1em;
|
||||
}
|
||||
|
||||
img.align-center, .figure.align-center, object.align-center {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
img.align-default, .figure.align-default {
|
||||
display: block;
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
.align-left {
|
||||
text-align: left;
|
||||
}
|
||||
|
||||
.align-center {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-default {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
.align-right {
|
||||
text-align: right;
|
||||
}
|
||||
|
||||
/* -- sidebars -------------------------------------------------------------- */
|
||||
|
||||
div.sidebar {
|
||||
margin: 0 0 0.5em 1em;
|
||||
border: 1px solid #ddb;
|
||||
padding: 7px 7px 0 7px;
|
||||
background-color: #ffe;
|
||||
width: 40%;
|
||||
float: right;
|
||||
}
|
||||
|
||||
p.sidebar-title {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
/* -- topics ---------------------------------------------------------------- */
|
||||
|
||||
div.topic {
|
||||
border: 1px solid #ccc;
|
||||
padding: 7px 7px 0 7px;
|
||||
margin: 10px 0 10px 0;
|
||||
}
|
||||
|
||||
p.topic-title {
|
||||
font-size: 1.1em;
|
||||
font-weight: bold;
|
||||
margin-top: 10px;
|
||||
}
|
||||
|
||||
/* -- admonitions ----------------------------------------------------------- */
|
||||
|
||||
div.admonition {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
padding: 7px;
|
||||
}
|
||||
|
||||
div.admonition dt {
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.admonition dl {
|
||||
margin-bottom: 0;
|
||||
}
|
||||
|
||||
p.admonition-title {
|
||||
margin: 0px 10px 5px 0px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
div.body p.centered {
|
||||
text-align: center;
|
||||
margin-top: 25px;
|
||||
}
|
||||
|
||||
/* -- tables ---------------------------------------------------------------- */
|
||||
|
||||
table.docutils {
|
||||
border: 0;
|
||||
border-collapse: collapse;
|
||||
}
|
||||
|
||||
table.align-center {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table.align-default {
|
||||
margin-left: auto;
|
||||
margin-right: auto;
|
||||
}
|
||||
|
||||
table caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
table caption span.caption-text {
|
||||
}
|
||||
|
||||
table.docutils td, table.docutils th {
|
||||
padding: 1px 8px 1px 5px;
|
||||
border-top: 0;
|
||||
border-left: 0;
|
||||
border-right: 0;
|
||||
border-bottom: 1px solid #aaa;
|
||||
}
|
||||
|
||||
table.footnote td, table.footnote th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
th {
|
||||
text-align: left;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
table.citation {
|
||||
border-left: solid 1px gray;
|
||||
margin-left: 1px;
|
||||
}
|
||||
|
||||
table.citation td {
|
||||
border-bottom: none;
|
||||
}
|
||||
|
||||
th > p:first-child,
|
||||
td > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
th > p:last-child,
|
||||
td > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
/* -- figures --------------------------------------------------------------- */
|
||||
|
||||
div.figure {
|
||||
margin: 0.5em;
|
||||
padding: 0.5em;
|
||||
}
|
||||
|
||||
div.figure p.caption {
|
||||
padding: 0.3em;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-number {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
div.figure p.caption span.caption-text {
|
||||
}
|
||||
|
||||
/* -- field list styles ----------------------------------------------------- */
|
||||
|
||||
table.field-list td, table.field-list th {
|
||||
border: 0 !important;
|
||||
}
|
||||
|
||||
.field-list ul {
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
}
|
||||
|
||||
.field-list p {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.field-name {
|
||||
-moz-hyphens: manual;
|
||||
-ms-hyphens: manual;
|
||||
-webkit-hyphens: manual;
|
||||
hyphens: manual;
|
||||
}
|
||||
|
||||
/* -- hlist styles ---------------------------------------------------------- */
|
||||
|
||||
table.hlist td {
|
||||
vertical-align: top;
|
||||
}
|
||||
|
||||
|
||||
/* -- other body styles ----------------------------------------------------- */
|
||||
|
||||
ol.arabic {
|
||||
list-style: decimal;
|
||||
}
|
||||
|
||||
ol.loweralpha {
|
||||
list-style: lower-alpha;
|
||||
}
|
||||
|
||||
ol.upperalpha {
|
||||
list-style: upper-alpha;
|
||||
}
|
||||
|
||||
ol.lowerroman {
|
||||
list-style: lower-roman;
|
||||
}
|
||||
|
||||
ol.upperroman {
|
||||
list-style: upper-roman;
|
||||
}
|
||||
|
||||
li > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
li > p:last-child {
|
||||
margin-bottom: 0px;
|
||||
}
|
||||
|
||||
dl.footnote > dt,
|
||||
dl.citation > dt {
|
||||
float: left;
|
||||
}
|
||||
|
||||
dl.footnote > dd,
|
||||
dl.citation > dd {
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl.footnote > dd:after,
|
||||
dl.citation > dd:after {
|
||||
content: "";
|
||||
clear: both;
|
||||
}
|
||||
|
||||
dl.field-list {
|
||||
display: grid;
|
||||
grid-template-columns: fit-content(30%) auto;
|
||||
}
|
||||
|
||||
dl.field-list > dt {
|
||||
font-weight: bold;
|
||||
word-break: break-word;
|
||||
padding-left: 0.5em;
|
||||
padding-right: 5px;
|
||||
}
|
||||
|
||||
dl.field-list > dt:after {
|
||||
content: ":";
|
||||
}
|
||||
|
||||
dl.field-list > dd {
|
||||
padding-left: 0.5em;
|
||||
margin-top: 0em;
|
||||
margin-left: 0em;
|
||||
margin-bottom: 0em;
|
||||
}
|
||||
|
||||
dl {
|
||||
margin-bottom: 15px;
|
||||
}
|
||||
|
||||
dd > p:first-child {
|
||||
margin-top: 0px;
|
||||
}
|
||||
|
||||
dd ul, dd table {
|
||||
margin-bottom: 10px;
|
||||
}
|
||||
|
||||
dd {
|
||||
margin-top: 3px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 30px;
|
||||
}
|
||||
|
||||
dt:target, span.highlighted {
|
||||
background-color: #fbe54e;
|
||||
}
|
||||
|
||||
rect.highlighted {
|
||||
fill: #fbe54e;
|
||||
}
|
||||
|
||||
dl.glossary dt {
|
||||
font-weight: bold;
|
||||
font-size: 1.1em;
|
||||
}
|
||||
|
||||
.optional {
|
||||
font-size: 1.3em;
|
||||
}
|
||||
|
||||
.sig-paren {
|
||||
font-size: larger;
|
||||
}
|
||||
|
||||
.versionmodified {
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
.system-message {
|
||||
background-color: #fda;
|
||||
padding: 5px;
|
||||
border: 3px solid red;
|
||||
}
|
||||
|
||||
.footnote:target {
|
||||
background-color: #ffa;
|
||||
}
|
||||
|
||||
.line-block {
|
||||
display: block;
|
||||
margin-top: 1em;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.line-block .line-block {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
margin-left: 1.5em;
|
||||
}
|
||||
|
||||
.guilabel, .menuselection {
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
.accelerator {
|
||||
text-decoration: underline;
|
||||
}
|
||||
|
||||
.classifier {
|
||||
font-style: oblique;
|
||||
}
|
||||
|
||||
.classifier:before {
|
||||
font-style: normal;
|
||||
margin: 0.5em;
|
||||
content: ":";
|
||||
}
|
||||
|
||||
abbr, acronym {
|
||||
border-bottom: dotted 1px;
|
||||
cursor: help;
|
||||
}
|
||||
|
||||
/* -- code displays --------------------------------------------------------- */
|
||||
|
||||
pre {
|
||||
overflow: auto;
|
||||
overflow-y: hidden; /* fixes display issues on Chrome browsers */
|
||||
}
|
||||
|
||||
span.pre {
|
||||
-moz-hyphens: none;
|
||||
-ms-hyphens: none;
|
||||
-webkit-hyphens: none;
|
||||
hyphens: none;
|
||||
}
|
||||
|
||||
td.linenos pre {
|
||||
padding: 5px 0px;
|
||||
border: 0;
|
||||
background-color: transparent;
|
||||
color: #aaa;
|
||||
}
|
||||
|
||||
table.highlighttable {
|
||||
margin-left: 0.5em;
|
||||
}
|
||||
|
||||
table.highlighttable td {
|
||||
padding: 0 0.5em 0 0.5em;
|
||||
}
|
||||
|
||||
div.code-block-caption {
|
||||
padding: 2px 5px;
|
||||
font-size: small;
|
||||
}
|
||||
|
||||
div.code-block-caption code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
div.code-block-caption span.caption-text {
|
||||
}
|
||||
|
||||
div.literal-block-wrapper {
|
||||
padding: 1em 1em 0;
|
||||
}
|
||||
|
||||
div.literal-block-wrapper div.highlight {
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
code.descname {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
font-size: 1.2em;
|
||||
}
|
||||
|
||||
code.descclassname {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
code.xref, a code {
|
||||
background-color: transparent;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.viewcode-link {
|
||||
float: right;
|
||||
}
|
||||
|
||||
.viewcode-back {
|
||||
float: right;
|
||||
font-family: sans-serif;
|
||||
}
|
||||
|
||||
div.viewcode-block:target {
|
||||
margin: -1px -10px;
|
||||
padding: 0 10px;
|
||||
}
|
||||
|
||||
/* -- math display ---------------------------------------------------------- */
|
||||
|
||||
img.math {
|
||||
vertical-align: middle;
|
||||
}
|
||||
|
||||
div.body div.math p {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
span.eqno {
|
||||
float: right;
|
||||
}
|
||||
|
||||
span.eqno a.headerlink {
|
||||
position: relative;
|
||||
left: 0px;
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
div.math:hover a.headerlink {
|
||||
visibility: visible;
|
||||
}
|
||||
|
||||
/* -- printout stylesheet --------------------------------------------------- */
|
||||
|
||||
@media print {
|
||||
div.document,
|
||||
div.documentwrapper,
|
||||
div.bodywrapper {
|
||||
margin: 0 !important;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
div.sphinxsidebar,
|
||||
div.related,
|
||||
div.footer,
|
||||
#top-link {
|
||||
display: none;
|
||||
}
|
||||
}
|
||||
7
docs/_build/dirhtml/_static/clipboard.min.js
vendored
Normal file
1
docs/_build/dirhtml/_static/copy-button.svg
vendored
Normal file
@@ -0,0 +1 @@
|
||||
<svg aria-hidden="true" data-prefix="far" data-icon="copy" class="svg-inline--fa fa-copy fa-w-14" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path fill="#777" d="M433.941 65.941l-51.882-51.882A48 48 0 0 0 348.118 0H176c-26.51 0-48 21.49-48 48v48H48c-26.51 0-48 21.49-48 48v320c0 26.51 21.49 48 48 48h224c26.51 0 48-21.49 48-48v-48h80c26.51 0 48-21.49 48-48V99.882a48 48 0 0 0-14.059-33.941zM266 464H54a6 6 0 0 1-6-6V150a6 6 0 0 1 6-6h74v224c0 26.51 21.49 48 48 48h96v42a6 6 0 0 1-6 6zm128-96H182a6 6 0 0 1-6-6V54a6 6 0 0 1 6-6h106v88c0 13.255 10.745 24 24 24h88v202a6 6 0 0 1-6 6zm6-256h-64V48h9.632c1.591 0 3.117.632 4.243 1.757l48.368 48.368a6 6 0 0 1 1.757 4.243V112z"></path></svg>
|
||||
|
After Width: | Height: | Size: 711 B |
67
docs/_build/dirhtml/_static/copybutton.css
vendored
Normal file
@@ -0,0 +1,67 @@
|
||||
/* Copy buttons */
|
||||
a.copybtn {
|
||||
position: absolute;
|
||||
top: .2em;
|
||||
right: .2em;
|
||||
width: 1em;
|
||||
height: 1em;
|
||||
opacity: .3;
|
||||
transition: opacity 0.5s;
|
||||
border: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
div.highlight {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
a.copybtn > img {
|
||||
vertical-align: top;
|
||||
margin: 0;
|
||||
top: 0;
|
||||
left: 0;
|
||||
position: absolute;
|
||||
}
|
||||
|
||||
.highlight:hover .copybtn {
|
||||
opacity: 1;
|
||||
}
|
||||
|
||||
/**
|
||||
* A minimal CSS-only tooltip copied from:
|
||||
* https://codepen.io/mildrenben/pen/rVBrpK
|
||||
*
|
||||
* To use, write HTML like the following:
|
||||
*
|
||||
* <p class="o-tooltip--left" data-tooltip="Hey">Short</p>
|
||||
*/
|
||||
.o-tooltip--left {
|
||||
position: relative;
|
||||
}
|
||||
|
||||
.o-tooltip--left:after {
|
||||
opacity: 0;
|
||||
visibility: hidden;
|
||||
position: absolute;
|
||||
content: attr(data-tooltip);
|
||||
padding: 2px;
|
||||
top: 0;
|
||||
left: -.2em;
|
||||
background: grey;
|
||||
font-size: 1rem;
|
||||
color: white;
|
||||
white-space: nowrap;
|
||||
z-index: 2;
|
||||
border-radius: 2px;
|
||||
transform: translateX(-102%) translateY(0);
|
||||
transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
|
||||
}
|
||||
|
||||
.o-tooltip--left:hover:after {
|
||||
display: block;
|
||||
opacity: 1;
|
||||
visibility: visible;
|
||||
transform: translateX(-100%) translateY(0);
|
||||
transition: opacity 0.2s cubic-bezier(0.64, 0.09, 0.08, 1), transform 0.2s cubic-bezier(0.64, 0.09, 0.08, 1);
|
||||
transition-delay: .5s;
|
||||
}
|
||||
153
docs/_build/dirhtml/_static/copybutton.js
vendored
Normal file
@@ -0,0 +1,153 @@
|
||||
// Localization support
|
||||
const messages = {
|
||||
'en': {
|
||||
'copy': 'Copy',
|
||||
'copy_to_clipboard': 'Copy to clipboard',
|
||||
'copy_success': 'Copied!',
|
||||
'copy_failure': 'Failed to copy',
|
||||
},
|
||||
'es' : {
|
||||
'copy': 'Copiar',
|
||||
'copy_to_clipboard': 'Copiar al portapapeles',
|
||||
'copy_success': '¡Copiado!',
|
||||
'copy_failure': 'Error al copiar',
|
||||
},
|
||||
'de' : {
|
||||
'copy': 'Kopieren',
|
||||
'copy_to_clipboard': 'In die Zwischenablage kopieren',
|
||||
'copy_success': 'Kopiert!',
|
||||
'copy_failure': 'Fehler beim Kopieren',
|
||||
}
|
||||
}
|
||||
|
||||
let locale = 'en'
|
||||
if( document.documentElement.lang !== undefined
|
||||
&& messages[document.documentElement.lang] !== undefined ) {
|
||||
locale = document.documentElement.lang
|
||||
}
|
||||
|
||||
/**
|
||||
* Set up copy/paste for code blocks
|
||||
*/
|
||||
|
||||
const runWhenDOMLoaded = cb => {
|
||||
if (document.readyState != 'loading') {
|
||||
cb()
|
||||
} else if (document.addEventListener) {
|
||||
document.addEventListener('DOMContentLoaded', cb)
|
||||
} else {
|
||||
document.attachEvent('onreadystatechange', function() {
|
||||
if (document.readyState == 'complete') cb()
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
const codeCellId = index => `codecell${index}`
|
||||
|
||||
// Clears selected text since ClipboardJS will select the text when copying
|
||||
const clearSelection = () => {
|
||||
if (window.getSelection) {
|
||||
window.getSelection().removeAllRanges()
|
||||
} else if (document.selection) {
|
||||
document.selection.empty()
|
||||
}
|
||||
}
|
||||
|
||||
// Changes tooltip text for two seconds, then changes it back
|
||||
const temporarilyChangeTooltip = (el, newText) => {
|
||||
const oldText = el.getAttribute('data-tooltip')
|
||||
el.setAttribute('data-tooltip', newText)
|
||||
setTimeout(() => el.setAttribute('data-tooltip', oldText), 2000)
|
||||
}
|
||||
|
||||
const addCopyButtonToCodeCells = () => {
|
||||
// If ClipboardJS hasn't loaded, wait a bit and try again. This
|
||||
// happens because we load ClipboardJS asynchronously.
|
||||
if (window.ClipboardJS === undefined) {
|
||||
setTimeout(addCopyButtonToCodeCells, 250)
|
||||
return
|
||||
}
|
||||
|
||||
// Add copybuttons to all of our code cells
|
||||
const codeCells = document.querySelectorAll('div.highlight pre')
|
||||
codeCells.forEach((codeCell, index) => {
|
||||
const id = codeCellId(index)
|
||||
codeCell.setAttribute('id', id)
|
||||
const pre_bg = getComputedStyle(codeCell).backgroundColor;
|
||||
|
||||
const clipboardButton = id =>
|
||||
`<a class="copybtn o-tooltip--left" style="background-color: ${pre_bg}" data-tooltip="${messages[locale]['copy']}" data-clipboard-target="#${id}">
|
||||
<img src="${DOCUMENTATION_OPTIONS.URL_ROOT}_static/copy-button.svg" alt="${messages[locale]['copy_to_clipboard']}">
|
||||
</a>`
|
||||
codeCell.insertAdjacentHTML('afterend', clipboardButton(id))
|
||||
})
|
||||
|
||||
function escapeRegExp(string) {
|
||||
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
}
|
||||
|
||||
// Callback when a copy button is clicked. Will be passed the node that was clicked
|
||||
// should then grab the text and replace pieces of text that shouldn't be used in output
|
||||
function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true) {
|
||||
|
||||
var regexp;
|
||||
var match;
|
||||
|
||||
// create regexp to capture prompt and remaining line
|
||||
if (isRegexp) {
|
||||
regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
|
||||
} else {
|
||||
regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
|
||||
}
|
||||
|
||||
const outputLines = [];
|
||||
var promptFound = false;
|
||||
for (const line of textContent.split('\n')) {
|
||||
match = line.match(regexp)
|
||||
if (match) {
|
||||
promptFound = true
|
||||
if (removePrompts) {
|
||||
outputLines.push(match[2])
|
||||
} else {
|
||||
outputLines.push(line)
|
||||
}
|
||||
} else {
|
||||
if (!onlyCopyPromptLines) {
|
||||
outputLines.push(line)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If no lines with the prompt were found then just use original lines
|
||||
if (promptFound) {
|
||||
textContent = outputLines.join('\n');
|
||||
}
|
||||
|
||||
// Remove a trailing newline to avoid auto-running when pasting
|
||||
if (textContent.endsWith("\n")) {
|
||||
textContent = textContent.slice(0, -1)
|
||||
}
|
||||
return textContent
|
||||
}
|
||||
|
||||
|
||||
var copyTargetText = (trigger) => {
|
||||
var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
|
||||
return formatCopyText(target.innerText, '', false, true, true)
|
||||
}
|
||||
|
||||
// Initialize with a callback so we can modify the text before copy
|
||||
const clipboard = new ClipboardJS('.copybtn', {text: copyTargetText})
|
||||
|
||||
// Update UI with error/success messages
|
||||
clipboard.on('success', event => {
|
||||
clearSelection()
|
||||
temporarilyChangeTooltip(event.trigger, messages[locale]['copy_success'])
|
||||
})
|
||||
|
||||
clipboard.on('error', event => {
|
||||
temporarilyChangeTooltip(event.trigger, messages[locale]['copy_failure'])
|
||||
})
|
||||
}
|
||||
|
||||
runWhenDOMLoaded(addCopyButtonToCodeCells)
|
||||
47
docs/_build/dirhtml/_static/copybutton_funcs.js
vendored
Normal file
@@ -0,0 +1,47 @@
|
||||
function escapeRegExp(string) {
|
||||
return string.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
|
||||
}
|
||||
|
||||
// Callback when a copy button is clicked. Will be passed the node that was clicked
|
||||
// should then grab the text and replace pieces of text that shouldn't be used in output
|
||||
export function formatCopyText(textContent, copybuttonPromptText, isRegexp = false, onlyCopyPromptLines = true, removePrompts = true) {
|
||||
|
||||
var regexp;
|
||||
var match;
|
||||
|
||||
// create regexp to capture prompt and remaining line
|
||||
if (isRegexp) {
|
||||
regexp = new RegExp('^(' + copybuttonPromptText + ')(.*)')
|
||||
} else {
|
||||
regexp = new RegExp('^(' + escapeRegExp(copybuttonPromptText) + ')(.*)')
|
||||
}
|
||||
|
||||
const outputLines = [];
|
||||
var promptFound = false;
|
||||
for (const line of textContent.split('\n')) {
|
||||
match = line.match(regexp)
|
||||
if (match) {
|
||||
promptFound = true
|
||||
if (removePrompts) {
|
||||
outputLines.push(match[2])
|
||||
} else {
|
||||
outputLines.push(line)
|
||||
}
|
||||
} else {
|
||||
if (!onlyCopyPromptLines) {
|
||||
outputLines.push(line)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// If no lines with the prompt were found then just use original lines
|
||||
if (promptFound) {
|
||||
textContent = outputLines.join('\n');
|
||||
}
|
||||
|
||||
// Remove a trailing newline to avoid auto-running when pasting
|
||||
if (textContent.endsWith("\n")) {
|
||||
textContent = textContent.slice(0, -1)
|
||||
}
|
||||
return textContent
|
||||
}
|
||||
1
docs/_build/dirhtml/_static/css/main.css
vendored
Normal file
194
docs/_build/dirhtml/_static/default.css
vendored
Normal file
@@ -0,0 +1,194 @@
|
||||
body, p, h1, h2, h3, h4, nav, .topbar, .topbar-main, .tocsection, .form-control, .bd-toc, .bd-sidebar {
|
||||
background-color: #2b2b2b!important;
|
||||
color: #f8f8ff!important;
|
||||
line-height: 1.65;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-size: 2rem;
|
||||
margin-top: 3.5rem;
|
||||
}
|
||||
|
||||
h2 {
|
||||
font-size: 1.5rem;
|
||||
}
|
||||
|
||||
h3 {
|
||||
font-size: 1.25rem;
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 1.15rem;
|
||||
}
|
||||
|
||||
p, nav a {
|
||||
font-size: 1.1em;
|
||||
letter-spacing: 0.75px;
|
||||
}
|
||||
|
||||
a, a:visited, .headerlink {
|
||||
color: #ff4961!important;
|
||||
}
|
||||
|
||||
.bd-toc nav li.active>a.active {
|
||||
border-left: 2px solid #ff4961!important;;
|
||||
}
|
||||
|
||||
.prev-next-bottom a.left-prev, .prev-next-bottom a.right-next {
|
||||
border: 1px solid #f8f8ff;
|
||||
}
|
||||
|
||||
.input:focus {
|
||||
outline: none !important;
|
||||
border:1px solid #ff4961!important;
|
||||
box-shadow: 0 0 10px #ff4961!important;
|
||||
}
|
||||
|
||||
h1, h2 {
|
||||
/* border-bottom: 1px solid #666!important;
|
||||
padding-bottom: 0.5rem!important; */
|
||||
/* font-variant: small-caps; */
|
||||
letter-spacing: 2.3px;
|
||||
|
||||
}
|
||||
|
||||
.admonition.warning .admonition-title, .admonition.note .admonition-title {
|
||||
background-color: #666;
|
||||
}
|
||||
|
||||
.important .admonition-title {
|
||||
background-color: none!important;
|
||||
}
|
||||
|
||||
.header-style:before, h1:before, h2:before, h3:before, h4:before, h5:before, h6:before {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
.bd-sidebar {
|
||||
background: none;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.bd-sidebar {
|
||||
border-right: 0.5px solid #f8f8ff;
|
||||
background: none;
|
||||
}
|
||||
}
|
||||
|
||||
|
||||
a:active {
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
ul.current > .current .active > a.current {
|
||||
text-decoration: underline #f8f8ff;
|
||||
}
|
||||
|
||||
@media (max-width: 768px) {
|
||||
#site-navigation {
|
||||
background-color: #2b2b2b;
|
||||
}
|
||||
}
|
||||
|
||||
code {
|
||||
color: #ff4961!important;
|
||||
}
|
||||
|
||||
.topbar .topbar-main button.topbarbtn {
|
||||
background-color: #2b2b2b;
|
||||
color: #ff4960;
|
||||
}
|
||||
|
||||
@media (min-width: 1200px){
|
||||
.container, .container-lg, .container-md, .container-sm, .container-xl {
|
||||
max-width: 2200px;
|
||||
}
|
||||
}
|
||||
|
||||
.container-fluid, .container-lg, .container-md, .container-sm, .container-xl {
|
||||
width: 90%;
|
||||
}
|
||||
|
||||
.admonition {
|
||||
width: 80%;
|
||||
}
|
||||
|
||||
/* TOGGLE */
|
||||
|
||||
.toggle .admonition {
|
||||
padding-bottom: 0px!important;
|
||||
}
|
||||
|
||||
.toggle .admonition-title {
|
||||
display: block;
|
||||
clear: both;
|
||||
cursor: pointer;
|
||||
}
|
||||
|
||||
.toggle .admonition-title::after {
|
||||
content: " ▶";
|
||||
}
|
||||
|
||||
.toggle .admonition-title.open::after {
|
||||
content: " ▼";
|
||||
}
|
||||
|
||||
.expand {
|
||||
width: 75%;
|
||||
margin: 1em 0 1em 5em;
|
||||
padding: 0 .6rem 0rem!important;
|
||||
border-left: .2rem solid #393838!important;
|
||||
box-shadow: 0 0.2rem 0.5rem rgba(0,0,0,.05), 0 0 0.05rem rgba(0,0,0,.1);
|
||||
transition: color .25s,background-color .25s,border-color .25s;
|
||||
}
|
||||
|
||||
.expand .admonition-title {
|
||||
background-color: #1e1e1e;
|
||||
font-weight: 300;
|
||||
}
|
||||
|
||||
.expand .admonition-title:before {
|
||||
color: #393838!important;
|
||||
}
|
||||
|
||||
@media (max-width: 600px) {
|
||||
.expand {
|
||||
width: 90%;
|
||||
margin: 0 0 1em 1.5em;
|
||||
}
|
||||
}
|
||||
|
||||
.caption > i {
|
||||
display: none;
|
||||
}
|
||||
|
||||
nav.bd-links .fa-chevron-up:hover, nav.bd-links .fa-chevron-down:hover {
|
||||
color: #ff4960;
|
||||
}
|
||||
|
||||
nav.bd-links > ul.nav {
|
||||
padding-right: 8px;
|
||||
}
|
||||
|
||||
.highlight > pre {
|
||||
background-color: lightgray;
|
||||
}
|
||||
|
||||
.set-padding {
|
||||
padding-top: 75px!important;
|
||||
}
|
||||
|
||||
/* MISC */
|
||||
|
||||
.hidden {
|
||||
display: none!important;
|
||||
}
|
||||
|
||||
.navbar-brand-box a.navbar-brand {
|
||||
width: 75%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
.navbar-brand-box {
|
||||
text-align: center;
|
||||
}
|
||||
315
docs/_build/dirhtml/_static/doctools.js
vendored
Normal file
@@ -0,0 +1,315 @@
|
||||
/*
|
||||
* doctools.js
|
||||
* ~~~~~~~~~~~
|
||||
*
|
||||
* Sphinx JavaScript utilities for all documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* select a different prefix for underscore
|
||||
*/
|
||||
$u = _.noConflict();
|
||||
|
||||
/**
|
||||
* make the code below compatible with browsers without
|
||||
* an installed firebug like debugger
|
||||
if (!window.console || !console.firebug) {
|
||||
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
|
||||
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
|
||||
"profile", "profileEnd"];
|
||||
window.console = {};
|
||||
for (var i = 0; i < names.length; ++i)
|
||||
window.console[names[i]] = function() {};
|
||||
}
|
||||
*/
|
||||
|
||||
/**
|
||||
* small helper function to urldecode strings
|
||||
*/
|
||||
jQuery.urldecode = function(x) {
|
||||
return decodeURIComponent(x).replace(/\+/g, ' ');
|
||||
};
|
||||
|
||||
/**
|
||||
* small helper function to urlencode strings
|
||||
*/
|
||||
jQuery.urlencode = encodeURIComponent;
|
||||
|
||||
/**
|
||||
* This function returns the parsed url parameters of the
|
||||
* current request. Multiple values per key are supported,
|
||||
* it will always return arrays of strings for the value parts.
|
||||
*/
|
||||
jQuery.getQueryParameters = function(s) {
|
||||
if (typeof s === 'undefined')
|
||||
s = document.location.search;
|
||||
var parts = s.substr(s.indexOf('?') + 1).split('&');
|
||||
var result = {};
|
||||
for (var i = 0; i < parts.length; i++) {
|
||||
var tmp = parts[i].split('=', 2);
|
||||
var key = jQuery.urldecode(tmp[0]);
|
||||
var value = jQuery.urldecode(tmp[1]);
|
||||
if (key in result)
|
||||
result[key].push(value);
|
||||
else
|
||||
result[key] = [value];
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/**
|
||||
* highlight a given string on a jquery object by wrapping it in
|
||||
* span elements with the given class name.
|
||||
*/
|
||||
jQuery.fn.highlightText = function(text, className) {
|
||||
function highlight(node, addItems) {
|
||||
if (node.nodeType === 3) {
|
||||
var val = node.nodeValue;
|
||||
var pos = val.toLowerCase().indexOf(text);
|
||||
if (pos >= 0 &&
|
||||
!jQuery(node.parentNode).hasClass(className) &&
|
||||
!jQuery(node.parentNode).hasClass("nohighlight")) {
|
||||
var span;
|
||||
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
|
||||
if (isInSVG) {
|
||||
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
|
||||
} else {
|
||||
span = document.createElement("span");
|
||||
span.className = className;
|
||||
}
|
||||
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
|
||||
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
|
||||
document.createTextNode(val.substr(pos + text.length)),
|
||||
node.nextSibling));
|
||||
node.nodeValue = val.substr(0, pos);
|
||||
if (isInSVG) {
|
||||
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
|
||||
var bbox = node.parentElement.getBBox();
|
||||
rect.x.baseVal.value = bbox.x;
|
||||
rect.y.baseVal.value = bbox.y;
|
||||
rect.width.baseVal.value = bbox.width;
|
||||
rect.height.baseVal.value = bbox.height;
|
||||
rect.setAttribute('class', className);
|
||||
addItems.push({
|
||||
"parent": node.parentNode,
|
||||
"target": rect});
|
||||
}
|
||||
}
|
||||
}
|
||||
else if (!jQuery(node).is("button, select, textarea")) {
|
||||
jQuery.each(node.childNodes, function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
}
|
||||
}
|
||||
var addItems = [];
|
||||
var result = this.each(function() {
|
||||
highlight(this, addItems);
|
||||
});
|
||||
for (var i = 0; i < addItems.length; ++i) {
|
||||
jQuery(addItems[i].parent).before(addItems[i].target);
|
||||
}
|
||||
return result;
|
||||
};
|
||||
|
||||
/*
|
||||
* backward compatibility for jQuery.browser
|
||||
* This will be supported until firefox bug is fixed.
|
||||
*/
|
||||
if (!jQuery.browser) {
|
||||
jQuery.uaMatch = function(ua) {
|
||||
ua = ua.toLowerCase();
|
||||
|
||||
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
|
||||
/(msie) ([\w.]+)/.exec(ua) ||
|
||||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
|
||||
[];
|
||||
|
||||
return {
|
||||
browser: match[ 1 ] || "",
|
||||
version: match[ 2 ] || "0"
|
||||
};
|
||||
};
|
||||
jQuery.browser = {};
|
||||
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
|
||||
}
|
||||
|
||||
/**
|
||||
* Small JavaScript module for the documentation.
|
||||
*/
|
||||
var Documentation = {
|
||||
|
||||
init : function() {
|
||||
this.fixFirefoxAnchorBug();
|
||||
this.highlightSearchWords();
|
||||
this.initIndexTable();
|
||||
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
|
||||
this.initOnKeyListeners();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* i18n support
|
||||
*/
|
||||
TRANSLATIONS : {},
|
||||
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
|
||||
LOCALE : 'unknown',
|
||||
|
||||
// gettext and ngettext don't access this so that the functions
|
||||
// can safely bound to a different name (_ = Documentation.gettext)
|
||||
gettext : function(string) {
|
||||
var translated = Documentation.TRANSLATIONS[string];
|
||||
if (typeof translated === 'undefined')
|
||||
return string;
|
||||
return (typeof translated === 'string') ? translated : translated[0];
|
||||
},
|
||||
|
||||
ngettext : function(singular, plural, n) {
|
||||
var translated = Documentation.TRANSLATIONS[singular];
|
||||
if (typeof translated === 'undefined')
|
||||
return (n == 1) ? singular : plural;
|
||||
return translated[Documentation.PLURALEXPR(n)];
|
||||
},
|
||||
|
||||
addTranslations : function(catalog) {
|
||||
for (var key in catalog.messages)
|
||||
this.TRANSLATIONS[key] = catalog.messages[key];
|
||||
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
|
||||
this.LOCALE = catalog.locale;
|
||||
},
|
||||
|
||||
/**
|
||||
* add context elements like header anchor links
|
||||
*/
|
||||
addContextElements : function() {
|
||||
$('div[id] > :header:first').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this headline')).
|
||||
appendTo(this);
|
||||
});
|
||||
$('dt[id]').each(function() {
|
||||
$('<a class="headerlink">\u00B6</a>').
|
||||
attr('href', '#' + this.id).
|
||||
attr('title', _('Permalink to this definition')).
|
||||
appendTo(this);
|
||||
});
|
||||
},
|
||||
|
||||
/**
|
||||
* workaround a firefox stupidity
|
||||
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
|
||||
*/
|
||||
fixFirefoxAnchorBug : function() {
|
||||
if (document.location.hash && $.browser.mozilla)
|
||||
window.setTimeout(function() {
|
||||
document.location.href += '';
|
||||
}, 10);
|
||||
},
|
||||
|
||||
/**
|
||||
* highlight the search words provided in the url in the text
|
||||
*/
|
||||
highlightSearchWords : function() {
|
||||
var params = $.getQueryParameters();
|
||||
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
|
||||
if (terms.length) {
|
||||
var body = $('div.body');
|
||||
if (!body.length) {
|
||||
body = $('body');
|
||||
}
|
||||
window.setTimeout(function() {
|
||||
$.each(terms, function() {
|
||||
body.highlightText(this.toLowerCase(), 'highlighted');
|
||||
});
|
||||
}, 10);
|
||||
$('<p class="highlight-link"><a href="javascript:Documentation.' +
|
||||
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
|
||||
.appendTo($('#searchbox'));
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* init the domain index toggle buttons
|
||||
*/
|
||||
initIndexTable : function() {
|
||||
var togglers = $('img.toggler').click(function() {
|
||||
var src = $(this).attr('src');
|
||||
var idnum = $(this).attr('id').substr(7);
|
||||
$('tr.cg-' + idnum).toggle();
|
||||
if (src.substr(-9) === 'minus.png')
|
||||
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
|
||||
else
|
||||
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
|
||||
}).css('display', '');
|
||||
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
|
||||
togglers.click();
|
||||
}
|
||||
},
|
||||
|
||||
/**
|
||||
* helper function to hide the search marks again
|
||||
*/
|
||||
hideSearchWords : function() {
|
||||
$('#searchbox .highlight-link').fadeOut(300);
|
||||
$('span.highlighted').removeClass('highlighted');
|
||||
},
|
||||
|
||||
/**
|
||||
* make the url absolute
|
||||
*/
|
||||
makeURL : function(relativeURL) {
|
||||
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
|
||||
},
|
||||
|
||||
/**
|
||||
* get the current relative url
|
||||
*/
|
||||
getCurrentURL : function() {
|
||||
var path = document.location.pathname;
|
||||
var parts = path.split(/\//);
|
||||
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
|
||||
if (this === '..')
|
||||
parts.pop();
|
||||
});
|
||||
var url = parts.join('/');
|
||||
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
|
||||
},
|
||||
|
||||
initOnKeyListeners: function() {
|
||||
$(document).keydown(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) {
|
||||
switch (event.keyCode) {
|
||||
case 37: // left
|
||||
var prevHref = $('link[rel="prev"]').prop('href');
|
||||
if (prevHref) {
|
||||
window.location.href = prevHref;
|
||||
return false;
|
||||
}
|
||||
case 39: // right
|
||||
var nextHref = $('link[rel="next"]').prop('href');
|
||||
if (nextHref) {
|
||||
window.location.href = nextHref;
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
});
|
||||
}
|
||||
};
|
||||
|
||||
// quick alias for translations
|
||||
_ = Documentation.gettext;
|
||||
|
||||
$(document).ready(function() {
|
||||
Documentation.init();
|
||||
});
|
||||
11
docs/_build/dirhtml/_static/documentation_options.js
vendored
Normal file
@@ -0,0 +1,11 @@
|
||||
var DOCUMENTATION_OPTIONS = {
|
||||
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
|
||||
VERSION: '',
|
||||
LANGUAGE: 'None',
|
||||
COLLAPSE_INDEX: false,
|
||||
BUILDER: 'dirhtml',
|
||||
FILE_SUFFIX: '.html',
|
||||
HAS_SOURCE: true,
|
||||
SOURCELINK_SUFFIX: '.txt',
|
||||
NAVIGATION_WITH_KEYS: false
|
||||
};
|
||||
BIN
docs/_build/dirhtml/_static/favicon.ico
vendored
Normal file
|
After Width: | Height: | Size: 16 KiB |
BIN
docs/_build/dirhtml/_static/file.png
vendored
Normal file
|
After Width: | Height: | Size: 286 B |
BIN
docs/_build/dirhtml/_static/images/about_screen.png
vendored
Normal file
|
After Width: | Height: | Size: 247 KiB |
BIN
docs/_build/dirhtml/_static/images/backup_warning.png
vendored
Normal file
|
After Width: | Height: | Size: 494 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_backup_view_no_storage.png
vendored
Normal file
|
After Width: | Height: | Size: 514 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_backup_view_storage.png
vendored
Normal file
|
After Width: | Height: | Size: 504 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_creating_backup.png
vendored
Normal file
|
After Width: | Height: | Size: 500 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_instructions.png
vendored
Normal file
|
After Width: | Height: | Size: 346 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_instructions_view.png
vendored
Normal file
|
After Width: | Height: | Size: 591 KiB |
BIN
docs/_build/dirhtml/_static/images/bitcoin_view.png
vendored
Normal file
|
After Width: | Height: | Size: 295 KiB |
BIN
docs/_build/dirhtml/_static/images/decrypt_backup.png
vendored
Normal file
|
After Width: | Height: | Size: 478 KiB |
BIN
docs/_build/dirhtml/_static/images/diy/balena.png
vendored
Normal file
|
After Width: | Height: | Size: 41 KiB |
BIN
docs/_build/dirhtml/_static/images/diy/pi.png
vendored
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/_build/dirhtml/_static/images/diy/pins.png
vendored
Normal file
|
After Width: | Height: | Size: 273 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_auto_check_updates.png
vendored
Normal file
|
After Width: | Height: | Size: 323 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_config.png
vendored
Normal file
|
After Width: | Height: | Size: 294 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_lan_setup.png
vendored
Normal file
|
After Width: | Height: | Size: 288 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_metrics.png
vendored
Normal file
|
After Width: | Height: | Size: 384 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_notification.png
vendored
Normal file
|
After Width: | Height: | Size: 351 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_notifications.png
vendored
Normal file
|
After Width: | Height: | Size: 478 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_tab.png
vendored
Normal file
|
After Width: | Height: | Size: 317 KiB |
BIN
docs/_build/dirhtml/_static/images/embassy_wifi.png
vendored
Normal file
|
After Width: | Height: | Size: 304 KiB |
BIN
docs/_build/dirhtml/_static/images/private_dns.png
vendored
Normal file
|
After Width: | Height: | Size: 32 KiB |
BIN
docs/_build/dirhtml/_static/images/restore_backup_menu.png
vendored
Normal file
|
After Width: | Height: | Size: 499 KiB |
BIN
docs/_build/dirhtml/_static/images/restore_backup_submenu.png
vendored
Normal file
|
After Width: | Height: | Size: 504 KiB |
BIN
docs/_build/dirhtml/_static/images/restoring_backup.png
vendored
Normal file
|
After Width: | Height: | Size: 502 KiB |
BIN
docs/_build/dirhtml/_static/images/secure_lan_setup_page.png
vendored
Normal file
|
After Width: | Height: | Size: 336 KiB |
BIN
docs/_build/dirhtml/_static/images/secure_lan_setup_prompt.png
vendored
Normal file
|
After Width: | Height: | Size: 492 KiB |
BIN
docs/_build/dirhtml/_static/images/service/bitcoin_config.png
vendored
Normal file
|
After Width: | Height: | Size: 272 KiB |
BIN
docs/_build/dirhtml/_static/images/service/bitcoin_instructions.png
vendored
Normal file
|
After Width: | Height: | Size: 534 KiB |
BIN
docs/_build/dirhtml/_static/images/service/bitcoin_rpc.png
vendored
Normal file
|
After Width: | Height: | Size: 256 KiB |
BIN
docs/_build/dirhtml/_static/images/service/boolean_toggle.png
vendored
Normal file
|
After Width: | Height: | Size: 255 KiB |
BIN
docs/_build/dirhtml/_static/images/service/btcproxy_config.png
vendored
Normal file
|
After Width: | Height: | Size: 268 KiB |
BIN
docs/_build/dirhtml/_static/images/service/btcproxy_rpc.png
vendored
Normal file
|
After Width: | Height: | Size: 266 KiB |
BIN
docs/_build/dirhtml/_static/images/service/service_properties.png
vendored
Normal file
|
After Width: | Height: | Size: 389 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/browser/brave_security_settings.png
vendored
Normal file
|
After Width: | Height: | Size: 180 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/browser/brave_view_certs.png
vendored
Normal file
|
After Width: | Height: | Size: 176 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/browser/firefox_security_settings.png
vendored
Normal file
|
After Width: | Height: | Size: 150 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/browser/firefox_view_certs.png
vendored
Normal file
|
After Width: | Height: | Size: 185 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/macos/always_trust.png
vendored
Normal file
|
After Width: | Height: | Size: 988 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/macos/certificate_trusted.png
vendored
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/_build/dirhtml/_static/images/ssl/macos/certificate_untrusted.png
vendored
Normal file
|
After Width: | Height: | Size: 1.1 MiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_certificate_install_page.PNG
vendored
Normal file
|
After Width: | Height: | Size: 488 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_ipad_cert_trust.PNG
vendored
Normal file
|
After Width: | Height: | Size: 472 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_ipad_cert_trust_settings.PNG
vendored
Normal file
|
After Width: | Height: | Size: 557 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_ipad_general_settings.PNG
vendored
Normal file
|
After Width: | Height: | Size: 532 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_ipad_install_profile.PNG
vendored
Normal file
|
After Width: | Height: | Size: 481 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_ipad_profiles.PNG
vendored
Normal file
|
After Width: | Height: | Size: 464 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_setup_app_advanced.PNG
vendored
Normal file
|
After Width: | Height: | Size: 124 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/mobile/ssl_setup_app_complete.PNG
vendored
Normal file
|
After Width: | Height: | Size: 75 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/1_windows_mmc.png
vendored
Normal file
|
After Width: | Height: | Size: 319 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/2_windows_console_root.png
vendored
Normal file
|
After Width: | Height: | Size: 46 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/3_windows_add_certificates.png
vendored
Normal file
|
After Width: | Height: | Size: 76 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/4_windows_selected_snapin.png
vendored
Normal file
|
After Width: | Height: | Size: 78 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/5_windows_trusted_certificate_menu.png
vendored
Normal file
|
After Width: | Height: | Size: 126 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/6_windows_import_cert.png
vendored
Normal file
|
After Width: | Height: | Size: 130 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/7_windows_import_cert_wizard.png
vendored
Normal file
|
After Width: | Height: | Size: 131 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/8_windows_successful_cert_install.png
vendored
Normal file
|
After Width: | Height: | Size: 132 KiB |
BIN
docs/_build/dirhtml/_static/images/ssl/windows/windows_download_cert.png
vendored
Normal file
|
After Width: | Height: | Size: 106 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/about_config.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/autoconfig_url.png
vendored
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_options_windows.png
vendored
Normal file
|
After Width: | Height: | Size: 62 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_preferences.png
vendored
Normal file
|
After Width: | Height: | Size: 68 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_proxy.png
vendored
Normal file
|
After Width: | Height: | Size: 111 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_search.png
vendored
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_whitelist.png
vendored
Normal file
|
After Width: | Height: | Size: 92 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/firefox_whitelist_mobile.png
vendored
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/install_homebrew.png
vendored
Normal file
|
After Width: | Height: | Size: 411 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/install_homebrew1.png
vendored
Normal file
|
After Width: | Height: | Size: 567 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/install_tor.png
vendored
Normal file
|
After Width: | Height: | Size: 27 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/network_proxy_type.png
vendored
Normal file
|
After Width: | Height: | Size: 23 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_apps.png
vendored
Normal file
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_menu.png
vendored
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_settings.png
vendored
Normal file
|
After Width: | Height: | Size: 63 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_start.png
vendored
Normal file
|
After Width: | Height: | Size: 24 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_started.png
vendored
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/orbot_vpn.png
vendored
Normal file
|
After Width: | Height: | Size: 239 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/private_dns_off.png
vendored
Normal file
|
After Width: | Height: | Size: 135 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/socks_remote_dns.png
vendored
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/tor_download_windows.png
vendored
Normal file
|
After Width: | Height: | Size: 81 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/tor_windows_install.png
vendored
Normal file
|
After Width: | Height: | Size: 34 KiB |
BIN
docs/_build/dirhtml/_static/images/tor/tor_windows_terminal.png
vendored
Normal file
|
After Width: | Height: | Size: 59 KiB |
10
docs/_build/dirhtml/_static/img/banner-background.svg
vendored
Normal file
@@ -0,0 +1,10 @@
|
||||
<svg width="1440" height="70" viewBox="0 0 1440 70" fill="none" xmlns="http://www.w3.org/2000/svg">
|
||||
<mask id="mask0" mask-type="alpha" maskUnits="userSpaceOnUse" x="0" y="0" width="1440" height="70">
|
||||
<rect width="1440" height="70" fill="#4458A3"/>
|
||||
</mask>
|
||||
<g mask="url(#mask0)">
|
||||
<rect x="-193" y="201.884" width="389" height="411" transform="rotate(-60 -193 201.884)" fill="#5064AE"/>
|
||||
<rect width="240.234" height="657.957" transform="matrix(-0.5 -0.866025 -0.866025 0.5 1092.92 -38.0088)" fill="#5064AE"/>
|
||||
<rect x="1038" y="-38.0088" width="240.234" height="657.957" transform="rotate(-60 1038 -38.0088)" fill="#5064AE"/>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 635 B |
BIN
docs/_build/dirhtml/_static/img/favicon-228x228.png
vendored
Normal file
|
After Width: | Height: | Size: 12 KiB |
BIN
docs/_build/dirhtml/_static/img/favicon-32x32.png
vendored
Normal file
|
After Width: | Height: | Size: 1.5 KiB |
BIN
docs/_build/dirhtml/_static/img/favicon.ico
vendored
Normal file
|
After Width: | Height: | Size: 43 KiB |
BIN
docs/_build/dirhtml/_static/img/icon-transparent.png
vendored
Normal file
|
After Width: | Height: | Size: 46 KiB |
1
docs/_build/dirhtml/_static/img/icons/bitcoin.svg
vendored
Normal file
|
After Width: | Height: | Size: 38 KiB |
BIN
docs/_build/dirhtml/_static/img/icons/credit-card.png
vendored
Normal file
|
After Width: | Height: | Size: 11 KiB |
BIN
docs/_build/dirhtml/_static/img/icons/desktop-monitor-download.png
vendored
Normal file
|
After Width: | Height: | Size: 25 KiB |