This commit is contained in:
2025-06-30 10:05:24 -04:00
parent ca24344d0e
commit 302acfa2de
56 changed files with 9315 additions and 0 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 0f161fac350c9b5b24226cb7390aeb22
tags: 62a1e7829a13fc7881b6498c52484ec0

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 825 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

View File

@@ -0,0 +1,906 @@
/*
* Sphinx stylesheet -- basic theme.
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin-top: 10px;
}
ul.search li {
padding: 5px 0;
}
ul.search li a {
font-weight: bold;
}
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a:visited {
color: #551A8B;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::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;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
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, figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
: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;
}
aside.footnote > span,
div.citation > span {
float: left;
}
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type: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 > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}
.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0 0.5em;
content: ":";
display: inline-block;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class*="highlight-"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}
div[class*="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
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;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
}
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 {
margin: 1em 0;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

View File

@@ -0,0 +1,149 @@
/*
* Base JavaScript utilities for all Sphinx HTML documentation.
*/
"use strict";
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
"TEXTAREA",
"INPUT",
"SELECT",
"BUTTON",
]);
const _ready = (callback) => {
if (document.readyState !== "loading") {
callback();
} else {
document.addEventListener("DOMContentLoaded", callback);
}
};
/**
* Small JavaScript module for the documentation.
*/
const Documentation = {
init: () => {
Documentation.initDomainIndexTable();
Documentation.initOnKeyListeners();
},
/**
* i18n support
*/
TRANSLATIONS: {},
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
LOCALE: "unknown",
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext: (string) => {
const translated = Documentation.TRANSLATIONS[string];
switch (typeof translated) {
case "undefined":
return string; // no translation
case "string":
return translated; // translation exists
default:
return translated[0]; // (singular, plural) translation tuple exists
}
},
ngettext: (singular, plural, n) => {
const translated = Documentation.TRANSLATIONS[singular];
if (typeof translated !== "undefined")
return translated[Documentation.PLURAL_EXPR(n)];
return n === 1 ? singular : plural;
},
addTranslations: (catalog) => {
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
Documentation.PLURAL_EXPR = new Function(
"n",
`return (${catalog.plural_expr})`
);
Documentation.LOCALE = catalog.locale;
},
/**
* helper function to focus on search bar
*/
focusSearchBar: () => {
document.querySelectorAll("input[name=q]")[0]?.focus();
},
/**
* Initialise the domain index toggle buttons
*/
initDomainIndexTable: () => {
const toggler = (el) => {
const idNumber = el.id.substr(7);
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
if (el.src.substr(-9) === "minus.png") {
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
toggledRows.forEach((el) => (el.style.display = "none"));
} else {
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
toggledRows.forEach((el) => (el.style.display = ""));
}
};
const togglerElements = document.querySelectorAll("img.toggler");
togglerElements.forEach((el) =>
el.addEventListener("click", (event) => toggler(event.currentTarget))
);
togglerElements.forEach((el) => (el.style.display = ""));
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
},
initOnKeyListeners: () => {
// only install a listener if it is really needed
if (
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
)
return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.altKey || event.ctrlKey || event.metaKey) return;
if (!event.shiftKey) {
switch (event.key) {
case "ArrowLeft":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const prevLink = document.querySelector('link[rel="prev"]');
if (prevLink && prevLink.href) {
window.location.href = prevLink.href;
event.preventDefault();
}
break;
case "ArrowRight":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const nextLink = document.querySelector('link[rel="next"]');
if (nextLink && nextLink.href) {
window.location.href = nextLink.href;
event.preventDefault();
}
break;
}
}
// some keyboard layouts may need Shift to get /
switch (event.key) {
case "/":
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
Documentation.focusSearchBar();
event.preventDefault();
}
});
},
};
// quick alias for translations
const _ = Documentation.gettext;
_ready(Documentation.init);

View File

@@ -0,0 +1,13 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '06-2025',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'simplepdf',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 829 KiB

View File

@@ -0,0 +1,192 @@
/*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*/
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
/* Non-minified version is copied as a separate JS file, if available */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}

View File

