new theme

docs/build/html/.buildinfo

@@ -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: 7547d0bacfdb341044829c0abf46a2ac
+config: 61c5bd79883e2b35dfb5ace78d9930b1
 tags: 645f666f9bcd5a90fca523b33c5a78b7

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

@@ -20,4 +20,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search
+* :ref:`search`

docs/build/html/_static/basic.css

@@ -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.
  *
  */
@@ -15,12 +15,6 @@ div.clearer {
     clear: both;
 }
 
-div.section::after {
-    display: block;
-    content: '';
-    clear: left;
-}
-
 /* -- relbar ---------------------------------------------------------------- */
 
 div.related {
@@ -237,16 +231,6 @@ 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,
@@ -295,12 +279,6 @@ img.align-center, .figure.align-center, object.align-center {
   margin-right: auto;
 }
 
-img.align-default, .figure.align-default {
-  display: block;
-  margin-left: auto;
-  margin-right: auto;
-}
-
 .align-left {
     text-align: left;
 }
@@ -309,10 +287,6 @@ img.align-default, .figure.align-default {
     text-align: center;
 }
 
-.align-default {
-    text-align: center;
-}
-
 .align-right {
     text-align: right;
 }
@@ -322,27 +296,21 @@ img.align-default, .figure.align-default {
 div.sidebar {
     margin: 0 0 0.5em 1em;
     border: 1px solid #ddb;
-    padding: 7px;
+    padding: 7px 7px 0 7px;
     background-color: #ffe;
     width: 40%;
     float: right;
-    clear: right;
-    overflow-x: auto;
 }
 
 p.sidebar-title {
     font-weight: bold;
 }
 
-div.admonition, div.topic, blockquote {
-    clear: left;
-}
-
 /* -- topics ---------------------------------------------------------------- */
 
 div.topic {
     border: 1px solid #ccc;
-    padding: 7px;
+    padding: 7px 7px 0 7px;
     margin: 10px 0 10px 0;
 }
 
@@ -364,6 +332,10 @@ div.admonition dt {
     font-weight: bold;
 }
 
+div.admonition dl {
+    margin-bottom: 0;
+}
+
 p.admonition-title {
     margin: 0px 10px 5px 0px;
     font-weight: bold;
@@ -374,28 +346,9 @@ div.body p.centered {
     margin-top: 25px;
 }
 
-/* -- content of sidebars/topics/admonitions -------------------------------- */
-
-div.sidebar > :last-child,
-div.topic > :last-child,
-div.admonition > :last-child {
-    margin-bottom: 0;
-}
-
-div.sidebar::after,
-div.topic::after,
-div.admonition::after,
-blockquote::after {
-    display: block;
-    content: '';
-    clear: both;
-}
-
 /* -- tables ---------------------------------------------------------------- */
 
 table.docutils {
-    margin-top: 10px;
-    margin-bottom: 10px;
     border: 0;
     border-collapse: collapse;
 }
@@ -405,11 +358,6 @@ table.align-center {
     margin-right: auto;
 }
 
-table.align-default {
-    margin-left: auto;
-    margin-right: auto;
-}
-
 table caption span.caption-number {
     font-style: italic;
 }
@@ -443,16 +391,6 @@ table.citation td {
     border-bottom: none;
 }
 
-th > :first-child,
-td > :first-child {
-    margin-top: 0px;
-}
-
-th > :last-child,
-td > :last-child {
-    margin-bottom: 0px;
-}
-
 /* -- figures --------------------------------------------------------------- */
 
 div.figure {
@@ -495,10 +433,6 @@ table.field-list td, table.field-list th {
 
 /* -- hlist styles ---------------------------------------------------------- */
 
-table.hlist {
-    margin: 1em 0;
-}
-
 table.hlist td {
     vertical-align: top;
 }
@@ -526,78 +460,11 @@ ol.upperroman {
     list-style: upper-roman;
 }
 
-:not(li) > ol > li:first-child > :first-child,
-:not(li) > ul > li:first-child > :first-child {
-    margin-top: 0px;
-}
-
-:not(li) > ol > li:last-child > :last-child,
-:not(li) > ul > li:last-child > :last-child {
-    margin-bottom: 0px;
-}
-
-ol.simple ol p,
-ol.simple ul p,
-ul.simple ol p,
-ul.simple ul p {
-    margin-top: 0;
-}
-
-ol.simple > li:not(:first-child) > p,
-ul.simple > li:not(:first-child) > p {
-    margin-top: 0;
-}
-
-ol.simple p,
-ul.simple p {
-    margin-bottom: 0;
-}
-
-dl.footnote > dt,
-dl.citation > dt {
-    float: left;
-    margin-right: 0.5em;
-}
-
-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 > :first-child {
+dd p {
     margin-top: 0px;
 }
 
@@ -611,11 +478,6 @@ dd {
     margin-left: 30px;
 }
 
-dl > dd:last-child,
-dl > dd:last-child > :last-child {
-    margin-bottom: 0;
-}
-
 dt:target, span.highlighted {
     background-color: #fbe54e;
 }
@@ -675,12 +537,6 @@ dl.glossary dt {
     font-style: oblique;
 }
 
-.classifier:before {
-    font-style: normal;
-    margin: 0.5em;
-    content: ":";
-}
-
 abbr, acronym {
     border-bottom: dotted 1px;
     cursor: help;
@@ -693,10 +549,6 @@ pre {
     overflow-y: hidden;  /* fixes display issues on Chrome browsers */
 }
 
-pre, div[class*="highlight-"] {
-    clear: both;
-}
-
 span.pre {
     -moz-hyphens: none;
     -ms-hyphens: none;
@@ -704,57 +556,22 @@ span.pre {
     hyphens: none;
 }
 
-div[class*="highlight-"] {
-    margin: 1em 0;
-}
-
 td.linenos pre {
+    padding: 5px 0px;
     border: 0;
     background-color: transparent;
     color: #aaa;
 }
 
 table.highlighttable {
-    display: block;
+    margin-left: 0.5em;
-}
-
-table.highlighttable tbody {
-    display: block;
-}
-
-table.highlighttable tr {
-    display: flex;
 }
 
 table.highlighttable td {
-    margin: 0;
+    padding: 0 0.5em 0 0.5em;
-    padding: 0;
-}
-
-table.highlighttable td.linenos {
-    padding-right: 0.5em;
-}
-
-table.highlighttable td.code {
-    flex: 1;
-    overflow: hidden;
-}
-
-.highlight .hll {
-    display: block;
-}
-
-div.highlight pre,
-table.highlighttable pre {
-    margin: 0;
-}
-
-div.code-block-caption + div {
-    margin-top: 0;
 }
 
 div.code-block-caption {
-    margin-top: 1em;
     padding: 2px 5px;
     font-size: small;
 }
@@ -763,9 +580,8 @@ div.code-block-caption code {
     background-color: transparent;
 }
 
-table.highlighttable td.linenos,
+div.code-block-caption + div > div.highlight > pre {
-div.doctest > div.highlight span.gp {  /* gp: Generic.Prompt */
+    margin-top: 0;
-    user-select: none;
 }
 
 div.code-block-caption span.caption-number {
@@ -777,7 +593,11 @@ div.code-block-caption span.caption-text {
 }
 
 div.literal-block-wrapper {
-    margin: 1em 0;
+    padding: 1em 1em 0;
+}
+
+div.literal-block-wrapper div.highlight {
+    margin: 0;
 }
 
 code.descname {
@@ -828,7 +648,8 @@ span.eqno {
 }
 
 span.eqno a.headerlink {
-    position: absolute;
+    position: relative;
+    left: 0px;
     z-index: 1;
 }
 

docs/build/html/_static/css/insegel.css

@@ -0,0 +1,664 @@
+@import url("https://fonts.googleapis.com/css?family=IBM+Plex+Sans:300,400,500");
+@import url("https://fonts.googleapis.com/css?family=Inconsolata");
+/* http://meyerweb.com/eric/tools/css/reset/ 
+   v2.0 | 20110126
+   License: none (public domain)
+*/
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+  margin: 0;
+  padding: 0;
+  border: 0;
+  font-size: 100%;
+  font: inherit;
+  vertical-align: baseline;
+}
+
+/* HTML5 display-role reset for older browsers */
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+  display: block;
+}
+
+body {
+  line-height: 1;
+}
+
+ol, ul {
+  list-style: none;
+}
+
+blockquote, q {
+  quotes: none;
+}
+
+blockquote:before, blockquote:after,
+q:before, q:after {
+  content: '';
+  content: none;
+}
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+body {
+  background: #F2F2F2;
+  font-family: "IBM Plex Sans", serif;
+  line-height: 1.5;
+  font-size: 18px;
+}
+@media screen and (max-width: 880px) {
+  body {
+    background: #F2F2F2;
+  }
+}
+
+h1, h2, h3, h4, h5 {
+  font-weight: 300;
+  margin-bottom: 1em;
+  margin-top: 1em;
+}
+
+h1 {
+  font-size: 2em;
+}
+
+h2 {
+  font-size: 1.5em;
+}
+
+h3 {
+  font-size: 1.35em;
+}
+
+a {
+  text-decoration: none;
+  color: inherit;
+  font-weight: 500;
+  border-bottom: 2px solid transparent;
+  transition: border-bottom 0.25s;
+}
+a.headerlink {
+  border-bottom: 0;
+}
+
+a:hover:not(.headerlink) {
+  border-bottom: 2px solid #2D2D2D;
+}
+
+p {
+  margin-bottom: 1em;
+}
+
+em {
+  font-style: italic;
+}
+
+strong {
+  font-weight: bold;
+}
+
+li {
+  display: list-item;
+}
+
+ol {
+  display: block;
+  list-style-type: decimal;
+  padding-left: 40px;
+}
+
+ul {
+  display: block;
+  list-style-type: disc;
+  padding-left: 25px;
+}
+
+ul ul {
+  list-style-type: circle;
+}
+
+pre {
+  font-family: "Inconsolata", monospace;
+  background-color: #DADADA;
+  color: #2D2D2D;
+  padding: 2em;
+  margin-bottom: 1em;
+}
+
+img {
+  max-width: 100%;
+}
+
+table {
+  margin: 0 0 1.5em;
+  width: 100%;
+  max-width: 100%;
+}
+
+table thead th {
+  font-weight: bold;
+  text-align: left;
+}
+
+table th, table td {
+  padding: 0.5em;
+}
+
+table tbody tr:nth-of-type(odd) {
+  background-color: #DADADA;
+  color: #2D2D2D;
+}
+
+pre code {
+  white-space: nowrap;
+  overflow-x: auto;
+}
+
+code {
+  max-width: 100%;
+  padding: 2px;
+  font-family: "Inconsolata", monospace;
+  background-color: #DADADA;
+  color: #2D2D2D;
+}
+
+table tbody tr:nth-of-type(odd) code {
+  background-color: #F2F2F2;
+  color: #2D2D2D;
+}
+
+#insegel-container {
+  padding-left: 1em;
+  padding-right: 1em;
+  max-width: 1300px;
+  margin-left: auto;
+  margin-right: auto;
+}
+@media screen and (max-width: 880px) {
+  #insegel-container {
+    padding: 0;
+  }
+}
+
+#content-container {
+  display: flex;
+  width: 100%;
+  flex-direction: row-reverse;
+}
+@media screen and (max-width: 880px) {
+  #content-container {
+    display: block;
+  }
+}
+
+#main-content-container {
+  flex: 1;
+}
+
+#main-content-container, #side-menu-container {
+  background-color: #F2F2F2;
+}
+
+#main-content {
+  padding: 2em;
+}
+#main-content .figure {
+  text-align: center;
+}
+#main-content h1:first-child {
+  display: none;
+}
+
+#main-content-header {
+  padding: 2em 2em 0 2em;
+}
+#main-content-header h1 {
+  margin: 0;
+}
+
+#side-menu-container {
+  width: 300px;
+  margin-right: 2em;
+  position: relative;
+}
+#side-menu-container #side-menu {
+  padding: 2em;
+  margin-bottom: 5em;
+}
+#side-menu-container #rtd-credit {
+  padding: 2em;
+  position: absolute;
+  bottom: 0;
+}
+@media screen and (max-width: 1000px) {
+  #side-menu-container {
+    width: 250px;
+  }
+}
+@media screen and (max-width: 880px) {
+  #side-menu-container {
+    margin-right: 0;
+    width: 100%;
+    display: none;
+  }
+  #side-menu-container #side-menu {
+    margin-bottom: 0;
+  }
+  #side-menu-container #rtd-credit {
+    position: relative;
+  }
+}
+
+a.headerlink {
+  display: none;
+  visibility: hidden;
+}
+a.headerlink:after {
+  visibility: visible;
+  font: normal normal normal 14px/1 FontAwesome;
+  font-size: inherit;
+  text-rendering: auto;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  content: "\f0c1";
+  display: inline-block;
+  opacity: 0.6;
+}
+
+h1:hover .headerlink, h2:hover .headerlink, h3:hover .headerlink, h4:hover .headerlink, h5:hover .headerlink, h6:hover .headerlink, dl dt:hover .headerlink, p.caption:hover .headerlink {
+  display: inline-block;
+}
+
+#side-menu .local-toc ul {
+  text-transform: uppercase;
+  font-weight: 300;
+  padding-left: 0px;
+  list-style-type: none;
+}
+#side-menu .local-toc ul ul {
+  margin-top: 1em;
+  text-transform: none;
+  font-family: "IBM Plex Sans", serif;
+}
+#side-menu .local-toc ul ul a {
+  font-weight: 400;
+}
+
+#side-menu .caption {
+  opacity: 0.5;
+  font-weight: 300;
+  list-style-type: none;
+  margin-bottom: 0px;
+}
+#side-menu ul {
+  margin-bottom: 1em;
+  text-transform: none;
+  list-style-type: none;
+  padding-left: 0px;
+}
+
+#search {
+  padding: 2em;
+}
+#search input[type=text] {
+  width: 100%;
+  font-weight: 300;
+  font-size: 2em;
+  box-sizing: border-box;
+  border: none;
+  background-color: #F2F2F2;
+  color: #2D2D2D;
+  font-family: "IBM Plex Sans", serif;
+}
+#search input[type=text]::placeholder {
+  color: #a5a5a5;
+  font-weight: 300;
+}
+
+.admonition {
+  padding: 2em;
+  margin-bottom: 2em;
+  background-color: #2D2D2D;
+  color: #EBEBEB;
+}
+.admonition .admonition-title {
+  font-weight: 500;
+}
+.admonition.warning, .admonition.caution, .admonition.danger, .admonition.error {
+  background-color: #CD4949;
+  color: #2D2D2D;
+}
+.admonition.attention, .admonition.important {
+  background-color: #49CDAC;
+  color: #2D2D2D;
+}
+
+.injected {
+  display: none;
+}
+
+.toctree-wrapper {
+  margin-bottom: 1em;
+}
+.toctree-wrapper .caption-text {
+  font-weight: 300;
+  opacity: 0.5;
+}
+
+.figure {
+  margin-bottom: 1em;
+}
+
+header {
+  padding-top: 2em;
+  display: flex;
+}
+header #logo-container {
+  width: 300px;
+  padding-left: 2em;
+  display: flex;
+  align-items: center;
+}
+@media screen and (max-width: 1000px) {
+  header #logo-container {
+    width: 250px;
+  }
+}
+@media screen and (max-width: 880px) {
+  header #logo-container {
+    width: 100%;
+    padding: 0;
+    display: block;
+  }
+}
+header #logo-container img {
+  height: 60px;
+}
+header #project-container {
+  padding: 0em 2em;
+}
+@media screen and (max-width: 880px) {
+  header {
+    text-align: center;
+    display: block;
+  }
+}
+
+footer {
+  display: flex;
+  justify-content: space-between;
+  margin: 2em;
+}
+footer #footer-info {
+  display: flex;
+  justify-content: space-between;
+  width: 100%;
+}
+footer a#menu-toggle {
+  display: none;
+  opacity: 1;
+  font-size: 32px;
+  cursor: pointer;
+}
+footer a#menu-toggle.toggled {
+  color: #DADADA;
+}
+footer ul#build-details {
+  list-style: none;
+  display: flex;
+  margin: 0;
+  padding: 0;
+}
+footer ul#build-details li {
+  margin-right: 0.25em;
+}
+footer ul#build-details li:not(:last-child):after {
+  content: " // ";
+  margin-left: 0;
+}
+@media screen and (max-width: 880px) {
+  footer {
+    align-items: center;
+  }
+  footer #footer-info {
+    display: block;
+  }
+  footer a#menu-toggle {
+    display: block;
+  }
+}
+
+#search-results ul.search {
+  padding-left: 0px;
+  list-style-type: none;
+}
+#search-results ul.search li {
+  margin-bottom: 2em;
+}
+#search-results ul.search .context {
+  margin-top: 1em;
+  white-space: pre-line;
+  background-color: #DADADA;
+  color: #2D2D2D;
+  padding: 2em;
+}
+#search-results ul.search .context .highlighted {
+  font-weight: 800;
+}
+
+dl:not(.docutils) dd {
+  margin-left: 2em;
+}
+dl:not(.docutils) dd dl {
+  margin-bottom: 1em;
+}
+dl:not(.docutils) dt {
+  background: #2D2D2D;
+  color: #EBEBEB;
+  padding: 0.5em;
+  padding-right: 0.75em;
+  margin-bottom: 1em;
+  display: inline-block;
+}
+dl:not(.docutils) dt .property {
+  margin-right: 0.5em;
+}
+dl:not(.docutils) dt code {
+  background: #2D2D2D;
+  color: #EBEBEB;
+  font-weight: bold;
+  padding: 0px;
+}
+dl:not(.docutils) dl dt {
+  background: #DADADA;
+  color: #2D2D2D;
+  border-left: 0.25em solid #2D2D2D;
+}
+dl:not(.docutils) dl dt code {
+  background: #DADADA;
+  color: #2D2D2D;
+}
+
+.c {
+  font-style: italic;
+}
+
+/* Comment */
+.err {
+  border: 1px solid #FF0000;
+}
+
+/* Error */
+.k {
+  font-weight: bold;
+}
+
+/* Keyword */
+.cm {
+  font-style: italic;
+}
+
+/* Comment.Multiline */
+.c1 {
+  font-style: italic;
+}
+
+/* Comment.Single */
+.cs {
+  font-style: italic;
+}
+
+/* Comment.Special */
+.ge {
+  font-style: italic;
+}
+
+/* Generic.Emph */
+.gh {
+  font-weight: bold;
+}
+
+/* Generic.Heading */
+.gp {
+  font-weight: bold;
+}
+
+/* Generic.Prompt */
+.gs {
+  font-weight: bold;
+}
+
+/* Generic.Strong */
+.gu {
+  font-weight: bold;
+}
+
+/* Generic.Subheading */
+.kc {
+  font-weight: bold;
+}
+
+/* Keyword.Constant */
+.kd {
+  font-weight: bold;
+}
+
+/* Keyword.Declaration */
+.kn {
+  font-weight: bold;
+}
+
+/* Keyword.Namespace */
+.kr {
+  font-weight: bold;
+}
+
+/* Keyword.Reserved */
+.s {
+  font-style: italic;
+}
+
+/* Literal.String */
+.nc {
+  font-weight: bold;
+}
+
+/* Name.Class */
+.ni {
+  font-weight: bold;
+}
+
+/* Name.Entity */
+.ne {
+  font-weight: bold;
+}
+
+/* Name.Exception */
+.nn {
+  font-weight: bold;
+}
+
+/* Name.Namespace */
+.nt {
+  font-weight: bold;
+}
+
+/* Name.Tag */
+.ow {
+  font-weight: bold;
+}
+
+/* Operator.Word */
+.sb {
+  font-style: italic;
+}
+
+/* Literal.String.Backtick */
+.sc {
+  font-style: italic;
+}
+
+/* Literal.String.Char */
+.sd {
+  font-style: italic;
+}
+
+/* Literal.String.Doc */
+.s2 {
+  font-style: italic;
+}
+
+/* Literal.String.Double */
+.se {
+  font-weight: bold;
+  font-style: italic;
+}
+
+/* Literal.String.Escape */
+.sh {
+  font-style: italic;
+}
+
+/* Literal.String.Heredoc */
+.si {
+  font-weight: bold;
+  font-style: italic;
+}
+
+/* Literal.String.Interpol */
+.sx {
+  font-style: italic;
+}
+
+/* Literal.String.Other */
+.sr {
+  font-style: italic;
+}
+
+/* Literal.String.Regex */
+.s1 {
+  font-style: italic;
+}
+
+/* Literal.String.Single */
+.ss {
+  font-style: italic;
+}
+
+/* Literal.String.Symbol */
+
+/*# sourceMappingURL=insegel.css.map */

docs/build/html/_static/doctools.js

@@ -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.
  *
  */
@@ -87,13 +87,14 @@ jQuery.fn.highlightText = function(text, className) {
           node.nextSibling));
         node.nodeValue = val.substr(0, pos);
         if (isInSVG) {
+          var bbox = span.getBBox();
           var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
-          var bbox = node.parentElement.getBBox();
+       	  rect.x.baseVal.value = bbox.x;
-          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);
+          var parentOfText = node.parentNode.parentNode;
           addItems.push({
               "parent": node.parentNode,
               "target": rect});
@@ -283,11 +284,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'
+      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');

docs/build/html/_static/documentation_options.js

@@ -3,10 +3,8 @@ var DOCUMENTATION_OPTIONS = {
     VERSION: '',
     LANGUAGE: 'None',
     COLLAPSE_INDEX: false,
-    BUILDER: 'html',
     FILE_SUFFIX: '.html',
-    LINK_SUFFIX: '.html',
     HAS_SOURCE: true,
     SOURCELINK_SUFFIX: '.txt',
-    NAVIGATION_WITH_KEYS: false
+    NAVIGATION_WITH_KEYS: false,
 };

docs/build/html/_static/language_data.js

@@ -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.
  *
  */

docs/build/html/_static/print.css

@@ -0,0 +1,7 @@
+@media print {
+    div.header, div.relnav, #toc { display: none; }
+    #contentwrapper { padding: 0; margin: 0; border: none; }
+    body { color: black; background-color: white; }
+    div.footer { border-top: 1px solid #888; color: #888; margin-top: 1cm; }
+    div.footer a { text-decoration: none; }
+}

docs/build/html/_static/pygments.css

@@ -4,79 +4,71 @@ span.linenos { color: #000000; background-color: #f0f0f0; padding: 0 5px 0 5px;
 td.linenos pre.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
 span.linenos.special { color: #000000; background-color: #ffffc0; padding: 0 5px 0 5px; }
 .highlight .hll { background-color: #ffffcc }
-.highlight { background: #f8f8f8; }
+.highlight { background: #f0f0f0; }
-.highlight .c { color: #8f5902; font-style: italic } /* Comment */
+.highlight .c { color: #60a0b0; font-style: italic } /* Comment */
-.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
+.highlight .err { border: 1px solid #FF0000 } /* Error */
-.highlight .g { color: #000000 } /* Generic */
+.highlight .k { color: #007020; font-weight: bold } /* Keyword */
-.highlight .k { color: #004461; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* Operator */
-.highlight .l { color: #000000 } /* Literal */
+.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
-.highlight .n { color: #000000 } /* Name */
+.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
-.highlight .o { color: #582800 } /* Operator */
+.highlight .cp { color: #007020 } /* Comment.Preproc */
-.highlight .x { color: #000000 } /* Other */
+.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
-.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
+.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
-.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
+.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
-.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
+.highlight .gd { color: #A00000 } /* Generic.Deleted */
-.highlight .cp { color: #8f5902 } /* Comment.Preproc */
+.highlight .ge { font-style: italic } /* Generic.Emph */
-.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
+.highlight .gr { color: #FF0000 } /* Generic.Error */
-.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
-.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
-.highlight .gd { color: #a40000 } /* Generic.Deleted */
-.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
-.highlight .gr { color: #ef2929 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #00A000 } /* Generic.Inserted */
 .highlight .go { color: #888888 } /* Generic.Output */
-.highlight .gp { color: #745334 } /* Generic.Prompt */
+.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
-.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
+.highlight .gs { font-weight: bold } /* Generic.Strong */
 .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
-.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
+.highlight .gt { color: #0044DD } /* Generic.Traceback */
-.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
+.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
-.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
+.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
-.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
+.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
-.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
+.highlight .kp { color: #007020 } /* Keyword.Pseudo */
-.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
+.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
-.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
+.highlight .kt { color: #902000 } /* Keyword.Type */
-.highlight .ld { color: #000000 } /* Literal.Date */
+.highlight .m { color: #40a070 } /* Literal.Number */
-.highlight .m { color: #990000 } /* Literal.Number */
+.highlight .s { color: #4070a0 } /* Literal.String */
-.highlight .s { color: #4e9a06 } /* Literal.String */
+.highlight .na { color: #4070a0 } /* Name.Attribute */
-.highlight .na { color: #c4a000 } /* Name.Attribute */
+.highlight .nb { color: #007020 } /* Name.Builtin */
-.highlight .nb { color: #004461 } /* Name.Builtin */
+.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
-.highlight .nc { color: #000000 } /* Name.Class */
+.highlight .no { color: #60add5 } /* Name.Constant */
-.highlight .no { color: #000000 } /* Name.Constant */
+.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
-.highlight .nd { color: #888888 } /* Name.Decorator */
+.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
-.highlight .ni { color: #ce5c00 } /* Name.Entity */
+.highlight .ne { color: #007020 } /* Name.Exception */
-.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #06287e } /* Name.Function */
-.highlight .nf { color: #000000 } /* Name.Function */
+.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
-.highlight .nl { color: #f57900 } /* Name.Label */
+.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
-.highlight .nn { color: #000000 } /* Name.Namespace */
+.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
-.highlight .nx { color: #000000 } /* Name.Other */
+.highlight .nv { color: #bb60d5 } /* Name.Variable */
-.highlight .py { color: #000000 } /* Name.Property */
+.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
-.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
-.highlight .nv { color: #000000 } /* Name.Variable */
+.highlight .mb { color: #40a070 } /* Literal.Number.Bin */
-.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
+.highlight .mf { color: #40a070 } /* Literal.Number.Float */
-.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
+.highlight .mh { color: #40a070 } /* Literal.Number.Hex */
-.highlight .mb { color: #990000 } /* Literal.Number.Bin */
+.highlight .mi { color: #40a070 } /* Literal.Number.Integer */
-.highlight .mf { color: #990000 } /* Literal.Number.Float */
+.highlight .mo { color: #40a070 } /* Literal.Number.Oct */
-.highlight .mh { color: #990000 } /* Literal.Number.Hex */
+.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
-.highlight .mi { color: #990000 } /* Literal.Number.Integer */
+.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
-.highlight .mo { color: #990000 } /* Literal.Number.Oct */
+.highlight .sc { color: #4070a0 } /* Literal.String.Char */
-.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
+.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
-.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
+.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
-.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
+.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
-.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
+.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
-.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
+.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
-.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
+.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
-.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
+.highlight .sx { color: #c65d09 } /* Literal.String.Other */
-.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
+.highlight .sr { color: #235388 } /* Literal.String.Regex */
-.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
+.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
-.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
+.highlight .ss { color: #517918 } /* Literal.String.Symbol */
-.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
+.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
-.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
+.highlight .fm { color: #06287e } /* Name.Function.Magic */
-.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
+.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
-.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
+.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
-.highlight .fm { color: #000000 } /* Name.Function.Magic */
+.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
-.highlight .vc { color: #000000 } /* Name.Variable.Class */
+.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
-.highlight .vg { color: #000000 } /* Name.Variable.Global */
+.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */
-.highlight .vi { color: #000000 } /* Name.Variable.Instance */
-.highlight .vm { color: #000000 } /* Name.Variable.Magic */
-.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */

docs/build/html/_static/scrolls.css

@@ -0,0 +1,496 @@
+/*
+ * scrolls.css_t
+ * ~~~~~~~~~~~~~
+ *
+ * Sphinx stylesheet -- scrolls theme.
+ *
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+body {
+    background-color: #222;
+    margin: 0;
+    padding: 0;
+    font-family: 'Georgia', serif;
+    font-size: 15px;
+    color: #eee;
+}
+
+div.footer {
+    border-top: 1px solid #111;
+    padding: 8px;
+    font-size: 11px;
+    text-align: center;
+    letter-spacing: 0.5px;
+}
+
+div.footer a {
+    color: #eee;
+}
+
+div.header {
+    margin: 0 -15px 0 -15px;
+    background: url(headerbg.png) repeat-x;
+    border-top: 6px solid #1752b4;
+}
+
+div.relnav {
+    border-bottom: 1px solid #111;
+    background: url(navigation.png);
+    margin: 0 -15px 0 -15px;
+    padding: 2px 20px 0 28px;
+    line-height: 25px;
+    color: #aaa;
+    font-size: 12px;
+    text-align: center;
+}
+
+div.relnav a {
+    color: #eee;
+    font-weight: bold;
+    text-decoration: none;
+}
+
+div.relnav a:hover {
+    text-decoration: underline;
+}
+
+#content {
+    background-color: white;
+    color: #111;
+    border-bottom: 1px solid black;
+    background: url(watermark.png) center 0;
+    padding: 0 15px 0 15px;
+    margin: 0;
+}
+
+h1 {
+    margin: 0;
+    padding: 15px 0 0 0;
+}
+
+h1.heading {
+    margin: 0;
+    padding: 0;
+    height: 80px;
+}
+
+h1.heading:hover {
+    background: #222;
+}
+
+h1.heading a {
+    background: url(logo.png) no-repeat center 0;
+    display: block;
+    width: 100%;
+    height: 80px;
+}
+
+h1.heading a:focus {
+    -moz-outline: none;
+    outline: none;
+}
+
+h1.heading span {
+    display: none;
+}
+
+#contentwrapper {
+    min-width: 0;
+    max-width: 680px;
+    padding: 0 18px 20px 18px;
+    margin: 0 auto 0 auto;
+    border-right: 1px solid #eee;
+    border-left: 1px solid #eee;
+    background: url(watermark_blur.png) center -114px;
+}
+
+#contentwrapper h2,
+#contentwrapper h2 a {
+    color: #222;
+    font-size: 24px;
+    margin: 20px 0 0 0;
+}
+
+#contentwrapper h3,
+#contentwrapper h3 a {
+    color: #0d306b;
+    font-size: 20px;
+    margin: 20px 0 0 0;
+}
+
+table.docutils {
+    border-collapse: collapse;
+    border: 2px solid #aaa;
+    margin: 0.5em 1.5em 0.5em 1.5em;
+}
+
+table.docutils td {
+    padding: 2px;
+    border: 1px solid #ddd;
+}
+
+p, li, dd, dt, blockquote {
+    color: #333;
+}
+
+blockquote {
+    margin: 10px 0 10px 20px;
+}
+
+p {
+    line-height: 20px;
+    margin-bottom: 0;
+    margin-top: 10px;
+}
+
+hr {
+    border-top: 1px solid #ccc;
+    border-bottom: 0;
+    border-right: 0;
+    border-left: 0;
+    margin-bottom: 10px;
+    margin-top: 20px;
+}
+
+dl {
+    margin-left: 10px;
+}
+
+li, dt {
+    margin-top: 5px;
+}
+
+dt {
+    font-weight: bold;
+    color: #000;
+}
+
+dd {
+    margin-top: 10px;
+    line-height: 20px;
+}
+
+th {
+    text-align: left;
+    padding: 3px;
+    background-color: #f2f2f2;
+}
+
+a {
+    color: #1752b4;
+}
+
+a:hover {
+    color: #444;
+}
+
+pre {
+    background: #ededed url(metal.png);
+    border-top: 1px solid #ccc;
+    border-bottom: 1px solid #ccc;
+    padding: 5px;
+    font-size: 13px;
+    font-family: 'Bitstream Vera Sans Mono', 'Monaco', monospace;
+}
+
+code {
+    font-size: 13px;
+    font-family: 'Bitstream Vera Sans Mono', 'Monaco', monospace;
+    color: black;
+    padding: 1px 2px 1px 2px;
+    background-color: #fafafa;
+    border-bottom: 1px solid #eee;
+}
+
+div.code-block-caption {
+    color: #efefef;
+    background-color: #888;
+}
+
+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 pre {
+    margin: 0;
+}
+
+a.reference:hover code {
+    border-bottom-color: #aaa;
+}
+
+cite {
+    /* abusing <cite>, it's generated by ReST for `x` */
+    font-size: 13px;
+    font-family: 'Bitstream Vera Sans Mono', 'Monaco', monospace;
+    font-weight: bold;
+    font-style: normal;
+}
+
+div.admonition {
+    margin: 10px 0 10px 0;
+    padding: 10px;
+    border: 1px solid #ccc;
+}
+
+div.admonition p.admonition-title {
+    background-color: #28437f;
+    color: white;
+    margin: -10px -10px 10px -10px;
+    padding: 4px 10px 4px 10px;
+    font-weight: bold;
+    font-size: 15px;
+}
+
+div.admonition p.admonition-title a {
+    color: white!important;
+}
+
+a.headerlink {
+    color: #B4B4B4!important;
+    font-size: 0.8em;
+    padding: 0 4px 0 4px;
+    text-decoration: none!important;
+    visibility: hidden;
+}
+
+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,
+dt:hover > a.headerlink,
+caption:hover > a.headerlink,
+p.caption:hover > a.headerlink,
+div.code-block-caption:hover > a.headerlink {
+    visibility: visible;
+}
+
+a.headerlink:hover {
+    background-color: #B4B4B4;
+    color: #F0F0F0!important;
+}
+
+table caption span.caption-number {
+    font-style: italic;
+}
+
+table caption span.caption-text {
+}
+
+table.indextable {
+    width: 100%;
+}
+
+table.genindextable td {
+    vertical-align: top;
+    width: 50%;
+}
+
+table.indextable ul {
+    margin-top: 0;
+    margin-bottom: 0;
+    list-style-type: none;
+    font-size: 11px;
+}
+
+table.indextable ul a {
+    color: #000;
+}
+
+table.indextable > tbody > tr > td > ul {
+    padding-left: 0em;
+}
+
+div.modindex-jumpbox {
+    border-top: 1px solid #ddd;
+    border-bottom: 1px solid #ddd;
+    margin: 1em 0 1em 0;
+    padding: 0.4em;
+}
+
+table.modindextable {
+    width: 100%;
+    border: none;
+}
+
+table.modindextable td {
+    padding: 2px;
+    border-collapse: collapse;
+}
+
+table.modindextable img.toggler {
+    margin-right: 10px;
+}
+
+dl.function dt,
+dl.class dt,
+dl.exception dt,
+dl.method dt,
+dl.attribute dt {
+    font-weight: normal;
+}
+
+dt .descname {
+    font-weight: bold;
+    margin-right: 4px;
+}
+
+dt .sig-paren {
+    font-size: larger;
+}
+
+dt .descname, dt .descclassname {
+    padding: 0;
+    background: transparent;
+    border-bottom: 1px solid #111;
+}
+
+dt .descclassname {
+    margin-left: 2px;
+}
+
+dl dt big {
+    font-size: 100%;
+}
+
+ul.search {
+    margin: 10px 0 0 30px;
+    padding: 0;
+}
+
+ul.search li {
+    margin: 10px 0 0 0;
+    padding: 0;
+}
+
+ul.search div.context {
+    font-size: 12px;
+    padding: 4px 0 0 20px;
+    color: #888;
+}
+
+span.highlight {
+    background-color: #eee;
+    border: 1px solid #ccc;
+}
+
+#toc {
+    margin: 0 -17px 0 -17px;
+    display: none;
+}
+
+#toc h3 {
+    float: right;
+    margin: 5px 5px 0 0;
+    padding: 0;
+    font-size: 12px;
+    color: #777;
+}
+
+#toc h3:hover {
+    color: #333;
+    cursor: pointer;
+}
+
+.expandedtoc {
+    background: #222 url(darkmetal.png);
+    border-bottom: 1px solid #111;
+    outline-bottom: 1px solid #000;
+    padding: 5px;
+}
+
+.expandedtoc h3 {
+    color: #aaa;
+    margin: 0!important;
+}
+
+.expandedtoc h3:hover {
+    color: white!important;
+}
+
+#tod h3:hover {
+    color: white;
+}
+
+#toc a {
+    color: #ddd;
+    text-decoration: none;
+}
+
+#toc a:hover {
+    color: white;
+    text-decoration: underline;
+}
+
+#toc ul {
+    margin: 5px 0 12px 17px;
+    padding: 0 7px 0 7px;
+}
+
+#toc ul ul {
+    margin-bottom: 0;
+}
+
+#toc ul li {
+    margin: 2px 0 0 0;
+}
+
+.line-block {
+    display: block;
+    margin-top: 1em;
+    margin-bottom: 1em;
+}
+
+.line-block .line-block {
+    margin-top: 0;
+    margin-bottom: 0;
+    margin-left: 1.5em;
+}
+
+.viewcode-link {
+    float: right;
+}
+
+.viewcode-back {
+    float: right;
+    font-family: 'Georgia', serif;
+}
+
+div.viewcode-block:target {
+    background-color: #f4debf;
+    border-top: 1px solid #ac9;
+    border-bottom: 1px solid #ac9;
+    margin: -1px -5px;
+    padding: 0 5px;
+}
+
+div.figure p.caption span.caption-number {
+    font-style: italic;
+}
+
+div.figure p.caption span.caption-text {
+}
+
+/* math display */
+
+div.math p {
+    text-align: center;
+}
+
+span.eqno {
+    float: right;
+}

docs/build/html/_static/searchtools.js

@@ -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.
  *
  */
@@ -36,10 +36,8 @@ if (!Scorer) {
 
     // query found in title
     title: 15,
-    partialTitle: 7,
     // query found in terms
-    term: 5,
+    term: 5
-    partialTerm: 2
   };
 }
 
@@ -58,19 +56,6 @@ var Search = {
   _queued_query : null,
   _pulse_status : -1,
 
-  htmlToText : function(htmlString) {
-      var htmlElement = document.createElement('span');
-      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;
-  },
-
   init : function() {
       var params = $.getQueryParameters();
       if (params.q) {
@@ -135,7 +120,7 @@ var Search = {
     this.out = $('#search-results');
     this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
     this.dots = $('<span></span>').appendTo(this.title);
-    this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
+    this.status = $('<p style="display: none"></p>').appendTo(this.out);
     this.output = $('<ul class="search"/>').appendTo(this.out);
 
     $('#search-progress').text(_('Preparing search...'));
@@ -166,7 +151,8 @@ var Search = {
           objectterms.push(tmp[i].toLowerCase());
       }
 
-      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
+      if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i].match(/^\d+$/) ||
+          tmp[i] === "") {
         // skip this "word"
         continue;
       }
@@ -249,9 +235,7 @@ var Search = {
       if (results.length) {
         var item = results.pop();
         var listItem = $('<li style="display:none"></li>');
-        var requestUrl = "";
+        if (DOCUMENTATION_OPTIONS.FILE_SUFFIX === '') {
-        var linkUrl = "";
-        if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
           // dirhtml builder
           var dirname = item[0] + '/';
           if (dirname.match(/\/index\/$/)) {
@@ -259,17 +243,15 @@ var Search = {
           } else if (dirname == 'index/') {
             dirname = '';
           }
-          requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
+          listItem.append($('<a/>').attr('href',
-          linkUrl = requestUrl;
+            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',
-          linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
+            item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX +
-        }
-        listItem.append($('<a/>').attr('href',
-            linkUrl +
             highlightstring + item[2]).html(item[1]));
+        }
         if (item[3]) {
           listItem.append($('<span> (' + item[3] + ')</span>'));
           Search.output.append(listItem);
@@ -277,7 +259,11 @@ var Search = {
             displayNextItem();
           });
         } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
-          $.ajax({url: requestUrl,
+          var suffix = DOCUMENTATION_OPTIONS.SOURCELINK_SUFFIX;
+          if (suffix === undefined) {
+            suffix = '.txt';
+          }
+          $.ajax({url: DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + item[5] + (item[5].slice(-suffix.length) === suffix ? '' : suffix),
                   dataType: "text",
                   complete: function(jqxhr, textstatus) {
                     var data = jqxhr.responseText;
@@ -327,13 +313,12 @@ var Search = {
     for (var prefix in objects) {
       for (var name in objects[prefix]) {
         var fullname = (prefix ? prefix + '.' : '') + name;
-        var fullnameLower = fullname.toLowerCase()
+        if (fullname.toLowerCase().indexOf(object) > -1) {
-        if (fullnameLower.indexOf(object) > -1) {
           var score = 0;
-          var parts = fullnameLower.split('.');
+          var parts = fullname.split('.');
           // check for different match types: exact matches of full name or
           // "last name" (i.e. last dotted part)
-          if (fullnameLower == object || parts[parts.length - 1] == object) {
+          if (fullname == object || parts[parts.length - 1] == object) {
             score += Scorer.objNameMatch;
           // matches in last name
           } else if (parts[parts.length - 1].indexOf(object) > -1) {
@@ -400,19 +385,6 @@ var Search = {
         {files: terms[word], score: Scorer.term},
         {files: titleterms[word], score: Scorer.title}
       ];
-      // add support for partial matches
-      if (word.length > 2) {
-        for (var w in terms) {
-          if (w.match(word) && !terms[word]) {
-            _o.push({files: terms[w], score: Scorer.partialTerm})
-          }
-        }
-        for (var w in titleterms) {
-          if (w.match(word) && !titleterms[word]) {
-              _o.push({files: titleterms[w], score: Scorer.partialTitle})
-          }
-        }
-      }
 
       // no match but word was a required one
       if ($u.every(_o, function(o){return o.files === undefined;})) {
@@ -432,7 +404,7 @@ 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;
         }
       });
@@ -440,7 +412,7 @@ var Search = {
       // 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];
@@ -452,12 +424,8 @@ var Search = {
       var valid = true;
 
       // check if all requirements are matched
-      var filteredTermCount = // as search terms with length < 3 are discarded: ignore
+      if (fileMap[file].length != searchterms.length)
-        searchterms.filter(function(term){return term.length > 2}).length
+          continue;
-      if (
-        fileMap[file].length != searchterms.length &&
-        fileMap[file].length != filteredTermCount
-      ) continue;
 
       // ensure that none of the excluded terms is in the search result
       for (i = 0; i < excluded.length; i++) {
@@ -488,8 +456,7 @@ var Search = {
    * words. the first one is used to find the occurrence, the
    * latter for highlighting it.
    */
-  makeSearchSummary : function(htmlText, keywords, hlwords) {
+  makeSearchSummary : function(text, keywords, hlwords) {
-    var text = Search.htmlToText(htmlText);
     var textLower = text.toLowerCase();
     var start = 0;
     $.each(keywords, function() {

docs/build/html/_static/theme_extras.js

@@ -0,0 +1,26 @@
+$(function() {
+
+  var
+    toc = $('#toc').show(),
+    items = $('#toc > ul').hide();
+
+  $('#toc h3')
+    .click(function() {
+      if (items.is(':visible')) {
+        items.animate({
+          height:     'hide',
+          opacity:    'hide'
+        }, 300, function() {
+          toc.removeClass('expandedtoc');
+        });
+      }
+      else {
+        items.animate({
+          height:     'show',
+          opacity:    'show'
+        }, 400);
+        toc.addClass('expandedtoc');
+      }
+    });
+
+});

docs/build/html/_static/websupport.js

@@ -0,0 +1,808 @@
+/*
+ * websupport.js
+ * ~~~~~~~~~~~~~
+ *
+ * sphinx.websupport utilities for all documentation.
+ *
+ * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+(function($) {
+  $.fn.autogrow = function() {
+    return this.each(function() {
+    var textarea = this;
+
+    $.fn.autogrow.resize(textarea);
+
+    $(textarea)
+      .focus(function() {
+        textarea.interval = setInterval(function() {
+          $.fn.autogrow.resize(textarea);
+        }, 500);
+      })
+      .blur(function() {
+        clearInterval(textarea.interval);
+      });
+    });
+  };
+
+  $.fn.autogrow.resize = function(textarea) {
+    var lineHeight = parseInt($(textarea).css('line-height'), 10);
+    var lines = textarea.value.split('\n');
+    var columns = textarea.cols;
+    var lineCount = 0;
+    $.each(lines, function() {
+      lineCount += Math.ceil(this.length / columns) || 1;
+    });
+    var height = lineHeight * (lineCount + 1);
+    $(textarea).css('height', height);
+  };
+})(jQuery);
+
+(function($) {
+  var comp, by;
+
+  function init() {
+    initEvents();
+    initComparator();
+  }
+
+  function initEvents() {
+    $(document).on("click", 'a.comment-close', function(event) {
+      event.preventDefault();
+      hide($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.vote', function(event) {
+      event.preventDefault();
+      handleVote($(this));
+    });
+    $(document).on("click", 'a.reply', function(event) {
+      event.preventDefault();
+      openReply($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.close-reply', function(event) {
+      event.preventDefault();
+      closeReply($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.sort-option', function(event) {
+      event.preventDefault();
+      handleReSort($(this));
+    });
+    $(document).on("click", 'a.show-proposal', function(event) {
+      event.preventDefault();
+      showProposal($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.hide-proposal', function(event) {
+      event.preventDefault();
+      hideProposal($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.show-propose-change', function(event) {
+      event.preventDefault();
+      showProposeChange($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.hide-propose-change', function(event) {
+      event.preventDefault();
+      hideProposeChange($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.accept-comment', function(event) {
+      event.preventDefault();
+      acceptComment($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.delete-comment', function(event) {
+      event.preventDefault();
+      deleteComment($(this).attr('id').substring(2));
+    });
+    $(document).on("click", 'a.comment-markup', function(event) {
+      event.preventDefault();
+      toggleCommentMarkupBox($(this).attr('id').substring(2));
+    });
+  }
+
+  /**
+   * Set comp, which is a comparator function used for sorting and
+   * inserting comments into the list.
+   */
+  function setComparator() {
+    // If the first three letters are "asc", sort in ascending order
+    // and remove the prefix.
+    if (by.substring(0,3) == 'asc') {
+      var i = by.substring(3);
+      comp = function(a, b) { return a[i] - b[i]; };
+    } else {
+      // Otherwise sort in descending order.
+      comp = function(a, b) { return b[by] - a[by]; };
+    }
+
+    // Reset link styles and format the selected sort option.
+    $('a.sel').attr('href', '#').removeClass('sel');
+    $('a.by' + by).removeAttr('href').addClass('sel');
+  }
+
+  /**
+   * Create a comp function. If the user has preferences stored in
+   * the sortBy cookie, use those, otherwise use the default.
+   */
+  function initComparator() {
+    by = 'rating'; // Default to sort by rating.
+    // If the sortBy cookie is set, use that instead.
+    if (document.cookie.length > 0) {
+      var start = document.cookie.indexOf('sortBy=');
+      if (start != -1) {
+        start = start + 7;
+        var end = document.cookie.indexOf(";", start);
+        if (end == -1) {
+          end = document.cookie.length;
+          by = unescape(document.cookie.substring(start, end));
+        }
+      }
+    }
+    setComparator();
+  }
+
+  /**
+   * Show a comment div.
+   */
+  function show(id) {
+    $('#ao' + id).hide();
+    $('#ah' + id).show();
+    var context = $.extend({id: id}, opts);
+    var popup = $(renderTemplate(popupTemplate, context)).hide();
+    popup.find('textarea[name="proposal"]').hide();
+    popup.find('a.by' + by).addClass('sel');
+    var form = popup.find('#cf' + id);
+    form.submit(function(event) {
+      event.preventDefault();
+      addComment(form);
+    });
+    $('#s' + id).after(popup);
+    popup.slideDown('fast', function() {
+      getComments(id);
+    });
+  }
+
+  /**
+   * Hide a comment div.
+   */
+  function hide(id) {
+    $('#ah' + id).hide();
+    $('#ao' + id).show();
+    var div = $('#sc' + id);
+    div.slideUp('fast', function() {
+      div.remove();
+    });
+  }
+
+  /**
+   * Perform an ajax request to get comments for a node
+   * and insert the comments into the comments tree.
+   */
+  function getComments(id) {
+    $.ajax({
+     type: 'GET',
+     url: opts.getCommentsURL,
+     data: {node: id},
+     success: function(data, textStatus, request) {
+       var ul = $('#cl' + id);
+       var speed = 100;
+       $('#cf' + id)
+         .find('textarea[name="proposal"]')
+         .data('source', data.source);
+
+       if (data.comments.length === 0) {
+         ul.html('<li>No comments yet.</li>');
+         ul.data('empty', true);
+       } else {
+         // If there are comments, sort them and put them in the list.
+         var comments = sortComments(data.comments);
+         speed = data.comments.length * 100;
+         appendComments(comments, ul);
+         ul.data('empty', false);
+       }
+       $('#cn' + id).slideUp(speed + 200);
+       ul.slideDown(speed);
+     },
+     error: function(request, textStatus, error) {
+       showError('Oops, there was a problem retrieving the comments.');
+     },
+     dataType: 'json'
+    });
+  }
+
+  /**
+   * Add a comment via ajax and insert the comment into the comment tree.
+   */
+  function addComment(form) {
+    var node_id = form.find('input[name="node"]').val();
+    var parent_id = form.find('input[name="parent"]').val();
+    var text = form.find('textarea[name="comment"]').val();
+    var proposal = form.find('textarea[name="proposal"]').val();
+
+    if (text == '') {
+      showError('Please enter a comment.');
+      return;
+    }
+
+    // Disable the form that is being submitted.
+    form.find('textarea,input').attr('disabled', 'disabled');
+
+    // Send the comment to the server.
+    $.ajax({
+      type: "POST",
+      url: opts.addCommentURL,
+      dataType: 'json',
+      data: {
+        node: node_id,
+        parent: parent_id,
+        text: text,
+        proposal: proposal
+      },
+      success: function(data, textStatus, error) {
+        // Reset the form.
+        if (node_id) {
+          hideProposeChange(node_id);
+        }
+        form.find('textarea')
+          .val('')
+          .add(form.find('input'))
+          .removeAttr('disabled');
+	var ul = $('#cl' + (node_id || parent_id));
+        if (ul.data('empty')) {
+          $(ul).empty();
+          ul.data('empty', false);
+        }
+        insertComment(data.comment);
+        var ao = $('#ao' + node_id);
+        ao.find('img').attr({'src': opts.commentBrightImage});
+        if (node_id) {
+          // if this was a "root" comment, remove the commenting box
+          // (the user can get it back by reopening the comment popup)
+          $('#ca' + node_id).slideUp();
+        }
+      },
+      error: function(request, textStatus, error) {
+        form.find('textarea,input').removeAttr('disabled');
+        showError('Oops, there was a problem adding the comment.');
+      }
+    });
+  }
+
+  /**
+   * Recursively append comments to the main comment list and children
+   * lists, creating the comment tree.
+   */
+  function appendComments(comments, ul) {
+    $.each(comments, function() {
+      var div = createCommentDiv(this);
+      ul.append($(document.createElement('li')).html(div));
+      appendComments(this.children, div.find('ul.comment-children'));
+      // To avoid stagnating data, don't store the comments children in data.
+      this.children = null;
+      div.data('comment', this);
+    });
+  }
+
+  /**
+   * After adding a new comment, it must be inserted in the correct
+   * location in the comment tree.
+   */
+  function insertComment(comment) {
+    var div = createCommentDiv(comment);
+
+    // To avoid stagnating data, don't store the comments children in data.
+    comment.children = null;
+    div.data('comment', comment);
+
+    var ul = $('#cl' + (comment.node || comment.parent));
+    var siblings = getChildren(ul);
+
+    var li = $(document.createElement('li'));
+    li.hide();
+
+    // Determine where in the parents children list to insert this comment.
+    for(var i=0; i < siblings.length; i++) {
+      if (comp(comment, siblings[i]) <= 0) {
+        $('#cd' + siblings[i].id)
+          .parent()
+          .before(li.html(div));
+        li.slideDown('fast');
+        return;
+      }
+    }
+
+    // If we get here, this comment rates lower than all the others,
+    // or it is the only comment in the list.
+    ul.append(li.html(div));
+    li.slideDown('fast');
+  }
+
+  function acceptComment(id) {
+    $.ajax({
+      type: 'POST',
+      url: opts.acceptCommentURL,
+      data: {id: id},
+      success: function(data, textStatus, request) {
+        $('#cm' + id).fadeOut('fast');
+        $('#cd' + id).removeClass('moderate');
+      },
+      error: function(request, textStatus, error) {
+        showError('Oops, there was a problem accepting the comment.');
+      }
+    });
+  }
+
+  function deleteComment(id) {
+    $.ajax({
+      type: 'POST',
+      url: opts.deleteCommentURL,
+      data: {id: id},
+      success: function(data, textStatus, request) {
+        var div = $('#cd' + id);
+        if (data == 'delete') {
+          // Moderator mode: remove the comment and all children immediately
+          div.slideUp('fast', function() {
+            div.remove();
+          });
+          return;
+        }
+        // User mode: only mark the comment as deleted
+        div
+          .find('span.user-id:first')
+          .text('[deleted]').end()
+          .find('div.comment-text:first')
+          .text('[deleted]').end()
+          .find('#cm' + id + ', #dc' + id + ', #ac' + id + ', #rc' + id +
+                ', #sp' + id + ', #hp' + id + ', #cr' + id + ', #rl' + id)
+          .remove();
+        var comment = div.data('comment');
+        comment.username = '[deleted]';
+        comment.text = '[deleted]';
+        div.data('comment', comment);
+      },
+      error: function(request, textStatus, error) {
+        showError('Oops, there was a problem deleting the comment.');
+      }
+    });
+  }
+
+  function showProposal(id) {
+    $('#sp' + id).hide();
+    $('#hp' + id).show();
+    $('#pr' + id).slideDown('fast');
+  }
+
+  function hideProposal(id) {
+    $('#hp' + id).hide();
+    $('#sp' + id).show();
+    $('#pr' + id).slideUp('fast');
+  }
+
+  function showProposeChange(id) {
+    $('#pc' + id).hide();
+    $('#hc' + id).show();
+    var textarea = $('#pt' + id);
+    textarea.val(textarea.data('source'));
+    $.fn.autogrow.resize(textarea[0]);
+    textarea.slideDown('fast');
+  }
+
+  function hideProposeChange(id) {
+    $('#hc' + id).hide();
+    $('#pc' + id).show();
+    var textarea = $('#pt' + id);
+    textarea.val('').removeAttr('disabled');
+    textarea.slideUp('fast');
+  }
+
+  function toggleCommentMarkupBox(id) {
+    $('#mb' + id).toggle();
+  }
+
+  /** Handle when the user clicks on a sort by link. */
+  function handleReSort(link) {
+    var classes = link.attr('class').split(/\s+/);
+    for (var i=0; i<classes.length; i++) {
+      if (classes[i] != 'sort-option') {
+	by = classes[i].substring(2);
+      }
+    }
+    setComparator();
+    // Save/update the sortBy cookie.
+    var expiration = new Date();
+    expiration.setDate(expiration.getDate() + 365);
+    document.cookie= 'sortBy=' + escape(by) +
+                     ';expires=' + expiration.toUTCString();
+    $('ul.comment-ul').each(function(index, ul) {
+      var comments = getChildren($(ul), true);
+      comments = sortComments(comments);
+      appendComments(comments, $(ul).empty());
+    });
+  }
+
+  /**
+   * Function to process a vote when a user clicks an arrow.
+   */
+  function handleVote(link) {
+    if (!opts.voting) {
+      showError("You'll need to login to vote.");
+      return;
+    }
+
+    var id = link.attr('id');
+    if (!id) {
+      // Didn't click on one of the voting arrows.
+      return;
+    }
+    // If it is an unvote, the new vote value is 0,
+    // Otherwise it's 1 for an upvote, or -1 for a downvote.
+    var value = 0;
+    if (id.charAt(1) != 'u') {
+      value = id.charAt(0) == 'u' ? 1 : -1;
+    }
+    // The data to be sent to the server.
+    var d = {
+      comment_id: id.substring(2),
+      value: value
+    };
+
+    // Swap the vote and unvote links.
+    link.hide();
+    $('#' + id.charAt(0) + (id.charAt(1) == 'u' ? 'v' : 'u') + d.comment_id)
+      .show();
+
+    // The div the comment is displayed in.
+    var div = $('div#cd' + d.comment_id);
+    var data = div.data('comment');
+
+    // If this is not an unvote, and the other vote arrow has
+    // already been pressed, unpress it.
+    if ((d.value !== 0) && (data.vote === d.value * -1)) {
+      $('#' + (d.value == 1 ? 'd' : 'u') + 'u' + d.comment_id).hide();
+      $('#' + (d.value == 1 ? 'd' : 'u') + 'v' + d.comment_id).show();
+    }
+
+    // Update the comments rating in the local data.
+    data.rating += (data.vote === 0) ? d.value : (d.value - data.vote);
+    data.vote = d.value;
+    div.data('comment', data);
+
+    // Change the rating text.
+    div.find('.rating:first')
+      .text(data.rating + ' point' + (data.rating == 1 ? '' : 's'));
+
+    // Send the vote information to the server.
+    $.ajax({
+      type: "POST",
+      url: opts.processVoteURL,
+      data: d,
+      error: function(request, textStatus, error) {
+        showError('Oops, there was a problem casting that vote.');
+      }
+    });
+  }
+
+  /**
+   * Open a reply form used to reply to an existing comment.
+   */
+  function openReply(id) {
+    // Swap out the reply link for the hide link
+    $('#rl' + id).hide();
+    $('#cr' + id).show();
+
+    // Add the reply li to the children ul.
+    var div = $(renderTemplate(replyTemplate, {id: id})).hide();
+    $('#cl' + id)
+      .prepend(div)
+      // Setup the submit handler for the reply form.
+      .find('#rf' + id)
+      .submit(function(event) {
+        event.preventDefault();
+        addComment($('#rf' + id));
+        closeReply(id);
+      })
+      .find('input[type=button]')
+      .click(function() {
+        closeReply(id);
+      });
+    div.slideDown('fast', function() {
+      $('#rf' + id).find('textarea').focus();
+    });
+  }
+
+  /**
+   * Close the reply form opened with openReply.
+   */
+  function closeReply(id) {
+    // Remove the reply div from the DOM.
+    $('#rd' + id).slideUp('fast', function() {
+      $(this).remove();
+    });
+
+    // Swap out the hide link for the reply link
+    $('#cr' + id).hide();
+    $('#rl' + id).show();
+  }
+
+  /**
+   * Recursively sort a tree of comments using the comp comparator.
+   */
+  function sortComments(comments) {
+    comments.sort(comp);
+    $.each(comments, function() {
+      this.children = sortComments(this.children);
+    });
+    return comments;
+  }
+
+  /**
+   * Get the children comments from a ul. If recursive is true,
+   * recursively include childrens' children.
+   */
+  function getChildren(ul, recursive) {
+    var children = [];
+    ul.children().children("[id^='cd']")
+      .each(function() {
+        var comment = $(this).data('comment');
+        if (recursive)
+          comment.children = getChildren($(this).find('#cl' + comment.id), true);
+        children.push(comment);
+      });
+    return children;
+  }
+
+  /** Create a div to display a comment in. */
+  function createCommentDiv(comment) {
+    if (!comment.displayed && !opts.moderator) {
+      return $('<div class="moderate">Thank you!  Your comment will show up '
+               + 'once it is has been approved by a moderator.</div>');
+    }
+    // Prettify the comment rating.
+    comment.pretty_rating = comment.rating + ' point' +
+      (comment.rating == 1 ? '' : 's');
+    // Make a class (for displaying not yet moderated comments differently)
+    comment.css_class = comment.displayed ? '' : ' moderate';
+    // Create a div for this comment.
+    var context = $.extend({}, opts, comment);
+    var div = $(renderTemplate(commentTemplate, context));
+
+    // If the user has voted on this comment, highlight the correct arrow.
+    if (comment.vote) {
+      var direction = (comment.vote == 1) ? 'u' : 'd';
+      div.find('#' + direction + 'v' + comment.id).hide();
+      div.find('#' + direction + 'u' + comment.id).show();
+    }
+
+    if (opts.moderator || comment.text != '[deleted]') {
+      div.find('a.reply').show();
+      if (comment.proposal_diff)
+        div.find('#sp' + comment.id).show();
+      if (opts.moderator && !comment.displayed)
+        div.find('#cm' + comment.id).show();
+      if (opts.moderator || (opts.username == comment.username))
+        div.find('#dc' + comment.id).show();
+    }
+    return div;
+  }
+
+  /**
+   * A simple template renderer. Placeholders such as <%id%> are replaced
+   * by context['id'] with items being escaped. Placeholders such as <#id#>
+   * are not escaped.
+   */
+  function renderTemplate(template, context) {
+    var esc = $(document.createElement('div'));
+
+    function handle(ph, escape) {
+      var cur = context;
+      $.each(ph.split('.'), function() {
+        cur = cur[this];
+      });
+      return escape ? esc.text(cur || "").html() : cur;
+    }
+
+    return template.replace(/<([%#])([\w\.]*)\1>/g, function() {
+      return handle(arguments[2], arguments[1] == '%' ? true : false);
+    });
+  }
+
+  /** Flash an error message briefly. */
+  function showError(message) {
+    $(document.createElement('div')).attr({'class': 'popup-error'})
+      .append($(document.createElement('div'))
+               .attr({'class': 'error-message'}).text(message))
+      .appendTo('body')
+      .fadeIn("slow")
+      .delay(2000)
+      .fadeOut("slow");
+  }
+
+  /** Add a link the user uses to open the comments popup. */
+  $.fn.comment = function() {
+    return this.each(function() {
+      var id = $(this).attr('id').substring(1);
+      var count = COMMENT_METADATA[id];
+      var title = count + ' comment' + (count == 1 ? '' : 's');
+      var image = count > 0 ? opts.commentBrightImage : opts.commentImage;
+      var addcls = count == 0 ? ' nocomment' : '';
+      $(this)
+        .append(
+          $(document.createElement('a')).attr({
+            href: '#',
+            'class': 'sphinx-comment-open' + addcls,
+            id: 'ao' + id
+          })
+            .append($(document.createElement('img')).attr({
+              src: image,
+              alt: 'comment',
+              title: title
+            }))
+            .click(function(event) {
+              event.preventDefault();
+              show($(this).attr('id').substring(2));
+            })
+        )
+        .append(
+          $(document.createElement('a')).attr({
+            href: '#',
+            'class': 'sphinx-comment-close hidden',
+            id: 'ah' + id
+          })
+            .append($(document.createElement('img')).attr({
+              src: opts.closeCommentImage,
+              alt: 'close',
+              title: 'close'
+            }))
+            .click(function(event) {
+              event.preventDefault();
+              hide($(this).attr('id').substring(2));
+            })
+        );
+    });
+  };
+
+  var opts = {
+    processVoteURL: '/_process_vote',
+    addCommentURL: '/_add_comment',
+    getCommentsURL: '/_get_comments',
+    acceptCommentURL: '/_accept_comment',
+    deleteCommentURL: '/_delete_comment',
+    commentImage: '/static/_static/comment.png',
+    closeCommentImage: '/static/_static/comment-close.png',
+    loadingImage: '/static/_static/ajax-loader.gif',
+    commentBrightImage: '/static/_static/comment-bright.png',
+    upArrow: '/static/_static/up.png',
+    downArrow: '/static/_static/down.png',
+    upArrowPressed: '/static/_static/up-pressed.png',
+    downArrowPressed: '/static/_static/down-pressed.png',
+    voting: false,
+    moderator: false
+  };
+
+  if (typeof COMMENT_OPTIONS != "undefined") {
+    opts = jQuery.extend(opts, COMMENT_OPTIONS);
+  }
+
+  var popupTemplate = '\
+    <div class="sphinx-comments" id="sc<%id%>">\
+      <p class="sort-options">\
+        Sort by:\
+        <a href="#" class="sort-option byrating">best rated</a>\
+        <a href="#" class="sort-option byascage">newest</a>\
+        <a href="#" class="sort-option byage">oldest</a>\
+      </p>\
+      <div class="comment-header">Comments</div>\
+      <div class="comment-loading" id="cn<%id%>">\
+        loading comments... <img src="<%loadingImage%>" alt="" /></div>\
+      <ul id="cl<%id%>" class="comment-ul"></ul>\
+      <div id="ca<%id%>">\
+      <p class="add-a-comment">Add a comment\
+        (<a href="#" class="comment-markup" id="ab<%id%>">markup</a>):</p>\
+      <div class="comment-markup-box" id="mb<%id%>">\
+        reStructured text markup: <i>*emph*</i>, <b>**strong**</b>, \
+        <code>``code``</code>, \
+        code blocks: <code>::</code> and an indented block after blank line</div>\
+      <form method="post" id="cf<%id%>" class="comment-form" action="">\
+        <textarea name="comment" cols="80"></textarea>\
+        <p class="propose-button">\
+          <a href="#" id="pc<%id%>" class="show-propose-change">\
+            Propose a change &#9657;\
+          </a>\
+          <a href="#" id="hc<%id%>" class="hide-propose-change">\
+            Propose a change &#9663;\
+          </a>\
+        </p>\
+        <textarea name="proposal" id="pt<%id%>" cols="80"\
+                  spellcheck="false"></textarea>\
+        <input type="submit" value="Add comment" />\
+        <input type="hidden" name="node" value="<%id%>" />\
+        <input type="hidden" name="parent" value="" />\
+      </form>\
+      </div>\
+    </div>';
+
+  var commentTemplate = '\
+    <div id="cd<%id%>" class="sphinx-comment<%css_class%>">\
+      <div class="vote">\
+        <div class="arrow">\
+          <a href="#" id="uv<%id%>" class="vote" title="vote up">\
+            <img src="<%upArrow%>" />\
+          </a>\
+          <a href="#" id="uu<%id%>" class="un vote" title="vote up">\
+            <img src="<%upArrowPressed%>" />\
+          </a>\
+        </div>\
+        <div class="arrow">\
+          <a href="#" id="dv<%id%>" class="vote" title="vote down">\
+            <img src="<%downArrow%>" id="da<%id%>" />\
+          </a>\
+          <a href="#" id="du<%id%>" class="un vote" title="vote down">\
+            <img src="<%downArrowPressed%>" />\
+          </a>\
+        </div>\
+      </div>\
+      <div class="comment-content">\
+        <p class="tagline comment">\
+          <span class="user-id"><%username%></span>\
+          <span class="rating"><%pretty_rating%></span>\
+          <span class="delta"><%time.delta%></span>\
+        </p>\
+        <div class="comment-text comment"><#text#></div>\
+        <p class="comment-opts comment">\
+          <a href="#" class="reply hidden" id="rl<%id%>">reply &#9657;</a>\
+          <a href="#" class="close-reply" id="cr<%id%>">reply &#9663;</a>\
+          <a href="#" id="sp<%id%>" class="show-proposal">proposal &#9657;</a>\
+          <a href="#" id="hp<%id%>" class="hide-proposal">proposal &#9663;</a>\
+          <a href="#" id="dc<%id%>" class="delete-comment hidden">delete</a>\
+          <span id="cm<%id%>" class="moderation hidden">\
+            <a href="#" id="ac<%id%>" class="accept-comment">accept</a>\
+          </span>\
+        </p>\
+        <pre class="proposal" id="pr<%id%>">\
+<#proposal_diff#>\
+        </pre>\
+          <ul class="comment-children" id="cl<%id%>"></ul>\
+        </div>\
+        <div class="clearleft"></div>\
+      </div>\
+    </div>';
+
+  var replyTemplate = '\
+    <li>\
+      <div class="reply-div" id="rd<%id%>">\
+        <form id="rf<%id%>">\
+          <textarea name="comment" cols="80"></textarea>\
+          <input type="submit" value="Add reply" />\
+          <input type="button" value="Cancel" />\
+          <input type="hidden" name="parent" value="<%id%>" />\
+          <input type="hidden" name="node" value="" />\
+        </form>\
+      </div>\
+    </li>';
+
+  $(document).ready(function() {
+    init();
+  });
+})(jQuery);
+
+$(document).ready(function() {
+  // add comment anchors for all paragraphs that are commentable
+  $('.sphinx-has-comment').comment();
+
+  // highlight search words in search results
+  $("div.context").each(function() {
+    var params = $.getQueryParameters();
+    var terms = (params.q) ? params.q[0].split(/\s+/) : [];
+    var result = $(this);
+    $.each(terms, function() {
+      result.highlightText(this.toLowerCase(), 'highlighted');
+    });
+  });
+
+  // directly open comment window if requested
+  var anchor = document.location.hash;
+  if (anchor.substring(0, 9) == '#comment-') {
+    $('#ao' + anchor.substring(9)).click();
+    document.location.hash = '#s' + anchor.substring(9);
+  }
+});

docs/build/html/contents.html

@@ -0,0 +1,131 @@
+<!DOCTYPE html>
+<head>
+  <meta charset="utf-8">
+  
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="theme-color" content="#2D2D2D" />
+  
+  <title>Enlight :: &lt;no title&gt;</title>
+  
+
+  <link rel="icon" type="image/png" sizes="32x32" href="_static/img/favicon-32x32.png">
+  <link rel="icon" type="image/png" sizes="16x16" href="_static/img/favicon-16x16.png">
+        <link rel="index" title="Index"
+              href="genindex.html"/>
+
+  <link rel="stylesheet" href="_static/css/insegel.css"/>
+
+  <script type="text/javascript">
+    var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'',
+        VERSION:'',
+        LANGUAGE:'None',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+    };
+  </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 src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
+
+</head>
+
+<body>
+  <div id="insegel-container">
+    <header>
+      <div id="logo-container">
+          
+          <a href="#"><img src="_static/img/logo.svg"></a>
+          
+
+      </div>
+      <div id="project-container">
+        <h1>Enlight Documentation</h1>
+      </div>
+    </header>
+
+    <div id="content-container">
+
+      <div id="main-content-container">
+        <div id="main-content-header">
+          <h1>&lt;no title&gt;</h1>
+        </div>
+        <div id="main-content">
+          
+  
+
+        </div>
+      </div>
+
+      <div id="side-menu-container">
+
+        <div id="search" role="search">
+        <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+            <input type="text" name="q" placeholder="Search..." />
+            <input type="hidden" name="check_keywords" value="yes" />
+            <input type="hidden" name="area" value="default" />
+        </form>
+</div>
+
+        <div id="side-menu" role="navigation">
+
+          
+  
+    
+  
+  
+    <div class="local-toc"><ul class="simple">
+</ul>
+</div>
+  
+
+
+        </div>
+
+        
+
+      </div>
+
+    </div>
+
+<footer>
+    <div id="footer-info">
+        <ul id="build-details">
+            
+                <li class="footer-element">
+                    
+                        <a href="_sources/contents.rst.txt" rel="nofollow"> source</a>
+                    
+                </li>
+            
+
+            
+
+            
+        </ul>
+        <div id="credit">
+            created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/Autophagy/insegel">Insegel</a>
+
+        </div>
+    </div>
+
+    <a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
+
+    <script type="text/javascript">
+      $("#menu-toggle").click(function() {
+        $("#menu-toggle").toggleClass("toggled");
+        $("#side-menu-container").slideToggle(300);
+      });
+    </script>
+
+</footer> 
+
+</div>
+
+</body>
+</html>

docs/build/html/genindex.html

@@ -1,36 +1,63 @@
 
 <!DOCTYPE html>
-
+<head>
-<html>
+  <meta charset="utf-8">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Index &#8212; Enlight  documentation</title>
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script 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>
-    <link rel="index" title="Index" href="#" />
-    <link rel="search" title="Search" href="search.html" />
-   
-  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
   
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="theme-color" content="#2D2D2D" />
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  <title>Enlight :: Index</title>
-
-  </head><body>
   
 
-    <div class="document">
+  <link rel="icon" type="image/png" sizes="32x32" href="_static/img/favicon-32x32.png">
-      <div class="documentwrapper">
+  <link rel="icon" type="image/png" sizes="16x16" href="_static/img/favicon-16x16.png">
-        <div class="bodywrapper">
+        <link rel="index" title="Index"
+              href="#"/>
+
+  <link rel="stylesheet" href="_static/css/insegel.css"/>
+
+  <script type="text/javascript">
+    var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'',
+        VERSION:'',
+        LANGUAGE:'None',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+    };
+  </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 src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
+
+</head>
+
+<body>
+  <div id="insegel-container">
+    <header>
+      <div id="logo-container">
+          
+          <a href="contents.html"><img src="_static/img/logo.svg"></a>
           
 
-          <div class="body" role="main">
+      </div>
-            
+      <div id="project-container">
+        <h1>Enlight Documentation</h1>
+      </div>
+    </header>
+
+    <div id="content-container">
+
+      <div id="main-content-container">
+        <div id="main-content-header">
+          <h1>Index</h1>
+        </div>
+        <div id="main-content">
+          
 
 <h1 id="index">Index</h1>
 
@@ -97,10 +124,12 @@
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#mainCode.session.enlightSession.leave">leave() (mainCode.session.enlightSession method)</a>
+</li>
+      <li><a href="index.html#mainCode.session.enlightSession.lighthouseMain">lighthouseMain() (mainCode.session.enlightSession method)</a>
 </li>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li><a href="index.html#mainCode.session.enlightSession.lighthouseMain">lighthouseMain() (mainCode.session.enlightSession method)</a>
+      <li><a href="index.html#mainCode.session.enlightSession.lightSearcherDirectMain">lightSearcherDirectMain() (mainCode.session.enlightSession method)</a>
 </li>
       <li><a href="index.html#mainCode.session.enlightSession.lightSearcherMain">lightSearcherMain() (mainCode.session.enlightSession method)</a>
 </li>
@@ -110,27 +139,17 @@
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
   <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
+      <li><a href="index.html#module-mainCode.session">mainCode.session (module)</a>
-    mainCode.session
-
-      <ul>
-        <li><a href="index.html#module-mainCode.session">module</a>
 </li>
-      </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
-      <li>
-    module
-
-      <ul>
-        <li><a href="index.html#module-mainCode.session">mainCode.session</a>
-</li>
-      </ul></li>
   </ul></td>
 </tr></table>
 
 <h2 id="S">S</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="index.html#mainCode.session.enlightSession.serverMain">serverMain() (mainCode.session.enlightSession method)</a>
+</li>
+  </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="index.html#mainCode.session.enlightSession.stopSession">stopSession() (mainCode.session.enlightSession method)</a>
 </li>
@@ -139,63 +158,69 @@
 
 
 
-          </div>
+        </div>
+      </div>
+
+      <div id="side-menu-container">
+
+        <div id="search" role="search">
+        <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+            <input type="text" name="q" placeholder="Search..." />
+            <input type="hidden" name="check_keywords" value="yes" />
+            <input type="hidden" name="area" value="default" />
+        </form>
+</div>
+
+        <div id="side-menu" role="navigation">
+
           
-        </div>
+  
-      </div>
+    
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+  
-        <div class="sphinxsidebarwrapper">
+  
-<h1 class="logo"><a href="index.html">Enlight</a></h1>
+    <div class="local-toc"></div>
-
+  
-
-
-
-
-
-
-
-<h3>Navigation</h3>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="index.html">Documentation overview</a><ul>
-  </ul></li>
-</ul>
-</div>
-<div id="searchbox" style="display: none" role="search">
-  <h3 id="searchlabel">Quick search</h3>
-    <div class="searchformwrapper">
-    <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</div>
-<script>$('#searchbox').show(0);</script>
-
-
-
-
-
-
 
 
         </div>
+
+        
+
       </div>
-      <div class="clearer"></div>
+
-    </div>
-    <div class="footer">
-      &copy;2020, TheGreyDiamond.
-      
-      |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
-      
     </div>
 
-    
+<footer>
+    <div id="footer-info">
+        <ul id="build-details">
+            
+                <li class="footer-element">
+                    
+                </li>
+            
 
-    
+            
-  </body>
+
+            
+        </ul>
+        <div id="credit">
+            created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/Autophagy/insegel">Insegel</a>
+
+        </div>
+    </div>
+
+    <a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
+
+    <script type="text/javascript">
+      $("#menu-toggle").click(function() {
+        $("#menu-toggle").toggleClass("toggled");
+        $("#side-menu-container").slideToggle(300);
+      });
+    </script>
+
+</footer> 
+
+</div>
+
+</body>
 </html>

docs/build/html/index.html

@@ -1,183 +1,264 @@
-
 <!DOCTYPE html>
-
+<head>
-<html>
+  <meta charset="utf-8">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Welcome to Enlight’s documentation! &#8212; Enlight  documentation</title>
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script 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>
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-   
-  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
   
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="theme-color" content="#2D2D2D" />
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  <title>Enlight :: Welcome to Enlight’s documentation!</title>
-
-  </head><body>
   
 
-    <div class="document">
+  <link rel="icon" type="image/png" sizes="32x32" href="_static/img/favicon-32x32.png">
-      <div class="documentwrapper">
+  <link rel="icon" type="image/png" sizes="16x16" href="_static/img/favicon-16x16.png">
-        <div class="bodywrapper">
+        <link rel="index" title="Index"
+              href="genindex.html"/>
+
+  <link rel="stylesheet" href="_static/css/insegel.css"/>
+
+  <script type="text/javascript">
+    var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'',
+        VERSION:'',
+        LANGUAGE:'None',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+    };
+  </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 src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
+
+</head>
+
+<body>
+  <div id="insegel-container">
+    <header>
+      <div id="logo-container">
+          
+          <a href="contents.html"><img src="_static/img/logo.svg"></a>
           
 
-          <div class="body" role="main">
+      </div>
-            
+      <div id="project-container">
+        <h1>Enlight Documentation</h1>
+      </div>
+    </header>
+
+    <div id="content-container">
+
+      <div id="main-content-container">
+        <div id="main-content-header">
+          <h1>Welcome to Enlight’s documentation!</h1>
+        </div>
+        <div id="main-content">
+          
   <div class="section" id="module-mainCode.session">
 <span id="welcome-to-enlight-s-documentation"></span><h1>Welcome to Enlight’s documentation!<a class="headerlink" href="#module-mainCode.session" title="Permalink to this headline">¶</a></h1>
-<dl class="py class">
+<div class="section" id="session-py">
+<h2>session.py<a class="headerlink" href="#session-py" title="Permalink to this headline">¶</a></h2>
+<p>The session support for Enlight</p>
+<dl class="class">
 <dt id="mainCode.session.enlightSession">
-<em class="property">class </em><code class="sig-prename descclassname">mainCode.session.</code><code class="sig-name descname">enlightSession</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">name</span><span class="o">=</span><span class="default_value">''</span></em>, <em class="sig-param"><span class="n">role</span><span class="o">=</span><span class="default_value">0</span></em>, <em class="sig-param"><span class="n">password</span><span class="o">=</span><span class="default_value">''</span></em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession" title="Permalink to this definition">¶</a></dt>
+<em class="property">class </em><code class="descclassname">mainCode.session.</code><code class="descname">enlightSession</code><span class="sig-paren">(</span><em>name=''</em>, <em>role=0</em>, <em>passcode=''</em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession" title="Permalink to this definition">¶</a></dt>
 <dd><p>The main session class</p>
-<dl class="py method">
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">String name:</th><td class="field-body">The session name (not needed)</td>
+</tr>
+<tr class="field-even field"><th class="field-name">String role:</th><td class="field-body">The role of the local instance (defaults to HOST, can be HOST or USER)</td>
+</tr>
+</tbody>
+</table>
+<dl class="method">
 <dt id="mainCode.session.enlightSession.clearAllSessions">
-<code class="sig-name descname">clearAllSessions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.clearAllSessions" title="Permalink to this definition">¶</a></dt>
+<code class="descname">clearAllSessions</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.clearAllSessions" title="Permalink to this definition">¶</a></dt>
-<dd><p>Clears the sessionlist chace</p>
+<dd><p>Clears all discoverd sessions</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.getSessionId">
-<code class="sig-name descname">getSessionId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.getSessionId" title="Permalink to this definition">¶</a></dt>
+<code class="descname">getSessionId</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.getSessionId" title="Permalink to this definition">¶</a></dt>
 <dd><p>Get the local session id</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.getSessionMembers">
-<code class="sig-name descname">getSessionMembers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.getSessionMembers" title="Permalink to this definition">¶</a></dt>
+<code class="descname">getSessionMembers</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.getSessionMembers" title="Permalink to this definition">¶</a></dt>
-<dd><p>Get all session members</p>
+<dd><p>Get all session members
+:return: Returns a list of all members</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.initConnection">
-<code class="sig-name descname">initConnection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.initConnection" title="Permalink to this definition">¶</a></dt>
+<code class="descname">initConnection</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.initConnection" title="Permalink to this definition">¶</a></dt>
 <dd><p>Starts the main dicovery/connction method(s)</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.join">
-<code class="sig-name descname">join</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">sessionID</span></em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.join" title="Permalink to this definition">¶</a></dt>
+<code class="descname">join</code><span class="sig-paren">(</span><em>sessionID</em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.join" title="Permalink to this definition">¶</a></dt>
 <dd><p>Join a remote session</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.leave">
-<code class="sig-name descname">leave</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.leave" title="Permalink to this definition">¶</a></dt>
+<code class="descname">leave</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.leave" title="Permalink to this definition">¶</a></dt>
 <dd><p>Leaves the session, will take at least two seconds</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
+<dt id="mainCode.session.enlightSession.lightSearcherDirectMain">
+<code class="descname">lightSearcherDirectMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.lightSearcherDirectMain" title="Permalink to this definition">¶</a></dt>
+<dd><p>The Handler for direct comuncation between HOST and USER</p>
+</dd></dl>
+
+<dl class="method">
 <dt id="mainCode.session.enlightSession.lightSearcherMain">
-<code class="sig-name descname">lightSearcherMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.lightSearcherMain" title="Permalink to this definition">¶</a></dt>
+<code class="descname">lightSearcherMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.lightSearcherMain" title="Permalink to this definition">¶</a></dt>
 <dd><p>The main thread for clients to connect</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
 <dt id="mainCode.session.enlightSession.lighthouseMain">
-<code class="sig-name descname">lighthouseMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.lighthouseMain" title="Permalink to this definition">¶</a></dt>
+<code class="descname">lighthouseMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.lighthouseMain" title="Permalink to this definition">¶</a></dt>
 <dd><p>The main thread for searching/finding sessions</p>
 </dd></dl>
 
-<dl class="py method">
+<dl class="method">
+<dt id="mainCode.session.enlightSession.serverMain">
+<code class="descname">serverMain</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.serverMain" title="Permalink to this definition">¶</a></dt>
+<dd><p>Main Discovery server</p>
+</dd></dl>
+
+<dl class="method">
 <dt id="mainCode.session.enlightSession.stopSession">
-<code class="sig-name descname">stopSession</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.stopSession" title="Permalink to this definition">¶</a></dt>
+<code class="descname">stopSession</code><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.enlightSession.stopSession" title="Permalink to this definition">¶</a></dt>
 <dd><p>Stops the session as a HOST</p>
 </dd></dl>
 
 </dd></dl>
 
-<dl class="py function">
+<dl class="function">
 <dt id="mainCode.session.get_local_ip">
-<code class="sig-prename descclassname">mainCode.session.</code><code class="sig-name descname">get_local_ip</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">no</span><span class="o">=</span><span class="default_value">0</span></em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.get_local_ip" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">mainCode.session.</code><code class="descname">get_local_ip</code><span class="sig-paren">(</span><em>no=0</em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.get_local_ip" title="Permalink to this definition">¶</a></dt>
 <dd><p>Gets the local ip address</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Int no:</th><td class="field-body">ID of the ip adress</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
-<dl class="py function">
+<dl class="function">
 <dt id="mainCode.session.get_random_alphanumeric_string">
-<code class="sig-prename descclassname">mainCode.session.</code><code class="sig-name descname">get_random_alphanumeric_string</code><span class="sig-paren">(</span><em class="sig-param"><span class="n">length</span></em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.get_random_alphanumeric_string" title="Permalink to this definition">¶</a></dt>
+<code class="descclassname">mainCode.session.</code><code class="descname">get_random_alphanumeric_string</code><span class="sig-paren">(</span><em>length</em><span class="sig-paren">)</span><a class="headerlink" href="#mainCode.session.get_random_alphanumeric_string" title="Permalink to this definition">¶</a></dt>
-<dd><p>Returns a randomly genrated alphanumeric string, with the length <cite>length</cite></p>
+<dd><p>Returns a random alphanumeric string</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field-odd field"><th class="field-name">Int length:</th><td class="field-body">The length of the output string</td>
+</tr>
+</tbody>
+</table>
 </dd></dl>
 
+</div>
 <div class="toctree-wrapper compound">
 </div>
 </div>
 <div class="section" id="indices-and-tables">
 <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h1>
 <ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
+<li><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></li>
-<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
+<li><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></li>
-<li><p>:ref:<a href="#id1"><span class="problematic" id="id2">`</span></a>search</p></li>
+<li><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></li>
 </ul>
 </div>
 
 
-          </div>
+        </div>
+      </div>
+
+      <div id="side-menu-container">
+
+        <div id="search" role="search">
+        <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+            <input type="text" name="q" placeholder="Search..." />
+            <input type="hidden" name="check_keywords" value="yes" />
+            <input type="hidden" name="area" value="default" />
+        </form>
+</div>
+
+        <div id="side-menu" role="navigation">
+
           
-        </div>
+  
-      </div>
+    
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+  
-        <div class="sphinxsidebarwrapper">
+  
-<h1 class="logo"><a href="#">Enlight</a></h1>
+    <div class="local-toc"><ul>
-
+<li><a class="reference internal" href="#">Welcome to Enlight’s documentation!</a><ul>
-
+<li><a class="reference internal" href="#session-py">session.py</a></li>
-
+</ul>
-
+</li>
-
+<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
-
-
-
-<h3>Navigation</h3>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="#">Documentation overview</a><ul>
-  </ul></li>
 </ul>
 </div>
-<div id="searchbox" style="display: none" role="search">
+  
-  <h3 id="searchlabel">Quick search</h3>
-    <div class="searchformwrapper">
-    <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</div>
-<script>$('#searchbox').show(0);</script>
-
-
-
-
-
-
 
 
         </div>
+
+        
+
       </div>
-      <div class="clearer"></div>
+
-    </div>
-    <div class="footer">
-      &copy;2020, TheGreyDiamond.
-      
-      |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
-      
-      |
-      <a href="_sources/index.rst.txt"
-          rel="nofollow">Page source</a>
     </div>
 
-    
+<footer>
+    <div id="footer-info">
+        <ul id="build-details">
+            
+                <li class="footer-element">
+                    
+                        <a href="_sources/index.rst.txt" rel="nofollow"> source</a>
+                    
+                </li>
+            
 
-    
+            
-  </body>
+
+            
+        </ul>
+        <div id="credit">
+            created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/Autophagy/insegel">Insegel</a>
+
+        </div>
+    </div>
+
+    <a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
+
+    <script type="text/javascript">
+      $("#menu-toggle").click(function() {
+        $("#menu-toggle").toggleClass("toggled");
+        $("#side-menu-container").slideToggle(300);
+      });
+    </script>
+
+</footer> 
+
+</div>
+
+</body>
 </html>

docs/build/html/py-modindex.html

@@ -1,39 +1,62 @@
-
 <!DOCTYPE html>
-
+<head>
-<html>
+  <meta charset="utf-8">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Python Module Index &#8212; Enlight  documentation</title>
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    <script 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>
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-
-   
-  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
   
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <meta name="theme-color" content="#2D2D2D" />
   
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
+  <title>Enlight :: Python Module Index</title>
-
-
-
-  </head><body>
   
 
-    <div class="document">
+  <link rel="icon" type="image/png" sizes="32x32" href="_static/img/favicon-32x32.png">
-      <div class="documentwrapper">
+  <link rel="icon" type="image/png" sizes="16x16" href="_static/img/favicon-16x16.png">
-        <div class="bodywrapper">
+        <link rel="index" title="Index"
+              href="genindex.html"/>
+
+  <link rel="stylesheet" href="_static/css/insegel.css"/>
+
+  <script type="text/javascript">
+    var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'',
+        VERSION:'',
+        LANGUAGE:'None',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+    };
+  </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 src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
+
+</head>
+
+<body>
+  <div id="insegel-container">
+    <header>
+      <div id="logo-container">
+          
+          <a href="contents.html"><img src="_static/img/logo.svg"></a>
           
 
-          <div class="body" role="main">
+      </div>
-            
+      <div id="project-container">
+        <h1>Enlight Documentation</h1>
+      </div>
+    </header>
+
+    <div id="content-container">
+
+      <div id="main-content-container">
+        <div id="main-content-header">
+          <h1>Python Module Index</h1>
+        </div>
+        <div id="main-content">
+          
 
    <h1>Python Module Index</h1>
 
@@ -59,63 +82,65 @@
    </table>
 
 
-          </div>
+        </div>
+      </div>
+
+      <div id="side-menu-container">
+
+        <div id="search" role="search">
+        <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
+            <input type="text" name="q" placeholder="Search..." />
+            <input type="hidden" name="check_keywords" value="yes" />
+            <input type="hidden" name="area" value="default" />
+        </form>
+</div>
+
+        <div id="side-menu" role="navigation">
+
           
-        </div>
+  
-      </div>
+    
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+  
-        <div class="sphinxsidebarwrapper">
+  
-<h1 class="logo"><a href="index.html">Enlight</a></h1>
+    <div class="local-toc"></div>
-
+  
-
-
-
-
-
-
-
-<h3>Navigation</h3>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="index.html">Documentation overview</a><ul>
-  </ul></li>
-</ul>
-</div>
-<div id="searchbox" style="display: none" role="search">
-  <h3 id="searchlabel">Quick search</h3>
-    <div class="searchformwrapper">
-    <form class="search" action="search.html" method="get">
-      <input type="text" name="q" aria-labelledby="searchlabel" />
-      <input type="submit" value="Go" />
-    </form>
-    </div>
-</div>
-<script>$('#searchbox').show(0);</script>
-
-
-
-
-
-
 
 
         </div>
+
+        
+
       </div>
-      <div class="clearer"></div>
+
-    </div>
-    <div class="footer">
-      &copy;2020, TheGreyDiamond.
-      
-      |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
-      
     </div>
 
-    
+<footer>
+    <div id="footer-info">
+        <ul id="build-details">
+            
 
-    
+            
-  </body>
+
+            
+        </ul>
+        <div id="credit">
+            created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/Autophagy/insegel">Insegel</a>
+
+        </div>
+    </div>
+
+    <a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
+
+    <script type="text/javascript">
+      $("#menu-toggle").click(function() {
+        $("#menu-toggle").toggleClass("toggled");
+        $("#side-menu-container").slideToggle(300);
+      });
+    </script>
+
+</footer> 
+
+</div>
+
+</body>
 </html>

docs/build/html/search.html

@@ -1,110 +1,141 @@
-
 <!DOCTYPE html>
-
+<head>
-<html>
+  <meta charset="utf-8">
-  <head>
-    <meta charset="utf-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Search &#8212; Enlight  documentation</title>
-    <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
-    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
-    
-    <script 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>
-    <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="#" />
-  <script src="searchindex.js" defer></script>
   
-   
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <link rel="stylesheet" href="_static/custom.css" type="text/css" />
+  <meta name="theme-color" content="#2D2D2D" />
   
-  
+  <title>Enlight :: Search</title>
-  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
-
-
-  </head><body>
   
 
-    <div class="document">
+  <link rel="icon" type="image/png" sizes="32x32" href="_static/img/favicon-32x32.png">
-      <div class="documentwrapper">
+  <link rel="icon" type="image/png" sizes="16x16" href="_static/img/favicon-16x16.png">
-        <div class="bodywrapper">
+        <link rel="index" title="Index"
+              href="genindex.html"/>
+
+  <link rel="stylesheet" href="_static/css/insegel.css"/>
+
+  <script type="text/javascript">
+    var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:'',
+        VERSION:'',
+        LANGUAGE:'None',
+        COLLAPSE_INDEX:false,
+        FILE_SUFFIX:'.html',
+        HAS_SOURCE:  true,
+        SOURCELINK_SUFFIX: '.txt'
+    };
+  </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 src="https://email.tl.fortawesome.com/c/eJxNjUEOgyAQAF8jR7Kw6wIHDh7sP1Cw2mgxgmn6-3JsMqc5zEQfE8dkxOY1KKMUOI3ACFKRJpSW2AAp7ontYIaxI6i7XPJVwyeVfCQ550Os3jLrGSNOLgbdAy6s0PBk2TFNjEbsfq31LB0OnX407pJa5v2faRadwSW63mn5KuLyR9j2tgx3zecanl-55R_-jjPs"></script>
+
+</head>
+
+<body>
+  <div id="insegel-container">
+    <header>
+      <div id="logo-container">
+          
+          <a href="contents.html"><img src="_static/img/logo.svg"></a>
           
 
-          <div class="body" role="main">
+      </div>
-            
+      <div id="project-container">
-  <h1 id="search-documentation">Search</h1>
+        <h1>Enlight Documentation</h1>
-  <div id="fallback" class="admonition warning">
+      </div>
-  <script>$('#fallback').hide();</script>
+    </header>
-  <p>
+
-    Please activate JavaScript to enable the search
+    <div id="content-container">
-    functionality.
+
-  </p>
+      <div id="main-content-container">
-  </div>
+        <div id="main-content-header">
-  <p>
+          <h1>Search</h1>
-    Searching for multiple words only shows matches that contain
+        </div>
-    all words.
+        <div id="main-content">
-  </p>
+          
-  <form action="" method="get">
+  <noscript>
-    <input type="text" name="q" aria-labelledby="search-documentation" value="" />
+    <p>Documentation searching relies on Javascript. Please enable it.</p>
-    <input type="submit" value="search" />
+  </noscript>
-    <span id="search-progress" style="padding-left: 10px"></span>
+
-  </form>
+    
-  
   <div id="search-results">
   
   </div>
 
-          </div>
+
-          
         </div>
       </div>
-      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
-        <div class="sphinxsidebarwrapper">
-<h1 class="logo"><a href="index.html">Enlight</a></h1>
 
+      <div id="side-menu-container">
 
-
+        <div id="search" role="search">
-
+        <form id="rtd-search-form" class="wy-form" action="#" method="get">
-
+            <input type="text" name="q" placeholder="Search..." />
-
+            <input type="hidden" name="check_keywords" value="yes" />
-
+            <input type="hidden" name="area" value="default" />
-
+        </form>
-<h3>Navigation</h3>
-
-<div class="relations">
-<h3>Related Topics</h3>
-<ul>
-  <li><a href="index.html">Documentation overview</a><ul>
-  </ul></li>
-</ul>
 </div>
 
+        <div id="side-menu" role="navigation">
 
-
+          
-
+  
-
+    
-
+  
+  
+    <div class="local-toc"></div>
+  
 
 
         </div>
+
+        
+
       </div>
-      <div class="clearer"></div>
+
-    </div>
-    <div class="footer">
-      &copy;2020, TheGreyDiamond.
-      
-      |
-      Powered by <a href="http://sphinx-doc.org/">Sphinx 3.2.1</a>
-      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
-      
     </div>
 
-    
+<footer>
+    <div id="footer-info">
+        <ul id="build-details">
+            
+                <li class="footer-element">
+                    
+                </li>
+            
 
-    
+            
-  </body>
+
+            
+        </ul>
+        <div id="credit">
+            created with <a href="http://sphinx-doc.org/">Sphinx</a> and <a href="https://github.com/Autophagy/insegel">Insegel</a>
+
+        </div>
+    </div>
+
+    <a id="menu-toggle" class="fa fa-bars" aria-hidden="true"></a>
+
+    <script type="text/javascript">
+      $("#menu-toggle").click(function() {
+        $("#menu-toggle").toggleClass("toggled");
+        $("#side-menu-container").slideToggle(300);
+      });
+    </script>
+
+</footer>
+  <script type="text/javascript">
+    jQuery(function() { Search.loadIndex("searchindex.js"); });
+  </script>
+   
+
+
+</div>
+
+</body>
 </html>

docs/build/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst"],objects:{"mainCode.session":{enlightSession:[0,1,1,""],get_local_ip:[0,3,1,""],get_random_alphanumeric_string:[0,3,1,""]},"mainCode.session.enlightSession":{clearAllSessions:[0,2,1,""],getSessionId:[0,2,1,""],getSessionMembers:[0,2,1,""],initConnection:[0,2,1,""],join:[0,2,1,""],leave:[0,2,1,""],lightSearcherMain:[0,2,1,""],lighthouseMain:[0,2,1,""],stopSession:[0,2,1,""]},mainCode:{session:[0,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"class":0,"return":0,The:0,address:0,all:0,alphanumer:0,chace:0,clear:0,clearallsess:0,client:0,connction:0,connect:0,dicoveri:0,enlightsess:0,find:0,genrat:0,get:0,get_local_ip:0,get_random_alphanumeric_str:0,getsessionid:0,getsessionmemb:0,host:0,index:0,initconnect:0,join:0,least:0,leav:0,length:0,lighthousemain:0,lightsearchermain:0,local:0,main:0,maincod:0,member:0,method:0,modul:0,name:0,page:[],password:0,randomli:0,ref:0,remot:0,role:0,search:0,second:0,session:0,sessionid:0,sessionlist:0,start:0,stop:0,stopsess:0,string:0,take:0,thread:0,two:0},titles:["Welcome to Enlight\u2019s documentation!"],titleterms:{document:0,enlight:0,indic:0,tabl:0,welcom:0}})
+Search.setIndex({docnames:["contents","index"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.todo":1,sphinx:55},filenames:["contents.rst","index.rst"],objects:{"mainCode.session":{enlightSession:[1,1,1,""],get_local_ip:[1,3,1,""],get_random_alphanumeric_string:[1,3,1,""]},"mainCode.session.enlightSession":{clearAllSessions:[1,2,1,""],getSessionId:[1,2,1,""],getSessionMembers:[1,2,1,""],initConnection:[1,2,1,""],join:[1,2,1,""],leave:[1,2,1,""],lightSearcherDirectMain:[1,2,1,""],lightSearcherMain:[1,2,1,""],lighthouseMain:[1,2,1,""],serverMain:[1,2,1,""],stopSession:[1,2,1,""]},mainCode:{session:[1,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:function"},terms:{"class":1,"default":1,"int":1,"return":1,The:1,address:1,adress:1,all:1,alphanumer:1,between:1,bla:[],can:1,clear:1,clearallsess:1,client:1,comunc:1,connction:1,connect:1,dicoveri:1,direct:1,discoverd:1,discoveri:1,enlightsess:1,find:1,get:1,get_local_ip:1,get_random_alphanumeric_str:1,getsessionid:1,getsessionmemb:1,handler:1,host:1,index:1,initconnect:1,instanc:1,join:1,least:1,leav:1,length:1,lighthousemain:1,lightsearcherdirectmain:1,lightsearchermain:1,list:1,local:1,main:1,maincod:1,member:1,method:1,modul:1,name:1,need:1,noth:[],onli:[],option:[],output:1,page:1,passcod:1,password:[],pin:[],random:1,remot:1,role:1,search:1,second:1,secur:[],server:1,servermain:1,sessionid:1,set:[],start:1,stop:1,stopsess:1,string:1,support:1,take:1,test:[],thread:1,two:1,user:1},titles:["<no title>","Welcome to Enlight\u2019s documentation!"],titleterms:{document:1,enlight:1,indic:1,session:1,tabl:1,welcom:1}})

docs/source/conf.py

@@ -25,9 +25,9 @@ author = 'TheGreyDiamond'
 # -- General configuration ---------------------------------------------------
 
 # Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom   , 'sphinx.ext.napoleon'
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.napoleon']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.todo']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -41,9 +41,9 @@ exclude_patterns = []
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
+# a list of builtin themes.  alabaster
 #
-html_theme = 'alabaster'
+html_theme = 'insegel'
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/source/index.rst

@@ -20,4 +20,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
-* :ref:`search
+* :ref:`search`

mainCode/session.py

@@ -1,3 +1,9 @@
+'''
+session.py
+===============================
+The session support for Enlight
+'''
+
 import socket, time, threading, logging
 import random
 import string
@@ -15,7 +21,11 @@ ADMIN = 2
 VALID_ROLES = [HOST, USER, ADMIN]
 
 def get_local_ip(no = 0):
-    ''' Gets the local ip address '''
+    """
+    Gets the local ip address
+
+    :int no: ID of the ip adress
+    """
     s = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
     s.connect(("8.8.8.8", 80))
     ipAddr = s.getsockname()[no]
@@ -23,14 +33,23 @@ def get_local_ip(no = 0):
     return(ipAddr)
 
 def get_random_alphanumeric_string(length):
-    ''' Returns a randomly genrated alphanumeric string, with the length `length`  '''
+    """
+    Returns a random alphanumeric string
+
+    :int length: The length of the output string
+    """
     letters_and_digits = string.ascii_letters + string.digits
     result_str = ''.join((random.choice(letters_and_digits) for i in range(length)))
     return(result_str)
 
 class enlightSession():
-    ''' The main session class '''
+    """
-    def __init__(self, name = "", role = HOST, password = ""):
+    The main session class
+
+    :string name: The session name (not needed)
+    :string role: The role of the local instance (defaults to HOST, can be HOST or USER)
+    """
+    def __init__(self, name = "", role = HOST, passcode = ""):
         self.sessionName = name
         self.__activ__  = False
 
@@ -41,7 +60,7 @@ class enlightSession():
         self.sessionId = None
         self.__server__ = None
         self.__server_thread__ = None
-        self.sessionPassword = password
+        self.sessionpasscode = passcode
         self.members = []
         self.allowJoin = False
         self.__direct_socket__ = None
@@ -57,10 +76,10 @@ class enlightSession():
         
         self.__role__ = role
 
-        if(self.sessionPassword == ""):
+        if(self.sessionpasscode == ""):
-            self.passwordSet = "0"
+            self.passcodeSet = "0"
         else:
-            self.passwordSet = "1"
+            self.passcodeSet = "1"
 
         if(self.__role__ not in VALID_ROLES):
             self.__role__ = HOST
@@ -72,7 +91,9 @@ class enlightSession():
         
     
     def initConnection(self):
-        ''' Starts the main dicovery/connction method(s) '''
+        """
+        Starts the main dicovery/connction method(s)
+        """
         global USED_SESSION_IDS
         if(self.__role__ == HOST):
             self.sessionId = get_random_alphanumeric_string(24)
@@ -112,7 +133,9 @@ class enlightSession():
             
 
     def lightSearcherMain(self):
-        ''' The main thread for clients to connect '''
+        """
+        The main thread for clients to connect
+        """
         logging.info("Inbound connection handler started")
         self.__direct_socket__.listen()
         while self.allowJoin: 
@@ -127,6 +150,9 @@ class enlightSession():
         logging.info("Inbound connection handler stopped")
 
     def lightSearcherDirectMain(self):
+        """
+        The Handler for direct comuncation between HOST and USER
+        """
         while self.allowJoin: 
             try:
                 conn, addr = self.__direct_socket__.accept()
@@ -138,7 +164,9 @@ class enlightSession():
                 logging.warning("Client socket, failure. Session maybe not avaiable anymore?")
 
     def lighthouseMain(self):
-        ''' The main thread for searching/finding sessions '''
+        """
+        The main thread for searching/finding sessions
+        """
         while self.__activ__:
             try:
                 data, addr = self.__client__.recvfrom(1024)
@@ -160,17 +188,22 @@ class enlightSession():
                         logging.info("Found new session named " + proc[1])
 
     def clearAllSessions(self):
-        ''' Clears the sessionlist chace '''
+        """
+        Clears all discoverd sessions 
+        """
         if(self.__role__ != HOST):
             logging.info("Clearing all know session")
             self.allOnlineSessions = {}
 
     def serverMain(self):
+        """
+        Main Discovery server
+        """
         logging.info("Discovery server started")
         # Set a timeout so the socket does not block
         # indefinitely when trying to receive data.
         self.__server__.settimeout(0.2)
-        message = b"SESSION;" + self.sessionName.encode("utf-8") + b";" + self.sessionId.encode("utf-8") + b";"  + VERSION.encode("utf-8") + b";" + self.passwordSet.encode("utf-8") + b";" + str(len(self.members)).encode("utf-8") + b"|"
+        message = b"SESSION;" + self.sessionName.encode("utf-8") + b";" + self.sessionId.encode("utf-8") + b";"  + VERSION.encode("utf-8") + b";" + self.passcodeSet.encode("utf-8") + b";" + str(len(self.members)).encode("utf-8") + b"|"
 
         while self.allowJoin:
             ipChoped = get_local_ip().split(".")
@@ -182,7 +215,10 @@ class enlightSession():
         logging.info("Discovery server stopped")
 
     def getSessionMembers(self):
-        ''' Get all session members '''
+        """
+        Get all session members
+        :return: Returns a list of all members
+        """
         return(self.members)
     
     def getSessionId(self):