@@ -0,0 +1,927 @@
@charset "UTF-8";
@font-face {
font-family: Work Sans Bold;
font-weight: bold;
src: url(fonts/WorkSans-Bold.ttf); }
@font-face {
font-family: Work Sans Bold;
font-weight: 400;
src: url(fonts/WorkSans-SemiBold.ttf); }
@font-face {
font-family: Work Sans;
font-weight: 400;
src: url(fonts/WorkSans-Regular.ttf); }
@font-face {
font-family: Fira Sans;
font-weight: 400;
src: url(fonts/FiraSans-Regular.otf); }
@font-face {
font-family: Fira Sans;
font-style: italic;
font-weight: 400;
src: url(fonts/FiraSans-Italic.otf); }
@font-face {
font-family: Fira Sans;
font-weight: 300;
src: url(fonts/FiraSans-Light.otf); }
@font-face {
font-family: Fira Sans;
font-style: italic;
font-weight: 300;
src: url(fonts/FiraSans-LightItalic.otf); }
@font-face {
font-family: Fira Sans;
font-weight: bold;
src: url(fonts/FiraSans-Bold.otf); }
@font-face {
font-family: fontawesome-webfont;
src: url("fonts/fa-solid-900.eot");
src: url("fonts/fa-solid-900.eot?#iefix") format("embedded-opentype"), url("fonts/fa-solid-900.ttf") format("truetype"), url("fonts/fa-solid-900.svg#fontawesome-webfont") format("svg"); }
@font-face {
font-family: monospace;
src: url(fonts/FiraMono-Regular.ttf); }
@font-face {
font-family: monospace;
font-weight: 400;
src: url(fonts/FiraMono-Medium.ttf); }
@font-face {
font-family: monospace;
font-weight: bold;
src: url(fonts/FiraMono-Bold.ttf); }
ul, ol {
padding-left: 15px; }
ul ul, ul ol, ol ul, ol ol {
padding-left: 20px; }
dl dt {
font-weight: bold; }
dl.option-list, dl.field-list {
display: flex;
flex-wrap: wrap; }
dl.option-list dt, dl.field-list dt {
padding-right: 15px;
flex: 0 0 33%;
max-width: 33%;
font-weight: normal; }
dl.option-list dd, dl.field-list dd {
margin-left: 0;
padding-left: 15px;
flex: 0 0 66%;
max-width: 66%; }
dl.field-list dt, dl.field-list dd {
padding-top: .5em;
padding-bottom: .5em; }
.hlist ul {
list-style: none; }
table.break {
page-break-before: always; }
table.ssp-table-wrap {
table-layout: fixed; }
table.ssp-table-wrap td, table.ssp-table-wrap th {
overflow-wrap: break-word; }
table.docutils {
width: 100%;
max-width: 100%;
margin-bottom: 1rem;
background-color: transparent;
border-spacing: 0; }
table.docutils td, table.docutils th {
padding: .75rem;
vertical-align: top; }
table.docutils thead th {
vertical-align: bottom;
border-bottom: 2px solid #dee2e6;
background: #F0F0F0;
border-top: 1px solid #dee2e6; }
table.docutils tbody tr.row-odd {
background: #f6f6f6; }
table.docutils tbody tr td {
display: table-cell;
font-weight: normal !important; }
table.docutils tbody tr * {
border: 0; }
table.docutils.ssp-tinier td, table.docutils.ssp-tinier th {
padding: .4rem;
vertical-align: top;
font-size: 0.75em; }
table.docutils.ssp-tiny td, table.docutils.ssp-tiny th {
padding: .05rem;
vertical-align: top;
font-size: 0.5em; }
div.topic {
border: 0;
padding: 0; }
.alert {
position: relative;
padding: 0.75rem 1.25rem;
margin-bottom: 1rem;
border: 1px solid transparent;
border-radius: 0.25rem; }
.alert-heading {
color: inherit; }
.alert-link {
font-weight: 700; }
.alert-dismissible {
padding-right: 4rem; }
.alert-dismissible .close {
position: absolute;
top: 0;
right: 0;
padding: 0.75rem 1.25rem;
color: inherit; }
.alert-primary {
color: #004085;
background-color: #cce5ff;
border-color: #b8daff; }
.alert-primary hr {
border-top-color: #9fcdff; }
.alert-primary .alert-link {
color: #002752; }
.alert-secondary {
color: #383d41;
background-color: #e2e3e5;
border-color: #d6d8db; }
.alert-secondary hr {
border-top-color: #c8cbcf; }
.alert-secondary .alert-link {
color: #202326; }
.alert-success {
color: #155724;
background-color: #d4edda;
border-color: #c3e6cb; }
.alert-success hr {
border-top-color: #b1dfbb; }
.alert-success .alert-link {
color: #0b2e13; }
.alert-info {
color: #0c5460;
background-color: #d1ecf1;
border-color: #bee5eb; }
.alert-info hr {
border-top-color: #abdde5; }
.alert-info .alert-link {
color: #062c33; }
.alert-warning {
color: #856404;
background-color: #fff3cd;
border-color: #ffeeba; }
.alert-warning hr {
border-top-color: #ffe8a1; }
.alert-warning .alert-link {
color: #533f03; }
.alert-danger {
color: #721c24;
background-color: #f8d7da;
border-color: #f5c6cb; }
.alert-danger hr {
border-top-color: #f1b0b7; }
.alert-danger .alert-link {
color: #491217; }
.alert-light {
color: #818182;
background-color: #fefefe;
border-color: #fdfdfe; }
.alert-light hr {
border-top-color: #ececf6; }
.alert-light .alert-link {
color: #686868; }
.alert-dark {
color: #1b1e21;
background-color: #d6d8d9;
border-color: #c6c8ca; }
.alert-dark hr {
border-top-color: #b9bbbe; }
.alert-dark .alert-link {
color: #040505; }
dl.class dt, dl.type dt, dl.function dt, dl.member dt, dl.var dt, dl.enum dt, dl.enum-class dt, dl.enum-struct dt, dl.method dt {
text-align: left; }
dl.class > dt, dl.type > dt, dl.function > dt, dl.member > dt, dl.var > dt, dl.enum > dt, dl.enum-class > dt, dl.enum-struct > dt, dl.method > dt {
font-weight: normal; }
dl.class em.property, dl.type em.property, dl.function em.property, dl.member em.property, dl.var em.property, dl.enum em.property, dl.enum-class em.property, dl.enum-struct em.property, dl.method em.property {
font-weight: bold;
color: #007020; }
dl.class em.sig-param, dl.type em.sig-param, dl.function em.sig-param, dl.member em.sig-param, dl.var em.sig-param, dl.enum em.sig-param, dl.enum-class em.sig-param, dl.enum-struct em.sig-param, dl.method em.sig-param {
color: #007020; }
dl.class code.sig-prename, dl.type code.sig-prename, dl.function code.sig-prename, dl.member code.sig-prename, dl.var code.sig-prename, dl.enum code.sig-prename, dl.enum-class code.sig-prename, dl.enum-struct code.sig-prename, dl.method code.sig-prename {
font-weight: bold;
color: #4070a0; }
dl.class code.sig-name, dl.type code.sig-name, dl.function code.sig-name, dl.member code.sig-name, dl.var code.sig-name, dl.enum code.sig-name, dl.enum-class code.sig-name, dl.enum-struct code.sig-name, dl.method code.sig-name {
color: #0e84b5; }
dl.class dl.field-list, dl.type dl.field-list, dl.function dl.field-list, dl.member dl.field-list, dl.var dl.field-list, dl.enum dl.field-list, dl.enum-class dl.field-list, dl.enum-struct dl.field-list, dl.method dl.field-list {
display: block; }
dl.class dl.field-list dt, dl.class dl.field-list dd, dl.type dl.field-list dt, dl.type dl.field-list dd, dl.function dl.field-list dt, dl.function dl.field-list dd, dl.member dl.field-list dt, dl.member dl.field-list dd, dl.var dl.field-list dt, dl.var dl.field-list dd, dl.enum dl.field-list dt, dl.enum dl.field-list dd, dl.enum-class dl.field-list dt, dl.enum-class dl.field-list dd, dl.enum-struct dl.field-list dt, dl.enum-struct dl.field-list dd, dl.method dl.field-list dt, dl.method dl.field-list dd {
padding-left: 0; }
.contents ul {
list-style: none; }
.contents > ul {
padding-left: 0; }
.contents > ul > li {
font-weight: 500;
line-height: 15pt;
margin: 3em 0 1em; }
.contents > ul > li::before {
background: #1A961A;
color: #ffffff;
content: "";
display: block;
height: 0.08cm;
margin-bottom: 0.25cm;
width: 2cm; }
.contents > ul > li a {
color: #000000;
font-size: 15pt; }
.contents > ul > li a::after {
color: #1A961A;
content: target-counter(attr(href url), page);
float: right; }
.contents > ul > li > ul {
list-style: none;
padding-left: 0; }
.contents > ul > li > ul li {
border-top: 0.3pt solid #c1c1c1;
margin: 0.25cm 0;
padding-top: 0.25cm;
line-height: 12pt;
font-weight: 300; }
.contents > ul > li > ul li a {
color: #000000;
font-size: 12pt; }
.contents > ul > li > ul li p::before {
color: #1A961A;
content: "• ";
font-size: 40pt;
line-height: 16pt;
vertical-align: bottom; }
.contents > ul > li > ul li ul {
padding-left: 2em; }
.sphinxsidebarwrapper {
page-break-before: always; }
.sphinxsidebarwrapper div ul {
list-style: none; }
.sphinxsidebarwrapper div > ul {
padding-left: 0; }
.sphinxsidebarwrapper div > ul > li {
font-weight: 500;
line-height: 12pt;
margin: 2em 0 1em; }
.sphinxsidebarwrapper div > ul > li a {
color: #000000;
font-size: 13pt; }
.sphinxsidebarwrapper div > ul > li a::after {
color: #1A961A;
content: target-counter(attr(href url), page);
float: right; }
.sphinxsidebarwrapper div > ul > li > ul {
list-style: none;
padding-left: 0; }
.sphinxsidebarwrapper div > ul > li > ul li {
border-top: 0.3pt solid #c1c1c1;
margin: 0.15cm 0;
padding-top: 0.15cm;
line-height: 10pt;
font-weight: 300; }
.sphinxsidebarwrapper div > ul > li > ul li a {
color: #000000;
font-size: 12pt; }
.sphinxsidebarwrapper div > ul > li > ul li a::before {
color: #1A961A;
content: "• ";
font-size: 30pt;
line-height: 10pt;
vertical-align: bottom; }
.sphinxsidebarwrapper div > ul > li > ul li ul {
padding-left: 2em; }
.dont-break {
page-break-inside: avoid; }
.break-before {
page-break-before: always; }
.break-after {
page-break-after: always; }
#back-cover {
page: back_cover;
page-break-before: always; }
@page landscape_page {
size: landscape; }
@page portrait_page {
size: portrait; }
.ssp-portrait {
page: portrait_page; }
.ssp-landscape {
page: landscape_page; }
@page {
padding-top: 1em;
@top-left {
background: #1A961A;
color: #ffffff;
content: counter(page);
height: 1cm;
text-align: center;
width: 1cm; }
@top-center {
font-size: 9pt;
height: 1cm;
text-align: center;
vertical-align: middle;
width: 100%;
border-bottom-color: rgba(26, 150, 26, 0.8);
border-bottom-style: solid;
border-bottom-width: 0.05cm; }
@top-right {
content: string(heading);
font-size: 9pt;
height: 1cm;
text-align: right;
vertical-align: middle;
width: 100%;
border-bottom-color: rgba(26, 150, 26, 0.8);
border-bottom-style: solid;
border-bottom-width: 0.05cm; }
@bottom-left {
text-align: left;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
border-top-color: rgba(26, 150, 26, 0.8);
border-top-style: solid;
border-top-width: 0.05cm;
margin-top: 3px;
position: absolute;
bottom: 30pt; }
@bottom-center {
content: "Getting RC onn the road";
text-align: center;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
border-top-color: rgba(26, 150, 26, 0.8);
border-top-style: solid;
border-top-width: 0.05cm;
margin-top: 3px;
position: absolute;
bottom: 30pt; }
@bottom-right {
content: "Alexander B.";
text-align: right;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
margin-top: 3px;
position: absolute;
bottom: 30pt;
border-top-color: rgba(26, 150, 26, 0.8);
border-top-style: solid;
border-top-width: 0.05cm; } }
@page :blank {
@top-left {
background: none;
content: ""; }
@top-center {
content: none; }
@top-right {
content: none; } }
@page no-chapter {
@top-left {
background: none;
content: none; }
@top-center {
content: none; }
@top-right {
content: none; } }
@page :first {
background: url(ESP32C3_Breadboard-Adapter.jpg) no-repeat center;
background-size: cover;
margin: 0; }
@media screen {
#cover {
background: url(ESP32C3_Breadboard-Adapter.jpg) no-repeat center;
background-size: cover;
margin: 0; } }
@page chapter {
background: #1A961A;
color: #ffffff;
margin: 0;
@top-left {
content: none; }
@top-center {
content: none; }
@top-right {
content: none; } }
@page back_cover {
background: url(ESP32C3_Breadboard-Adapter.jpg) no-repeat center;
background-size: cover;
margin: 0;
color: #ffffff; }
@page back_cover {
@bottom-right {
content: none; }
@top-left {
background: none;
content: ''; }
@top-center {
content: none; }
@top-right {
content: none; } }
#cover {
width: 100%;
align-content: space-between;
display: flex;
flex-wrap: wrap;
height: 297mm;
background: url(ESP32C3_Breadboard-Adapter.jpg) no-repeat center;
background-size: cover;
margin: 0; }
#cover h1 {
font-family: "Work Sans", sans-serif;
color: #1A961A;
font-size: 38pt;
margin: 5cm 2cm 0 2cm;
page: no-chapter;
width: 100%; }
#cover a {
color: #ffffff;
font-weight: bolder; }
#cover .container {
width: 100%;
top: 0;
background: rgba(0,0,0,0); }
#cover .container .logo {
font-size: 24pt;
color: #ffffff;
width: 200px;
height: 45px;
position: absolute;
text-align: right;
top: 40pt;
right: 20pt; }
#cover .container .logo p {
margin: auto; }
#cover .container .cover-middle {
position: relative;
top: 40%;
width: 100%; }
#cover .container .cover-middle .title {
position: absolute;
top: 5pt;
left: 40pt;
height: 150pt; }
#cover .container .cover-middle .title .title-cover {
font-family: "Work Sans Bold", sans-serif;
font-size: 45pt;
margin-bottom: 0;
margin-top: 0;
margin-left: 0;
color: #ffffff; }
#cover .container .cover-middle .title .subtitle-cover {
font-family: "Work Sans Bold", sans-serif;
font-weight: bolder;
font-size: 28pt;
margin-top: 5pt;
color: #ffffff; }
#cover .container .cover-middle .title .meta {
font-family: 'Work Sans';
font-size: 18pt;
margin-top: 12pt;
margin-bottom: 0;
color: #ffffff; }
#cover .container .cover-middle .client-logo {
position: absolute;
border-radius: 8pt;
border: 4px solid white;
background-color: white;
top: 20pt;
right: 40pt;
float: right;
height: 150px;
width: 150px; }
#cover .container .cover-middle .client-logo img {
width: 150px;
height: 150px; }
#cover .container .cover-footer {
font-family: 'Work Sans';
font-size: 11pt;
margin-top: 3px;
position: absolute;
bottom: 30pt;
color: #ffffff;
width: 100%; }
#cover .container .cover-footer p {
width: 80%;
margin: 0 auto;
text-align: center; }
#back-cover {
width: 100%;
height: 100%; }
#back-cover .container {
width: 100%; }
#back-cover .container .back-cover-footer {
font-family: 'Helvetica Neue';
font-size: 11pt;
margin-top: 3px;
position: absolute;
bottom: 30pt;
color: #ffffff;
width: 100%; }
#back-cover .container .back-cover-footer p {
width: 80%;
margin: 0 auto;
text-align: center; }
#back-cover .container .back-cover-footer p a {
color: #ffffff; }
.badge {
display: inline-block;
padding: .25em .4em;
font-size: 75%;
font-weight: 700;
line-height: 1;
text-align: center;
white-space: nowrap;
vertical-align: baseline;
border-radius: .25rem; }
.text-white {
color: #fff !important; }
.text-primary {
color: #007bff !important; }
a {
color: #790000;
text-decoration: none; }
a.text-primary:hover, a.text-primary:focus {
color: #0056b3 !important; }
.text-secondary {
color: #6c757d !important; }
a.text-secondary:hover, a.text-secondary:focus {
color: #494f54 !important; }
.text-success {
color: #28a745 !important; }
a.text-success:hover, a.text-success:focus {
color: #19692c !important; }
.text-info {
color: #17a2b8 !important; }
a.text-info:hover, a.text-info:focus {
color: #0f6674 !important; }
.text-warning {
color: #ffc107 !important; }
a.text-warning:hover, a.text-warning:focus {
color: #ba8b00 !important; }
.text-danger {
color: #dc3545 !important; }
a.text-danger:hover, a.text-danger:focus {
color: #a71d2a !important; }
.text-light {
color: #f8f9fa !important; }
a.text-light:hover, a.text-light:focus {
color: #cbd3da !important; }
.text-dark {
color: #343a40 !important; }
a.text-dark:hover, a.text-dark:focus {
color: #121416 !important; }
.text-body {
color: #212529 !important; }
.text-muted {
color: #6c757d !important; }
.text-black-50 {
color: rgba(0, 0, 0, 0.5) !important; }
.text-white-50 {
color: rgba(255, 255, 255, 0.5) !important; }
.text-hide {
font: 0/0 a;
color: transparent;
text-shadow: none;
background-color: transparent;
border: 0; }
.text-decoration-none {
text-decoration: none !important; }
.square-brackets-quote {
border: solid 1em #ccc;
margin: 0;
padding: 1em;
position: relative;
max-width: 100%; }
.square-brackets-quote:before {
background-color: white;
bottom: -1em;
content: "";
left: 2em;
position: absolute;
right: 2em;
top: -1em; }
.square-brackets-quote cite {
color: #757575;
display: block;
font-size: small;
font-style: normal;
text-align: right;
text-transform: uppercase; }
.square-brackets-quote > * {
position: relative;
z-index: 1; }
.body {
text-align: justify; }
.body pre, .body h1, .body h2, .body h3, .body h4, .body h5, .body h6 {
text-align: left; }
a.download code.download.literal.notranslate {
color: #083764;
background-color: transparent;
font-family: inherit; }
a.download code.download.literal.notranslate:before {
display: inline-block;
font-family: fontawesome-webfont;
content: "\f019";
font-style: normal;
font-weight: normal;
line-height: 1;
text-decoration: inherit;
margin-right: 2px; }
.admonition {
padding: 12px;
line-height: 24px;
margin-bottom: 24px;
background: #e7f2fa; }
.admonition .admonition-title {
color: #fff;
font-weight: bold;
display: block;
margin: -6px;
padding: 6px 12px;
margin-bottom: 12px;
background: #6ab0de; }
.admonition .admonition-title:before {
display: inline-block;
font-family: fontawesome-webfont;
content: "\f06a";
font-style: normal;
font-weight: normal;
line-height: 1;
text-decoration: inherit;
margin-right: 4px; }
.admonition.attention, .admonition.caution, .admonition.warning {
background: #ffedcc; }
.admonition.attention .admonition-title, .admonition.caution .admonition-title, .admonition.warning .admonition-title {
background: #f0b37e; }
.admonition.attention .admonition-title:before, .admonition.caution .admonition-title:before, .admonition.warning .admonition-title:before {
content: "\f071"; }
.admonition.danger, .admonition.error {
background: #fdf3f2; }
.admonition.danger .admonition-title, .admonition.error .admonition-title {
background: #f29f97; }
.admonition.danger .admonition-title:before, .admonition.error .admonition-title:before {
content: "\f7b9"; }
.admonition.hint, .admonition.important {
background: #dbfaf4; }
.admonition.hint .admonition-title, .admonition.important .admonition-title {
background: #1abc9c; }
.admonition.hint .admonition-title:before, .admonition.note .admonition-title:before {
content: "\f05a"; }
dl.head, dl.get, dl.post, dl.put, dl.delete, dl.patch, dl.options, dl.trace, dl.connect, dl.copy, dl.any {
break-before: auto;
break-after: auto;
break-inside: auto; }
dl.head > dd > dl.field-list, dl.get > dd > dl.field-list, dl.post > dd > dl.field-list, dl.put > dd > dl.field-list, dl.delete > dd > dl.field-list, dl.patch > dd > dl.field-list, dl.options > dd > dl.field-list, dl.trace > dd > dl.field-list, dl.connect > dd > dl.field-list, dl.copy > dd > dl.field-list, dl.any > dd > dl.field-list {
display: block; }
dl.head > dd > dl.field-list > *, dl.get > dd > dl.field-list > *, dl.post > dd > dl.field-list > *, dl.put > dd > dl.field-list > *, dl.delete > dd > dl.field-list > *, dl.patch > dd > dl.field-list > *, dl.options > dd > dl.field-list > *, dl.trace > dd > dl.field-list > *, dl.connect > dd > dl.field-list > *, dl.copy > dd > dl.field-list > *, dl.any > dd > dl.field-list > * {
flex-basis: unset;
padding-left: 0; }
dl.head > dt, dl.get > dt, dl.post > dt, dl.put > dt, dl.delete > dt, dl.patch > dt, dl.options > dt, dl.trace > dt, dl.connect > dt, dl.copy > dt, dl.any > dt {
margin-bottom: 1em; }
dl.head > dd, dl.get > dd, dl.post > dd, dl.put > dd, dl.delete > dd, dl.patch > dd, dl.options > dd, dl.trace > dd, dl.connect > dd, dl.copy > dd, dl.any > dd {
margin-left: 0; }
dl.head > dd > p > strong, dl.get > dd > p > strong, dl.post > dd > p > strong, dl.put > dd > p > strong, dl.delete > dd > p > strong, dl.patch > dd > p > strong, dl.options > dd > p > strong, dl.trace > dd > p > strong, dl.connect > dd > p > strong, dl.copy > dd > p > strong, dl.any > dd > p > strong {
font-weight: normal; }
dl.head span.sig-paren, dl.head em.property, dl.head em.sig-param, dl.get span.sig-paren, dl.get em.property, dl.get em.sig-param, dl.post span.sig-paren, dl.post em.property, dl.post em.sig-param, dl.put span.sig-paren, dl.put em.property, dl.put em.sig-param, dl.delete span.sig-paren, dl.delete em.property, dl.delete em.sig-param, dl.patch span.sig-paren, dl.patch em.property, dl.patch em.sig-param, dl.options span.sig-paren, dl.options em.property, dl.options em.sig-param, dl.trace span.sig-paren, dl.trace em.property, dl.trace em.sig-param, dl.connect span.sig-paren, dl.connect em.property, dl.connect em.sig-param, dl.copy span.sig-paren, dl.copy em.property, dl.copy em.sig-param, dl.any span.sig-paren, dl.any em.property, dl.any em.sig-param {
font-weight: normal; }
dl.head code.descname:first-child, dl.get code.descname:first-child, dl.post code.descname:first-child, dl.put code.descname:first-child, dl.delete code.descname:first-child, dl.patch code.descname:first-child, dl.options code.descname:first-child, dl.trace code.descname:first-child, dl.connect code.descname:first-child, dl.copy code.descname:first-child, dl.any code.descname:first-child {
font-size: 0.9em;
background-color: #337ab7;
color: white;
display: inline-block;
padding-left: 5px;
padding-right: 5px;
margin-right: 10px; }
dl.head.get code.descname:first-child, dl.get.get code.descname:first-child, dl.post.get code.descname:first-child, dl.put.get code.descname:first-child, dl.delete.get code.descname:first-child, dl.patch.get code.descname:first-child, dl.options.get code.descname:first-child, dl.trace.get code.descname:first-child, dl.connect.get code.descname:first-child, dl.copy.get code.descname:first-child, dl.any.get code.descname:first-child {
background-color: #61AFFE; }
dl.head.post code.descname:first-child, dl.get.post code.descname:first-child, dl.post.post code.descname:first-child, dl.put.post code.descname:first-child, dl.delete.post code.descname:first-child, dl.patch.post code.descname:first-child, dl.options.post code.descname:first-child, dl.trace.post code.descname:first-child, dl.connect.post code.descname:first-child, dl.copy.post code.descname:first-child, dl.any.post code.descname:first-child {
background-color: #49CC90; }
dl.head.put code.descname:first-child, dl.get.put code.descname:first-child, dl.post.put code.descname:first-child, dl.put.put code.descname:first-child, dl.delete.put code.descname:first-child, dl.patch.put code.descname:first-child, dl.options.put code.descname:first-child, dl.trace.put code.descname:first-child, dl.connect.put code.descname:first-child, dl.copy.put code.descname:first-child, dl.any.put code.descname:first-child {
background-color: #FCA130; }
dl.head.patch code.descname:first-child, dl.get.patch code.descname:first-child, dl.post.patch code.descname:first-child, dl.put.patch code.descname:first-child, dl.delete.patch code.descname:first-child, dl.patch.patch code.descname:first-child, dl.options.patch code.descname:first-child, dl.trace.patch code.descname:first-child, dl.connect.patch code.descname:first-child, dl.copy.patch code.descname:first-child, dl.any.patch code.descname:first-child {
background-color: #50E3C2; }
dl.head.delete code.descname:first-child, dl.get.delete code.descname:first-child, dl.post.delete code.descname:first-child, dl.put.delete code.descname:first-child, dl.delete.delete code.descname:first-child, dl.patch.delete code.descname:first-child, dl.options.delete code.descname:first-child, dl.trace.delete code.descname:first-child, dl.connect.delete code.descname:first-child, dl.copy.delete code.descname:first-child, dl.any.delete code.descname:first-child {
background-color: #F93E3E; }
.needs_style_break {
page-break-before: always; }
table.need, table.NEEDS_DATATABLES, .needs_style_ssp-table-wrap {
table-layout: fixed; }
table.need td, table.need th, table.NEEDS_DATATABLES td, table.NEEDS_DATATABLES th, .needs_style_ssp-table-wrap td, .needs_style_ssp-table-wrap th {
overflow-wrap: break-word; }
body div.body {
min-width: unset;
max-width: unset; }
.docutils th.field-name {
display: table-row; }
.docutils td {
display: none; }
.docutils td.field-body {
display: table-row;
padding-top: 1em; }
.docutils td.field-body ul {
margin-left: 1em;
margin-bottom: 1em; }
body {
margin: 0; }
.highlight-default {
margin-top: 0.5em; }
.highlight pre {
padding: 1em;
white-space: -o-pre-wrap;
word-wrap: break-word;
white-space: pre-wrap; }
.headerlink {
display: none; }
html {
color: #393939;
font-family: Fira Sans;
font-size: 11pt;
font-weight: 300;
line-height: 1.5; }
html body h1 {
color: #1A961A;
font-size: 30pt;
page-break-before: always; }
html body h2, html body h3, html body h4 {
color: black;
font-weight: 400; }
html body h2 {
page-break-before: always;
font-size: 28pt;
string-set: heading content(); }
html body h3 {
font-weight: 300;
font-size: 20pt; }
html body h4 {
font-size: 16pt; }
html body h5 {
font-size: 15pt;
font-weight: 100; }
html body h6 {
font-size: 13pt;
font-weight: 100; }
html body section h5 {
margin-bottom: 1pt; }
html body section p {
margin-top: 0; }
html body h5, html body h6 {
margin-bottom: 0;
padding-bottom: 0; }
.alert i {
margin-right: 6pt; }
.is-marginless {
margin: 0 !important; }
.is-paddingless {
padding: 0 !important; }
.charts-inline {
columns: 2;
column-fill: balance; }
.img-fluid {
max-width: 100%;
height: auto; }
img {
max-width: 100%;
height: auto; }
.big-stats {
font-size: 23pt; }
.docutils.literal.notranslate {
hyphens: none;
color: #552977;
background-color: #f1f1f1;
font-size: 9pt;
display: inline-block;
padding: 1pt 3pt; }

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

View File

@@ -0,0 +1,75 @@
pre { line-height: 125%; }
td.linenos .normal { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: #666666; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f0f0f0; }
.highlight .c { color: #60A0B0; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #F00 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666 } /* Operator */
.highlight .ch { color: #60A0B0; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #60A0B0; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .cpf { color: #60A0B0; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #60A0B0; font-style: italic } /* Comment.Single */
.highlight .cs { color: #60A0B0; background-color: #FFF0F0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #F00 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888 } /* Generic.Output */
.highlight .gp { color: #C65D09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #04D } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #40A070 } /* Literal.Number */
.highlight .s { color: #4070A0 } /* Literal.String */
.highlight .na { color: #4070A0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0E84B5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60ADD5 } /* Name.Constant */
.highlight .nd { color: #555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #D55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287E } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0E84B5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #BB60D5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #BBB } /* Text.Whitespace */
.highlight .mb { color: #40A070 } /* Literal.Number.Bin */
.highlight .mf { color: #40A070 } /* Literal.Number.Float */
.highlight .mh { color: #40A070 } /* Literal.Number.Hex */
.highlight .mi { color: #40A070 } /* Literal.Number.Integer */
.highlight .mo { color: #40A070 } /* Literal.Number.Oct */
.highlight .sa { color: #4070A0 } /* Literal.String.Affix */
.highlight .sb { color: #4070A0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070A0 } /* Literal.String.Char */
.highlight .dl { color: #4070A0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070A0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070A0 } /* Literal.String.Double */
.highlight .se { color: #4070A0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070A0 } /* Literal.String.Heredoc */
.highlight .si { color: #70A0D0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #C65D09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070A0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06287E } /* Name.Function.Magic */
.highlight .vc { color: #BB60D5 } /* Name.Variable.Class */
.highlight .vg { color: #BB60D5 } /* Name.Variable.Global */
.highlight .vi { color: #BB60D5 } /* Name.Variable.Instance */
.highlight .vm { color: #BB60D5 } /* Name.Variable.Magic */
.highlight .il { color: #40A070 } /* Literal.Number.Integer.Long */

View File

@@ -0,0 +1,635 @@
/*
* Sphinx JavaScript utilities for the full-text search.
*/
"use strict";
/**
* Simple result scoring code.
*/
if (typeof Scorer === "undefined") {
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [docname, title, anchor, descr, score, filename]
// and returns the new score.
/*
score: result => {
const [docname, title, anchor, descr, score, filename, kind] = result
return score
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {
0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5, // used to be unimportantResults
},
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2,
};
}
// Global search result kind enum, used by themes to style search results.
class SearchResultKind {
static get index() { return "index"; }
static get object() { return "object"; }
static get text() { return "text"; }
static get title() { return "title"; }
}
const _removeChildren = (element) => {
while (element && element.lastChild) element.removeChild(element.lastChild);
};
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
*/
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename, kind] = item;
let listItem = document.createElement("li");
// Add a class representing the item's type:
// can be used by a theme's CSS selector for styling
// See SearchResultKind for the class names.
listItem.classList.add(`kind-${kind}`);
let requestUrl;
let linkUrl;
if (docBuilder === "dirhtml") {
// dirhtml builder
let dirname = docName + "/";
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
.then((data) => {
if (data)
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms, anchor)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
const _finishSearch = (resultCount) => {
Search.stopPulse();
Search.title.innerText = _("Search Results");
if (!resultCount)
Search.status.innerText = Documentation.gettext(
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
);
else
Search.status.innerText = Documentation.ngettext(
"Search finished, found one page matching the search query.",
"Search finished, found ${resultCount} pages matching the search query.",
resultCount,
).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
results,
resultCount,
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
// search finished, update title and status message
else _finishSearch(resultCount);
};
// Helper function used by query() to order search results.
// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
// Order the results by score (in opposite order of appearance, since the
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
const _orderResultsByScoreThenName = (a, b) => {
const leftScore = a[4];
const rightScore = b[4];
if (leftScore === rightScore) {
// same score: sort alphabetically
const leftTitle = a[1].toLowerCase();
const rightTitle = b[1].toLowerCase();
if (leftTitle === rightTitle) return 0;
return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
}
return leftScore > rightScore ? 1 : -1;
};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
* custom function per language.
*
* The regular expression works by splitting the string on consecutive characters
* that are not Unicode letters, numbers, underscores, or emoji characters.
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
*/
if (typeof splitQuery === "undefined") {
var splitQuery = (query) => query
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
.filter(term => term) // remove remaining empty strings
}
/**
* Search Module
*/
const Search = {
_index: null,
_queued_query: null,
_pulse_status: -1,
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
if (anchorContent) return anchorContent.textContent;
console.warn(
`Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
);
}
// if anchor not specified or not found, fall back to main content
const docContent = htmlElement.querySelector('[role="main"]');
if (docContent) return docContent.textContent;
console.warn(
"Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
);
return "";
},
init: () => {
const query = new URLSearchParams(window.location.search).get("q");
document
.querySelectorAll('input[name="q"]')
.forEach((el) => (el.value = query));
if (query) Search.performSearch(query);
},
loadIndex: (url) =>
(document.body.appendChild(document.createElement("script")).src = url),
setIndex: (index) => {
Search._index = index;
if (Search._queued_query !== null) {
const query = Search._queued_query;
Search._queued_query = null;
Search.query(query);
}
},
hasIndex: () => Search._index !== null,
deferQuery: (query) => (Search._queued_query = query),
stopPulse: () => (Search._pulse_status = -1),
startPulse: () => {
if (Search._pulse_status >= 0) return;
const pulse = () => {
Search._pulse_status = (Search._pulse_status + 1) % 4;
Search.dots.innerText = ".".repeat(Search._pulse_status);
if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch: (query) => {
// create the required interface elements
const searchText = document.createElement("h2");
searchText.textContent = _("Searching");
const searchSummary = document.createElement("p");
searchSummary.classList.add("search-summary");
searchSummary.innerText = "";
const searchList = document.createElement("ul");
searchList.setAttribute("role", "list");
searchList.classList.add("search");
const out = document.getElementById("search-results");
Search.title = out.appendChild(searchText);
Search.dots = Search.title.appendChild(document.createElement("span"));
Search.status = out.appendChild(searchSummary);
Search.output = out.appendChild(searchList);
const searchProgress = document.getElementById("search-progress");
// Some themes don't use the search progress node
if (searchProgress) {
searchProgress.innerText = _("Preparing search...");
}
Search.startPulse();
// index already loaded, the browser was quick!
if (Search.hasIndex()) Search.query(query);
else Search.deferQuery(query);
},
_parseQuery: (query) => {
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
const excludedTerms = new Set();
const highlightTerms = new Set();
const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
splitQuery(query.trim()).forEach((queryTerm) => {
const queryTermLower = queryTerm.toLowerCase();
// maybe skip this "word"
// stopwords array is from language_data.js
if (
stopwords.indexOf(queryTermLower) !== -1 ||
queryTerm.match(/^\d+$/)
)
return;
// stem the word
let word = stemmer.stemWord(queryTermLower);
// select the correct list
if (word[0] === "-") excludedTerms.add(word.substr(1));
else {
searchTerms.add(word);
highlightTerms.add(queryTermLower);
}
});
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
}
// console.debug("SEARCH: searching for:");
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
},
/**
* execute search (requires search index to be loaded)
*/
_performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const allTitles = Search._index.alltitles;
const indexEntries = Search._index.indexentries;
// Collect multiple result groups to be sorted separately and then ordered.
// Each is an array of [docname, title, anchor, descr, score, filename, kind].
const normalResults = [];
const nonMainIndexResults = [];
_removeChildren(document.getElementById("search-progress"));
const queryLower = query.toLowerCase().trim();
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score + boost,
filenames[file],
SearchResultKind.title,
]);
}
}
}
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
for (const [file, id, isMain] of foundEntries) {
const score = Math.round(100 * queryLower.length / entry.length);
const result = [
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
SearchResultKind.index,
];
if (isMain) {
normalResults.push(result);
} else {
nonMainIndexResults.push(result);
}
}
}
}
// lookup as object
objectTerms.forEach((term) =>
normalResults.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
normalResults.forEach((item) => (item[4] = Scorer.score(item)));
nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
}
// Sort each group of results by score and then alphabetically by name.
normalResults.sort(_orderResultsByScoreThenName);
nonMainIndexResults.sort(_orderResultsByScoreThenName);
// Combine the result groups in (reverse) order.
// Non-main index entries are typically arbitrary cross-references,
// so display them after other results.
let results = [...nonMainIndexResults, ...normalResults];
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
let seen = new Set();
results = results.reverse().reduce((acc, result) => {
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
if (!seen.has(resultStr)) {
acc.push(result);
seen.add(resultStr);
}
return acc;
}, []);
return results.reverse();
},
query: (query) => {
const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
// for debugging
//Search.lastresults = results.slice(); // a copy
// console.info("search results:", Search.lastresults);
// print the results
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},
/**
* search for object names
*/
performObjectSearch: (object, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const objects = Search._index.objects;
const objNames = Search._index.objnames;
const titles = Search._index.titles;
const results = [];
const objectSearchCallback = (prefix, match) => {
const name = match[4]
const fullname = (prefix ? prefix + "." : "") + name;
const fullnameLower = fullname.toLowerCase();
if (fullnameLower.indexOf(object) < 0) return;
let score = 0;
const parts = fullnameLower.split(".");
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower === object || parts.slice(-1)[0] === object)
score += Scorer.objNameMatch;
else if (parts.slice(-1)[0].indexOf(object) > -1)
score += Scorer.objPartialMatch; // matches in last name
const objName = objNames[match[1]][2];
const title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
const otherTerms = new Set(objectTerms);
otherTerms.delete(object);
if (otherTerms.size > 0) {
const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
if (
[...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
)
return;
}
let anchor = match[3];
if (anchor === "") anchor = fullname;
else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
const descr = objName + _(", in ") + title;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2]))
score += Scorer.objPrio[match[2]];
else score += Scorer.objPrioDefault;
results.push([
docNames[match[0]],
fullname,
"#" + anchor,
descr,
score,
filenames[match[0]],
SearchResultKind.object,
]);
};
Object.keys(objects).forEach((prefix) =>
objects[prefix].forEach((array) =>
objectSearchCallback(prefix, array)
)
);
return results;
},
/**
* search for full-text terms in the index
*/
performTermsSearch: (searchTerms, excludedTerms) => {
// prepare search
const terms = Search._index.terms;
const titleTerms = Search._index.titleterms;
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const scoreMap = new Map();
const fileMap = new Map();
// perform the search on the required terms
searchTerms.forEach((word) => {
const files = [];
// find documents, if any, containing the query word in their text/title term indices
// use Object.hasOwnProperty to avoid mismatching against prototype properties
const arr = [
{ files: terms.hasOwnProperty(word) ? terms[word] : undefined, score: Scorer.term },
{ files: titleTerms.hasOwnProperty(word) ? titleTerms[word] : undefined, score: Scorer.title },
];
// add support for partial matches
if (word.length > 2) {
const escapedWord = _escapeRegExp(word);
if (!terms.hasOwnProperty(word)) {
Object.keys(terms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: terms[term], score: Scorer.partialTerm });
});
}
if (!titleTerms.hasOwnProperty(word)) {
Object.keys(titleTerms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
});
}
}
// no match but word was a required one
if (arr.every((record) => record.files === undefined)) return;
// found search word in contents
arr.forEach((record) => {
if (record.files === undefined) return;
let recordFiles = record.files;
if (recordFiles.length === undefined) recordFiles = [recordFiles];
files.push(...recordFiles);
// set score for the word in each file
recordFiles.forEach((file) => {
if (!scoreMap.has(file)) scoreMap.set(file, new Map());
const fileScores = scoreMap.get(file);
fileScores.set(word, record.score);
});
});
// create the mapping
files.forEach((file) => {
if (!fileMap.has(file)) fileMap.set(file, [word]);
else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
});
});
// now check if the files don't contain excluded terms
const results = [];
for (const [file, wordList] of fileMap) {
// check if all requirements are matched
// as search terms with length < 3 are discarded
const filteredTermCount = [...searchTerms].filter(
(term) => term.length > 2
).length;
if (
wordList.length !== searchTerms.size &&
wordList.length !== filteredTermCount
)
continue;
// ensure that none of the excluded terms is in the search result
if (
[...excludedTerms].some(
(term) =>
terms[term] === file ||
titleTerms[term] === file ||
(terms[term] || []).includes(file) ||
(titleTerms[term] || []).includes(file)
)
)
break;
// select one (max) score for the file.
const score = Math.max(...wordList.map((w) => scoreMap.get(file).get(w)));
// add result to the result list
results.push([
docNames[file],
titles[file],
"",
null,
score,
filenames[file],
SearchResultKind.text,
]);
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words.
*/
makeSearchSummary: (htmlText, keywords, anchor) => {
const text = Search.htmlToText(htmlText, anchor);
if (text === "") return null;
const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);
const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";
let summary = document.createElement("p");
summary.classList.add("context");
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
return summary;
},
};
_ready(Search.init);

View File

@@ -0,0 +1,154 @@
/* Highlighting utilities for Sphinx HTML documentation. */
"use strict";
const SPHINX_HIGHLIGHT_ENABLED = true
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const SphinxHighlight = {
/**
* highlight the search words provided in localstorage in the text
*/
highlightSearchWords: () => {
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
// get and clear terms from localstorage
const url = new URL(window.location);
const highlight =
localStorage.getItem("sphinx_highlight_terms")
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms")
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// get individual terms from highlight string
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
_("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
localStorage.removeItem("sphinx_highlight_terms")
},
initEscapeListener: () => {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
SphinxHighlight.hideSearchWords();
event.preventDefault();
}
});
},
};
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});

View File

@@ -0,0 +1,67 @@
.admonition {
padding: 12px;
line-height: 24px;
margin-bottom: 24px;
background: #e7f2fa;
.admonition-title {
color: #fff;
font-weight: bold;
display: block;
margin: -6px;
padding: 6px 12px;
margin-bottom: 12px;
background: #6ab0de;
&:before {
display: inline-block;
font-family: fontawesome-webfont;
content: "\f06a";
font-style: normal;
font-weight: normal;
line-height: 1;
text-decoration: inherit;
margin-right: 4px;
}
}
&.attention, &.caution, &.warning {
background: #ffedcc;
.admonition-title {
background: #f0b37e;
&:before {
content: "\f071";
}
}
}
&.danger, &.error {
background: #fdf3f2;
.admonition-title {
background: #f29f97;
&:before {
content: "\f7b9";
}
}
}
&.hint, &.important {
background: #dbfaf4;;
.admonition-title {
background: #1abc9c;
}
}
&.hint, &.note {
.admonition-title:before {
content: "\f05a";
}
}
}

View File

@@ -0,0 +1,139 @@
.alert {
position: relative;
padding: 0.75rem 1.25rem;
margin-bottom: 1rem;
border: 1px solid transparent;
border-radius: 0.25rem;
}
.alert-heading {
color: inherit;
}
.alert-link {
font-weight: 700;
}
.alert-dismissible {
padding-right: 4rem;
}
.alert-dismissible .close {
position: absolute;
top: 0;
right: 0;
padding: 0.75rem 1.25rem;
color: inherit;
}
.alert-primary {
color: #004085;
background-color: #cce5ff;
border-color: #b8daff;
}
.alert-primary hr {
border-top-color: #9fcdff;
}
.alert-primary .alert-link {
color: #002752;
}
.alert-secondary {
color: #383d41;
background-color: #e2e3e5;
border-color: #d6d8db;
}
.alert-secondary hr {
border-top-color: #c8cbcf;
}
.alert-secondary .alert-link {
color: #202326;
}
.alert-success {
color: #155724;
background-color: #d4edda;
border-color: #c3e6cb;
}
.alert-success hr {
border-top-color: #b1dfbb;
}
.alert-success .alert-link {
color: #0b2e13;
}
.alert-info {
color: #0c5460;
background-color: #d1ecf1;
border-color: #bee5eb;
}
.alert-info hr {
border-top-color: #abdde5;
}
.alert-info .alert-link {
color: #062c33;
}
.alert-warning {
color: #856404;
background-color: #fff3cd;
border-color: #ffeeba;
}
.alert-warning hr {
border-top-color: #ffe8a1;
}
.alert-warning .alert-link {
color: #533f03;
}
.alert-danger {
color: #721c24;
background-color: #f8d7da;
border-color: #f5c6cb;
}
.alert-danger hr {
border-top-color: #f1b0b7;
}
.alert-danger .alert-link {
color: #491217;
}
.alert-light {
color: #818182;
background-color: #fefefe;
border-color: #fdfdfe;
}
.alert-light hr {
border-top-color: #ececf6;
}
.alert-light .alert-link {
color: #686868;
}
.alert-dark {
color: #1b1e21;
background-color: #d6d8d9;
border-color: #c6c8ca;
}
.alert-dark hr {
border-top-color: #b9bbbe;
}
.alert-dark .alert-link {
color: #040505;
}

View File

@@ -0,0 +1,74 @@
dl.head, dl.get, dl.post, dl.put, dl.delete, dl.patch, dl.options, dl.trace, dl.connect, dl.copy, dl.any {
break-before: auto;
break-after: auto;
break-inside: auto;
//> * {
// break-before: auto;
//}
> dd > dl.field-list {
display: block;
> * {
flex-basis: unset;
padding-left: 0;
}
}
> dt {
margin-bottom: 1em;
}
> dd {
margin-left: 0;
> p > strong {
font-weight: normal;
}
}
span.sig-paren, em.property, em.sig-param {
font-weight: normal;
}
code.descname:first-child {
font-size: 0.9em;
background-color: #337ab7;
color: white;
display: inline-block;
padding-left: 5px;
padding-right: 5px;
margin-right: 10px;
}
&.get {
code.descname:first-child {
background-color: #61AFFE;
}
}
&.post {
code.descname:first-child {
background-color: #49CC90;
}
}
&.put {
code.descname:first-child {
background-color: #FCA130;
}
}
&.patch {
code.descname:first-child {
background-color: #50E3C2;
}
}
&.delete {
code.descname:first-child {
background-color: #F93E3E;
}
}
}

View File

@@ -0,0 +1,27 @@
#back-cover {
width: 100%;
height: 100%;
.container {
width: 100%;
.back-cover-footer {
font-family: 'Helvetica Neue';
font-size: 11pt;
margin-top: 3px;
position: absolute;
bottom: 30pt;
color: $white;
width: 100%;
p {
width: 80%;
margin: 0 auto;
text-align: center;
a {
color: $white;
}
}
}
}
}

View File

@@ -0,0 +1,4 @@
div.topic {
border: 0;
padding: 0;
}

View File

@@ -0,0 +1,35 @@
dl.class, dl.type, dl.function, dl.member, dl.var, dl.enum, dl.enum-class, dl.enum-struct, dl.method {
dt {
text-align: left;
}
> dt {
font-weight: normal;
}
em.property {
font-weight: bold;
color: #007020;
}
em.sig-param {
color: #007020;
}
code.sig-prename {
font-weight: bold;
color: #4070a0;
}
code.sig-name {
color: #0e84b5;
}
dl.field-list {
display: block;
dt, dd {
padding-left: 0;
}
}
}

View File

@@ -0,0 +1,117 @@
#cover {
width: 100%;
// height: 100%;
align-content: space-between;
display: flex;
flex-wrap: wrap;
height: 297mm;
background: $cover-bg;
background-size: cover;
margin: 0;
h1 {
font-family: "Work Sans", sans-serif;
color: $primary;
font-size: 38pt;
margin: 5cm 2cm 0 2cm;
page: no-chapter;
width: 100%;
}
a {
color: $cover;
font-weight: bolder;
}
.container {
width: 100%;
top: 0;
background: $cover-overlay;
.logo {
font-size: 24pt;
color: $cover;
width: 200px;
height: 45px;
position: absolute;
text-align: right;
top: 40pt;
right: 20pt;
p {
margin: auto;
}
}
.cover-middle {
position: relative;
top: 40%;
width: 100%;
.title {
position: absolute;
top: 5pt;
left: 40pt;
height: 150pt;
.title-cover {
font-family: "Work Sans Bold", sans-serif;
font-size: 45pt;
margin-bottom: 0;
margin-top: 0;
margin-left: 0;
color: $cover;
}
.subtitle-cover {
font-family: "Work Sans Bold", sans-serif;
font-weight: bolder;
font-size: 28pt;
// text-transform: uppercase;
margin-top: 5pt;
color: $cover;
}
.meta {
font-family: 'Work Sans';
font-size: 18pt;
margin-top: 12pt;
margin-bottom: 0;
color: $cover;
}
}
.client-logo {
position: absolute;
border-radius: 8pt;
border: 4px solid white;
background-color: white;
top: 20pt;
right: 40pt;
float: right;
height: 150px;
width: 150px;
img {
width: 150px;
height: 150px;
}
}
}
.cover-footer {
font-family: 'Work Sans';
font-size: 11pt;
margin-top: 3px;
position: absolute;
bottom: 30pt;
color: $white;
width: 100%;
p {
width: 80%;
margin: 0 auto;
text-align: center;
}
}
}
}

View File

@@ -0,0 +1,75 @@
@font-face {
font-family: Work Sans Bold;
font-weight: bold;
src: url(fonts/WorkSans-Bold.ttf);
}
@font-face {
font-family: Work Sans Bold;
font-weight: 400;
src: url(fonts/WorkSans-SemiBold.ttf);
}
@font-face {
font-family: Work Sans;
font-weight: 400;
src: url(fonts/WorkSans-Regular.ttf);
}
@font-face {
font-family: Fira Sans;
font-weight: 400;
src: url(fonts/FiraSans-Regular.otf);
}
@font-face {
font-family: Fira Sans;
font-style: italic;
font-weight: 400;
src: url(fonts/FiraSans-Italic.otf);
}
@font-face {
font-family: Fira Sans;
font-weight: 300;
src: url(fonts/FiraSans-Light.otf);
}
@font-face {
font-family: Fira Sans;
font-style: italic;
font-weight: 300;
src: url(fonts/FiraSans-LightItalic.otf);
}
@font-face {
font-family: Fira Sans;
font-weight: bold;
src: url(fonts/FiraSans-Bold.otf);
}
@font-face {
font-family: fontawesome-webfont;
//font-weight: normal;
//font-style: normal;
src: url("fonts/fa-solid-900.eot");
src: url("fonts/fa-solid-900.eot?#iefix") format("embedded-opentype"), url("fonts/fa-solid-900.ttf") format("truetype"), url("fonts/fa-solid-900.svg#fontawesome-webfont") format("svg")
}
@font-face {
font-family: monospace;
src: url(fonts/FiraMono-Regular.ttf);
}
@font-face {
font-family: monospace;
font-weight: 400;
src: url(fonts/FiraMono-Medium.ttf);
}
@font-face {
font-family: monospace;
font-weight: bold;
src: url(fonts/FiraMono-Bold.ttf);
}

View File

@@ -0,0 +1,54 @@
ul, ol {
padding-left: 15px;
ul, ol {
padding-left: 20px;
}
}
dl {
dt {
font-weight: bold;
}
}
dl.option-list, dl.field-list {
display: flex;
flex-wrap: wrap;
//margin-left: -15px;
//margin-right: -15px;
dt, dd {
//margin-left: 15px;
//margin-right: 15px;
}
dt {
//margin-left: 30px;
padding-right: 15px;
flex: 0 0 33%;
max-width: 33%;
font-weight: normal;
}
dd {
//margin-right: 30px;
margin-left: 0;
padding-left: 15px;
flex: 0 0 66%;
max-width: 66%;
}
}
dl.field-list {
dt, dd {
padding-top: .5em;
padding-bottom: .5em;
}
}
.hlist {
ul {
list-style: none;
}
}

View File

@@ -0,0 +1,10 @@
.needs_style_break {
page-break-before: always;
}
table.need, table.NEEDS_DATATABLES, .needs_style_ssp-table-wrap {
table-layout: fixed;
td, th {
overflow-wrap: break-word;
}
}

View File

@@ -0,0 +1,206 @@
// Page helpers
.dont-break {
page-break-inside: avoid;
}
.break-before {
page-break-before: always;
}
.break-after {
page-break-after: always;
}
#back-cover {
page: back_cover;
page-break-before: always;
}
@page landscape_page {
size: landscape;
}
@page portrait_page {
size: portrait;
}
.ssp-portrait {
page: portrait_page;
}
.ssp-landscape {
page: landscape_page;
}
@page {
padding-top: 1em;
@top-left {
background: $primary;
color: $white;
content: $top-left-content;
height: 1cm;
text-align: center;
width: 1cm;
}
@top-center {
content: $top-center-content;
font-size: 9pt;
height: 1cm;
text-align: center;
vertical-align: middle;
width: 100%;
border-bottom-color: $primary-opaque;
border-bottom-style: solid;
border-bottom-width: 0.05cm;
}
@top-right {
content: $top-right-content;
font-size: 9pt;
height: 1cm;
text-align: right;
vertical-align: middle;
width: 100%;
border-bottom-color: $primary-opaque;
border-bottom-style: solid;
border-bottom-width: 0.05cm;
}
@bottom-left {
content: $bottom-left-content;
text-align: left;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
border-top-color: $primary-opaque;
border-top-style: solid;
border-top-width: 0.05cm;
margin-top: 3px;
position: absolute;
bottom: 30pt;
}
@bottom-center {
content: $bottom-center-content;
text-align: center;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
border-top-color: $primary-opaque;
border-top-style: solid;
border-top-width: 0.05cm;
margin-top: 3px;
position: absolute;
bottom: 30pt;
}
@bottom-right {
content: $bottom-right-content;
text-align: right;
font-size: 9pt;
height: 1cm;
vertical-align: middle;
width: 100%;
margin-top: 3px;
position: absolute;
bottom: 30pt;
border-top-color: $primary-opaque;
border-top-style: solid;
border-top-width: 0.05cm;
}
}
@page:blank {
@top-left {
background: none;
content: "";
}
@top-center {
content: none;
}
@top-right {
content: none;
}
}
@page no-chapter {
@top-left {
background: none;
content: none;
}
@top-center {
content: none;
}
@top-right {
content: none;
}
}
@if not $nocover {
@page:first {
background: $cover-bg;
background-size: cover;
margin: 0;
}
}
@media screen {
#cover {
background: $cover-bg;
background-size: cover;
margin: 0;
}
}
@page chapter {
background: $primary;
color: $white;
margin: 0;
@top-left {
content: none;
}
@top-center {
content: none;
}
@top-right {
content: none;
}
}
// Back cover
@page back_cover {
background: $cover-bg;
background-size: cover;
margin: 0;
color: #ffffff;
}
@page back_cover {
@bottom-right {
content: none;
}
@top-left {
background: none;
content: '';
}
@top-center {
content: none;
}
@top-right {
content: none;
}
}

View File

@@ -0,0 +1,67 @@
table.break {
page-break-before: always;
}
table.ssp-table-wrap {
table-layout: fixed;
td, th {
overflow-wrap: break-word;
}
}
table.docutils {
width: 100%;
max-width: 100%;
margin-bottom: 1rem;
background-color: transparent;
border-spacing: 0;
td, th {
padding: .75rem;
vertical-align: top;
}
thead {
th {
vertical-align: bottom;
border-bottom: 2px solid #dee2e6;
background: #F0F0F0;
border-top: 1px solid #dee2e6;
}
}
tbody {
tr {
&.row-odd {
background: #f6f6f6;
}
td {
display: table-cell;
font-weight: normal !important;
}
* {
border: 0;
}
}
}
}
table.docutils.ssp-tinier {
td, th {
padding: .4rem;
vertical-align: top;
font-size: 0.75em;
}
}
table.docutils.ssp-tiny {
td, th {
padding: .05rem;
vertical-align: top;
font-size: 0.5em;
}
}

View File

@@ -0,0 +1,177 @@
.badge {
display: inline-block;
padding: .25em .4em;
font-size: 75%;
font-weight: 700;
line-height: 1;
text-align: center;
white-space: nowrap;
vertical-align: baseline;
border-radius: .25rem;
}
.text-white {
color: #fff !important;
}
.text-primary {
color: #007bff !important;
}
a {
color: $links;
//color: #083764;
text-decoration: none;
}
a.text-primary:hover, a.text-primary:focus {
color: #0056b3 !important;
}
.text-secondary {
color: #6c757d !important;
}
a.text-secondary:hover, a.text-secondary:focus {
color: #494f54 !important;
}
.text-success {
color: #28a745 !important;
}
a.text-success:hover, a.text-success:focus {
color: #19692c !important;
}
.text-info {
color: #17a2b8 !important;
}
a.text-info:hover, a.text-info:focus {
color: #0f6674 !important;
}
.text-warning {
color: #ffc107 !important;
}
a.text-warning:hover, a.text-warning:focus {
color: #ba8b00 !important;
}
.text-danger {
color: #dc3545 !important;
}
a.text-danger:hover, a.text-danger:focus {
color: #a71d2a !important;
}
.text-light {
color: #f8f9fa !important;
}
a.text-light:hover, a.text-light:focus {
color: #cbd3da !important;
}
.text-dark {
color: #343a40 !important;
}
a.text-dark:hover, a.text-dark:focus {
color: #121416 !important;
}
.text-body {
color: #212529 !important;
}
.text-muted {
color: #6c757d !important;
}
.text-black-50 {
color: rgba(0, 0, 0, 0.5) !important;
}
.text-white-50 {
color: rgba(255, 255, 255, 0.5) !important;
}
.text-hide {
font: 0/0 a;
color: transparent;
text-shadow: none;
background-color: transparent;
border: 0;
}
.text-decoration-none {
text-decoration: none !important;
}
.square-brackets-quote {
border: solid 1em #ccc;
// display:inline-block;
margin: 0;
padding: 1em;
position:relative;
// margin-left: 0;
max-width: 100%;
&:before {
background-color: white;
bottom: -1em;
content: "";
left: 2em;
position: absolute;
right: 2em;
top: -1em;
}
cite {
color: #757575;
display: block;
font-size: small;
font-style: normal;
text-align: right;
text-transform: uppercase;
}
> * {
position: relative;
z-index: 1;
}
}
.body {
text-align: justify;
pre, h1, h2, h3, h4, h5, h6 {
text-align: left;
}
}
a.download {
code.download.literal.notranslate {
color: #083764;
background-color: transparent;
font-family: inherit;
&:before {
display: inline-block;
font-family: fontawesome-webfont;
content: "\f019";
font-style: normal;
font-weight: normal;
line-height: 1;
text-decoration: inherit;
margin-right: 2px;
}
}
}

View File

@@ -0,0 +1,161 @@
// .. contents:: config
.contents {
ul {
list-style: none;
}
> ul {
padding-left: 0;
> li {
font-weight: 500;
line-height: 15pt;
margin: 3em 0 1em;
&::before {
background: $primary;
color: $white;
content: "";
display: block;
height: 0.08cm;
margin-bottom: 0.25cm;
width: 2cm;
}
a {
color: #000000;
font-size: 15pt;
}
a::after {
color: $primary;
content: target-counter(attr(href url), page);
// font-size: 15pt;
float: right;
}
> ul {
list-style: none;
padding-left: 0;
li {
border-top: 0.3pt solid #c1c1c1;
margin: 0.25cm 0;
padding-top: 0.25cm;
line-height: 12pt;
// font-size: 12pt;
font-weight: 300;
a {
color: #000000;
font-size: 12pt;
}
p::before {
color: $primary;
content: "";
font-size: 40pt;
line-height: 16pt;
vertical-align: bottom;
}
ul {
padding-left: 2em;
}
}
}
}
}
}
// .. toctree:: config
.sphinxsidebarwrapper {
page-break-before: always;
div {
ul {
list-style: none;
}
> ul {
padding-left: 0;
> li {
font-weight: 500;
//line-height: 15pt;
line-height: 12pt;
//margin: 3em 0 1em;
margin: 2em 0 1em;
// Adds a red, short line above each main chapter
//&::before {
// background: $primary;
// color: $white;
// content: "";
// display: block;
// height: 0.08cm;
// margin-bottom: 0.25cm;
// width: 2cm;
//}
a {
color: #000000;
//font-size: 15pt;
font-size: 13pt;
}
a::after {
color: $primary;
content: target-counter(attr(href url), page);
//content: '123';
// font-size: 15pt;
float: right;
}
> ul {
list-style: none;
padding-left: 0;
li {
border-top: 0.3pt solid #c1c1c1;
//margin: 0.25cm 0;
margin: 0.15cm 0;
//padding-top: 0.25cm;
padding-top: 0.15cm;
//line-height: 12pt;
line-height: 10pt;
// font-size: 12pt;
font-weight: 300;
a {
color: #000000;
font-size: 12pt;
}
a::before {
color: $primary;
content: "";
//font-size: 40pt;
font-size: 30pt;
//line-height: 13pt;
line-height: 10pt;
vertical-align: bottom;
}
ul {
padding-left: 2em;
}
}
}
}
}
}
}

View File

@@ -0,0 +1,28 @@
// Used to define scss variables, so that the config()-call is used only once (in this file) and
// inside other scss-files.
// Outside this scss-file use the here defined variables.
// Colors
$primary: config('primary', '#961a1a') !default;
$primary-opaque: config('primary-opaque', 'rgba(150, 26, 26, .5)') !default;
$secondary: config('secondary', '#379683') !default;
$cover: config('cover', '#ffffff') !default;
$white: config('white', '#ffffff') !default;
$links: config('links', '#961a1a') !default;
// Images
$cover-bg: config('cover-bg', '#961a1a');
$cover-overlay: config('cover-overlay', 'rgba(0,0,0,0)');
// pdf header content
$top-left-content: config('top-left-content', 'counter(page)') !default;
$top-center-content: config('top-center-content', '') !default;
$top-right-content: config('top-right-content', 'string(heading)') !default;
// pdf footer content
$bottom-left-content: config('bottom-left-content', '') !default;
$bottom-center-content: config('bottom-center-content', '') !default;
$bottom-right-content: config('bottom-right-content', '') !default;
$nocover: theme_option('nocover', false) !default;

View File

@@ -0,0 +1,176 @@
@charset "UTF-8";
@import "variables";
@import "fonts";
@import "lists";
@import "tables";
@import "blocks";
@import "alerts";
@import "code";
@import "toc";
@import "pages";
@import "cover";
@import "back-cover";
@import "text";
@import "admonition";
@import "api";
@import "needs";
@media print
{
// Para evitar que queden espacios entre los bloques de API
dd, dt, dl {
// page-break-inside: avoid;
}
}
body div.body {
min-width: unset;
max-width: unset;
}
.docutils {
th.field-name {
display: table-row;
}
td {
display: none;
}
td.field-body {
display: table-row;
padding-top: 1em;
ul {
margin-left: 1em;
margin-bottom: 1em;
}
}
}
body {
margin: 0;
}
.highlight-default {
margin-top: 0.5em;
}
.highlight {
pre {
padding: 1em;
//white-space: -moz-pre-wrap;
white-space: -o-pre-wrap;
word-wrap: break-word;
white-space: pre-wrap;
}
}
.headerlink {
display: none;
}
html {
color: #393939;
font-family: Fira Sans;
font-size: 11pt;
font-weight: 300;
line-height: 1.5;
body {
h1 {
color: $primary;
font-size: 30pt;
page-break-before: always;
}
h2, h3, h4 {
color: black;
font-weight: 400;
}
h2 {
page-break-before: always;
font-size: 28pt;
string-set: heading content();
}
h3 {
font-weight: 300;
font-size: 20pt;
}
h4 {
font-size: 16pt;
}
h5 {
font-size: 15pt;
font-weight: 100;
}
h6 {
font-size: 13pt;
font-weight: 100;
}
section {
h5 {
margin-bottom: 1pt;
}
p {
margin-top: 0;
}
}
h5, h6 {
margin-bottom: 0;
padding-bottom: 0;
}
}
}
.alert {
i {
margin-right: 6pt;
}
}
.is-marginless { margin: 0 !important; }
.is-paddingless { padding: 0 !important; }
.charts-inline {
columns: 2;
column-fill: balance;
}
.img-fluid {
max-width: 100%;
height: auto;
}
img {
max-width: 100%;
height: auto;
}
.big-stats {
font-size: 23pt;
}
.docutils.literal.notranslate {
//-moz-hyphens: none;
//-ms-hyphens: none;
//-webkit-hyphens: none;
hyphens: none;
color: #552977;
background-color: #f1f1f1;
font-size: 9pt;
display: inline-block;
padding: 1pt 3pt;
}

View File

@@ -0,0 +1,135 @@
<!DOCTYPE html>
<html data-content_root="./" lang="en">
<head>
<meta charset="utf-8"/>
<meta content="width=device-width, initial-scale=1.0" name="viewport"/>
<meta content="width=device-width, initial-scale=1" name="viewport"/>
<title>
ByteRider 06-2025 documentation
</title>
<link href="_static/pygments.css?v=d75fae25" rel="stylesheet" type="text/css"/>
<link href="_static/main.css?v=8a8644ef" rel="stylesheet" type="text/css"/>
<script src="_static/documentation_options.js?v=84c8e5cb">
</script>
<script src="_static/doctools.js?v=9bcbadda">
</script>
<script src="_static/sphinx_highlight.js?v=dc90522c">
</script>
<link href="genindex.html" rel="index" title="Index"/>
<link href="search.html" rel="search" title="Search"/>
</head>
<body>
<article class="dont-break" id="cover">
<div class="container">
<!-- Logo -->
<div class="logo">
<p>
</p>
</div>
<!-- Cover middle -->
<div class="cover-middle">
<div class="title">
<h1 class="title-cover">
ByteRider
</h1>
<p class="subtitle-cover">
Version
</p>
<span class="meta">
</span>
</div>
<!--
<div class="client-logo">
<img src="../data/logo_.png" alt="Logotipo">
</div>
-->
</div>
<!-- Footer -->
<div class="cover-footer">
<p>
</p>
</div>
</div>
</article>
<div aria-label="Main" class="sphinxsidebar" role="navigation">
<div class="sphinxsidebarwrapper">
<div>
<h3>
<a href="#">
Table of Contents
</a>
</h3>
<ul>
<li class="toctree-l1">
<a class="reference internal" href="#introduction">
INTRODUCTION
</a>
</li>
</ul>
</div>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="byterider-documentation">
<h1>
ByteRider documentation
<a class="headerlink" href="#byterider-documentation" title="Link to this heading">
&para;
</a>
</h1>
<p>
Add your content using
<code class="docutils literal notranslate">
<span class="pre">
reStructuredText
</span>
</code>
syntax. See the
<a class="reference external" href="https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html">
reStructuredText
</a>
documentation for details.
</p>
<div class="toctree-wrapper compound">
<span id="document-intro">
</span>
<section id="introduction">
<h2>
INTRODUCTION
<a class="headerlink" href="#introduction" title="Link to this heading">
&para;
</a>
</h2>
<img alt="_images/ESP32C3_Breadboard-Adapter.png" src="_images/ESP32C3_Breadboard-Adapter.png"/>
</section>
</div>
</section>
<div class="clearer">
</div>
</div>
</div>
</div>
<div class="clearer">
</div>
</div>
<article id="back-cover">
<div class="container">
<div class="back-cover-footer">
<p>
&copy; Copyright 2025, Alexander B..
</p>
<p>
Created using
<a href="http://sphinx-doc.org/">
Sphinx
</a>
8.2.3.
</p>
</div>
</div>
</article>
</body>
</html>

View File

@@ -0,0 +1,8 @@
# Sphinx inventory version 2
# Project: ByteRider
# Version:
# The remainder of this file is compressed using zlib.
<EFBFBD><EFBFBD>
<EFBFBD>0E<><45><EFBFBD><EFBFBD><EFBFBD>n]<5D><>,lK<6C><10>! <09>Q<EFBFBD>)<29><><EFBFBD>!-ZP\<5C>p<EFBFBD>=px<>%<<3C><><EFBFBD>h<EFBFBD>,e<07><>t<EFBFBD><74>Y<EFBFBD><59>K<EFBFBD>5<19>\<5C><>wr<77><72>tJ<08><><10>
<04><>gc<>%fī<66><C4AB>/<2F>s<EFBFBD><20> [A<>t
r<EFBFBD><EFBFBD>L<EFBFBD><EFBFBD><EFBFBD>&<26>~k<> b<><62>bɊs+<2B>