From b457555cc4b1774f102fcd0f4f7567357be50bba Mon Sep 17 00:00:00 2001 From: Dirk Alders Date: Fri, 15 Aug 2025 19:47:04 +0200 Subject: [PATCH] docs added and structure for unittest adapted --- __init__.py | 2 +- _docs_/.buildinfo | 4 + _docs_/_sources/index.rst.txt | 34 + _docs_/_static/basic.css | 906 ++++++++++++++++++++ _docs_/_static/classic.css | 262 ++++++ _docs_/_static/copybutton.js | 84 ++ _docs_/_static/default.css | 1 + _docs_/_static/doctools.js | 149 ++++ _docs_/_static/documentation_options.js | 13 + _docs_/_static/file.png | Bin 0 -> 286 bytes _docs_/_static/language_data.js | 192 +++++ _docs_/_static/menu.js | 57 ++ _docs_/_static/minus.png | Bin 0 -> 90 bytes _docs_/_static/plus.png | Bin 0 -> 90 bytes _docs_/_static/py.png | Bin 0 -> 695 bytes _docs_/_static/py.svg | 14 + _docs_/_static/pydoctheme.css | 773 +++++++++++++++++ _docs_/_static/pydoctheme_dark.css | 191 +++++ _docs_/_static/pygments.css | 75 ++ _docs_/_static/pygments_dark.css | 85 ++ _docs_/_static/search-focus.js | 21 + _docs_/_static/searchtools.js | 635 ++++++++++++++ _docs_/_static/sidebar.js | 64 ++ _docs_/_static/sphinx_highlight.js | 154 ++++ _docs_/_static/themetoggle.js | 24 + _docs_/genindex.html | 501 +++++++++++ _docs_/index.html | 1003 +++++++++++++++++++++++ _docs_/objects.inv | 7 + _docs_/py-modindex.html | 250 ++++++ _docs_/search.html | 198 +++++ _docs_/searchindex.js | 1 + _examples_/Makefile | 18 + 32 files changed, 5717 insertions(+), 1 deletion(-) create mode 100644 _docs_/.buildinfo create mode 100644 _docs_/_sources/index.rst.txt create mode 100644 _docs_/_static/basic.css create mode 100644 _docs_/_static/classic.css create mode 100644 _docs_/_static/copybutton.js create mode 100644 _docs_/_static/default.css create mode 100644 _docs_/_static/doctools.js create mode 100644 _docs_/_static/documentation_options.js create mode 100644 _docs_/_static/file.png create mode 100644 _docs_/_static/language_data.js create mode 100644 _docs_/_static/menu.js create mode 100644 _docs_/_static/minus.png create mode 100644 _docs_/_static/plus.png create mode 100644 _docs_/_static/py.png create mode 100644 _docs_/_static/py.svg create mode 100644 _docs_/_static/pydoctheme.css create mode 100644 _docs_/_static/pydoctheme_dark.css create mode 100644 _docs_/_static/pygments.css create mode 100644 _docs_/_static/pygments_dark.css create mode 100644 _docs_/_static/search-focus.js create mode 100644 _docs_/_static/searchtools.js create mode 100644 _docs_/_static/sidebar.js create mode 100644 _docs_/_static/sphinx_highlight.js create mode 100644 _docs_/_static/themetoggle.js create mode 100644 _docs_/genindex.html create mode 100644 _docs_/index.html create mode 100644 _docs_/objects.inv create mode 100644 _docs_/py-modindex.html create mode 100644 _docs_/search.html create mode 100644 _docs_/searchindex.js create mode 100644 _examples_/Makefile diff --git a/__init__.py b/__init__.py index c763932..ade6261 100644 --- a/__init__.py +++ b/__init__.py @@ -29,7 +29,7 @@ from geo import osm from geo import sun __DESCRIPTION__ = """The Module {\\tt %s} is designed to \\ldots. -For more Information read the sphinx documentation.""" % __name__.replace('_', '\_') +For more Information read the sphinx documentation.""" % __name__.replace('_', '\\_') """The Module Description""" __INTERPRETER__ = (2, ) """The Tested Interpreter-Versions""" diff --git a/_docs_/.buildinfo b/_docs_/.buildinfo new file mode 100644 index 0000000..49d74f2 --- /dev/null +++ b/_docs_/.buildinfo @@ -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: 420767f459914b0e877a88eb871be3e8 +tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/_docs_/_sources/index.rst.txt b/_docs_/_sources/index.rst.txt new file mode 100644 index 0000000..4ac1382 --- /dev/null +++ b/_docs_/_sources/index.rst.txt @@ -0,0 +1,34 @@ +geo package +=========== + +.. automodule:: geo + :members: + :show-inheritance: + :undoc-members: + +Submodules +---------- + +geo.gps module +-------------- + +.. automodule:: geo.gps + :members: + :show-inheritance: + :undoc-members: + +geo.osm module +-------------- + +.. automodule:: geo.osm + :members: + :show-inheritance: + :undoc-members: + +geo.sun module +-------------- + +.. automodule:: geo.sun + :members: + :show-inheritance: + :undoc-members: diff --git a/_docs_/_static/basic.css b/_docs_/_static/basic.css new file mode 100644 index 0000000..4738b2e --- /dev/null +++ b/_docs_/_static/basic.css @@ -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: 360px; + 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; + } +} \ No newline at end of file diff --git a/_docs_/_static/classic.css b/_docs_/_static/classic.css new file mode 100644 index 0000000..6553d2c --- /dev/null +++ b/_docs_/_static/classic.css @@ -0,0 +1,262 @@ +/* + * Sphinx stylesheet -- classic theme. + */ + +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +html { + /* CSS hack for macOS's scrollbar (see #1125) */ + background-color: #FFFFFF; +} + +body { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; + font-size: 100%; + background-color: white; + color: #000; + margin: 0; + padding: 0; +} + +div.document { + display: flex; + background-color: white; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 230px; +} + +div.body { + background-color: white; + color: #222222; + padding: 0 20px 30px 20px; +} + +div.footer { + color: #555555; + width: 100%; + padding: 9px 0 9px 0; + text-align: center; + font-size: 75%; +} + +div.footer a { + color: #555555; + text-decoration: underline; +} + +div.related { + background-color: white; + line-height: 30px; + color: #666666; +} + +div.related a { + color: #444444; +} + +div.sphinxsidebar { +} + +div.sphinxsidebar h3 { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; + color: #444444; + font-size: 1.4em; + font-weight: normal; + margin: 0; + padding: 0; +} + +div.sphinxsidebar h3 a { + color: #444444; +} + +div.sphinxsidebar h4 { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; + color: #444444; + font-size: 1.3em; + font-weight: normal; + margin: 5px 0 0 0; + padding: 0; +} + +div.sphinxsidebar p { + color: #444444; +} + +div.sphinxsidebar p.topless { + margin: 5px 10px 10px 10px; +} + +div.sphinxsidebar ul { + margin: 10px; + padding: 0; + color: #444444; +} + +div.sphinxsidebar a { + color: #444444; +} + +div.sphinxsidebar input { + border: 1px solid #444444; + font-family: sans-serif; + font-size: 1em; +} + + + +/* -- hyperlink styles ------------------------------------------------------ */ + +a { + color: #0090c0; + text-decoration: none; +} + +a:visited { + color: #00608f; + text-decoration: none; +} + +a:hover { + text-decoration: underline; +} + + + +/* -- body styles ----------------------------------------------------------- */ + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; + background-color: white; + font-weight: normal; + color: #1a1a1a; + border-bottom: 1px solid #ccc; + margin: 20px -20px 10px -20px; + padding: 3px 0 3px 10px; +} + +div.body h1 { margin-top: 0; font-size: 200%; } +div.body h2 { font-size: 160%; } +div.body h3 { font-size: 140%; } +div.body h4 { font-size: 120%; } +div.body h5 { font-size: 110%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #aaaaaa; + font-size: 0.8em; + padding: 0 4px 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + background-color: #aaaaaa; + color: white; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + text-align: justify; + line-height: 130%; +} + +div.admonition p.admonition-title + p { + display: inline; +} + +div.admonition p { + margin-bottom: 5px; +} + +div.admonition pre { + margin-bottom: 5px; +} + +div.admonition ul, div.admonition ol { + margin-bottom: 5px; +} + +div.note { + background-color: #eee; + border: 1px solid #ccc; +} + +div.seealso { + background-color: #ffc; + border: 1px solid #ff6; +} + +nav.contents, +aside.topic, +div.topic { + background-color: #eee; +} + +div.warning { + background-color: #ffe4e4; + border: 1px solid #f66; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre { + padding: 5px; + background-color: #eeffcc; + color: #333333; + line-height: 120%; + border: 1px solid #ac9; + border-left: none; + border-right: none; +} + +code { + background-color: #ecf0f3; + padding: 0 1px 0 1px; + font-size: 0.95em; +} + +th, dl.field-list > dt { + background-color: #ede; +} + +.warning code { + background: #efc2c2; +} + +.note code { + background: #d6d6d6; +} + +.viewcode-back { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; +} + +div.viewcode-block:target { + background-color: #f4debf; + border-top: 1px solid #ac9; + border-bottom: 1px solid #ac9; +} + +div.code-block-caption { + color: #efefef; + background-color: #1c4e63; +} \ No newline at end of file diff --git a/_docs_/_static/copybutton.js b/_docs_/_static/copybutton.js new file mode 100644 index 0000000..de071f4 --- /dev/null +++ b/_docs_/_static/copybutton.js @@ -0,0 +1,84 @@ +// Extract copyable text from the code block ignoring the +// prompts and output. +function getCopyableText(rootElement) { + rootElement = rootElement.cloneNode(true) + // tracebacks (.gt) contain bare text elements that + // need to be removed + const tracebacks = rootElement.querySelectorAll(".gt") + for (const el of tracebacks) { + while ( + el.nextSibling && + (el.nextSibling.nodeType !== Node.ELEMENT_NODE || + !el.nextSibling.matches(".gp, .go")) + ) { + el.nextSibling.remove() + } + } + // Remove all elements with the "go" (Generic.Output), + // "gp" (Generic.Prompt), or "gt" (Generic.Traceback) CSS class + const elements = rootElement.querySelectorAll(".gp, .go, .gt") + for (const el of elements) { + el.remove() + } + return rootElement.innerText.trim() +} + +const loadCopyButton = () => { + const button = document.createElement("button") + button.classList.add("copybutton") + button.type = "button" + button.innerText = _("Copy") + button.title = _("Copy to clipboard") + + const makeOnButtonClick = () => { + let timeout = null + // define the behavior of the button when it's clicked + return async event => { + // check if the clipboard is available + if (!navigator.clipboard || !navigator.clipboard.writeText) { + return; + } + + clearTimeout(timeout) + const buttonEl = event.currentTarget + const codeEl = buttonEl.nextElementSibling + + try { + await navigator.clipboard.writeText(getCopyableText(codeEl)) + } catch (e) { + console.error(e.message) + return + } + + buttonEl.innerText = _("Copied!") + timeout = setTimeout(() => { + buttonEl.innerText = _("Copy") + }, 1500) + } + } + + const highlightedElements = document.querySelectorAll( + ".highlight-python .highlight," + + ".highlight-python3 .highlight," + + ".highlight-pycon .highlight," + + ".highlight-pycon3 .highlight," + + ".highlight-default .highlight" + ) + + // create and add the button to all the code blocks that contain >>> + highlightedElements.forEach(el => { + el.style.position = "relative" + + // if we find a console prompt (.gp), prepend the (deeply cloned) button + const clonedButton = button.cloneNode(true) + // the onclick attribute is not cloned, set it on the new element + clonedButton.onclick = makeOnButtonClick() + el.prepend(clonedButton) + }) +} + +if (document.readyState !== "loading") { + loadCopyButton() +} else { + document.addEventListener("DOMContentLoaded", loadCopyButton) +} diff --git a/_docs_/_static/default.css b/_docs_/_static/default.css new file mode 100644 index 0000000..81b9363 --- /dev/null +++ b/_docs_/_static/default.css @@ -0,0 +1 @@ +@import url("classic.css"); diff --git a/_docs_/_static/doctools.js b/_docs_/_static/doctools.js new file mode 100644 index 0000000..0398ebb --- /dev/null +++ b/_docs_/_static/doctools.js @@ -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); diff --git a/_docs_/_static/documentation_options.js b/_docs_/_static/documentation_options.js new file mode 100644 index 0000000..7e4c114 --- /dev/null +++ b/_docs_/_static/documentation_options.js @@ -0,0 +1,13 @@ +const DOCUMENTATION_OPTIONS = { + VERSION: '', + LANGUAGE: 'en', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '.txt', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_docs_/_static/file.png b/_docs_/_static/file.png new file mode 100644 index 0000000000000000000000000000000000000000..a858a410e4faa62ce324d814e4b816fff83a6fb3 GIT binary patch literal 286 zcmV+(0pb3MP)s`hMrGg#P~ix$^RISR_I47Y|r1 z_CyJOe}D1){SET-^Amu_i71Lt6eYfZjRyw@I6OQAIXXHDfiX^GbOlHe=Ae4>0m)d(f|Me07*qoM6N<$f}vM^LjV8( literal 0 HcmV?d00001 diff --git a/_docs_/_static/language_data.js b/_docs_/_static/language_data.js new file mode 100644 index 0000000..c7fe6c6 --- /dev/null +++ b/_docs_/_static/language_data.js @@ -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; + } +} + diff --git a/_docs_/_static/menu.js b/_docs_/_static/menu.js new file mode 100644 index 0000000..c7ab03e --- /dev/null +++ b/_docs_/_static/menu.js @@ -0,0 +1,57 @@ +document.addEventListener("DOMContentLoaded", function () { + + // Make tables responsive by wrapping them in a div and making them scrollable + const tables = document.querySelectorAll("table.docutils") + tables.forEach(function(table){ + table.outerHTML = '
' + table.outerHTML + "
" + }) + + const togglerInput = document.querySelector(".toggler__input") + const togglerLabel = document.querySelector(".toggler__label") + const sideMenu = document.querySelector(".menu-wrapper") + const menuItems = document.querySelectorAll(".menu") + const doc = document.querySelector(".document") + const body = document.querySelector("body") + + function closeMenu() { + togglerInput.checked = false + sideMenu.setAttribute("aria-expanded", "false") + sideMenu.setAttribute("aria-hidden", "true") + togglerLabel.setAttribute("aria-pressed", "false") + body.style.overflow = "visible" + } + function openMenu() { + togglerInput.checked = true + sideMenu.setAttribute("aria-expanded", "true") + sideMenu.setAttribute("aria-hidden", "false") + togglerLabel.setAttribute("aria-pressed", "true") + body.style.overflow = "hidden" + } + + // Close menu when link on the sideMenu is clicked + sideMenu.addEventListener("click", function (event) { + let target = event.target + if (target.tagName.toLowerCase() !== "a") { + return + } + closeMenu() + }) + // Add accessibility data when sideMenu is opened/closed + togglerInput.addEventListener("change", function (_event) { + togglerInput.checked ? openMenu() : closeMenu() + }) + // Make sideMenu links tabbable only when visible + for(let menuItem of menuItems) { + if(togglerInput.checked) { + menuItem.setAttribute("tabindex", "0") + } else { + menuItem.setAttribute("tabindex", "-1") + } + } + // Close sideMenu when document body is clicked + doc.addEventListener("click", function () { + if (togglerInput.checked) { + closeMenu() + } + }) +}) diff --git a/_docs_/_static/minus.png b/_docs_/_static/minus.png new file mode 100644 index 0000000000000000000000000000000000000000..d96755fdaf8bb2214971e0db9c1fd3077d7c419d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu=nj kDsEF_5m^0CR;1wuP-*O&G^0G}KYk!hp00i_>zopr08q^qX#fBK literal 0 HcmV?d00001 diff --git a/_docs_/_static/plus.png b/_docs_/_static/plus.png new file mode 100644 index 0000000000000000000000000000000000000000..7107cec93a979b9a5f64843235a16651d563ce2d GIT binary patch literal 90 zcmeAS@N?(olHy`uVBq!ia0vp^+#t*WBp7;*Yy1LIik>cxAr*|t7R?Mi>2?kWtu>-2 m3q%Vub%g%s<8sJhVPMczOq}xhg9DJoz~JfX=d#Wzp$Pyb1r*Kz literal 0 HcmV?d00001 diff --git a/_docs_/_static/py.png b/_docs_/_static/py.png new file mode 100644 index 0000000000000000000000000000000000000000..93e4a02c3d321c545898a2ebb8873c26dd8a9e5b GIT binary patch literal 695 zcmV;o0!aOdP)Px#24YJ`L;(K){{a7>y{D4^000SaNLh0L01FcU01FcV0GgZ_00007bV*G`2iOD~ z5jY_RGbdgE00K8jL_t(I%Vm>KNL4`;hrfH@vv+$Uln|xSCTLTOHmzE;5FTwpDtJ)a zz)exE-2_34AR^i+ZCXeh7m*-F5k*FrmbSHs%rX_!{PXUec{69`w(#D(>Vd<+%=bIz zH_V)XUD5sE?K5ebbKaSDu}#Dnq^Y!3`tis9>wSO*T+WBP3wS3NNBU~*PAtw^yjZ+< zQ5yK0z%d{y@_Pz6YdL>s7$6Y^hI$}5GUX?Ns>+iCUiRP z7h|*&%kQa?wQA%pYzqpaf*4?WM!x_ygY0K@07rplx^QhGhnE)r4wbx0x11<&3V?63 z=F8ch)p6iQ88E;iumPmSZif%JIwIgKh$T3)*ab8ImGLVf;IoYtVAb11Z&@wm>96=S z)!B&hojbAPoik&f)Lp;=N!HK;X~5oyfJ49$pbcorTyADv dm$H!t;2#0MumAjv0Ga>*002ovPDHLkV1gIiH5UK? literal 0 HcmV?d00001 diff --git a/_docs_/_static/py.svg b/_docs_/_static/py.svg new file mode 100644 index 0000000..90b6c90 --- /dev/null +++ b/_docs_/_static/py.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/_docs_/_static/pydoctheme.css b/_docs_/_static/pydoctheme.css new file mode 100644 index 0000000..4873116 --- /dev/null +++ b/_docs_/_static/pydoctheme.css @@ -0,0 +1,773 @@ +/* Common colours */ +:root { + --good-color: rgb(41 100 51); + --good-border: rgb(79 196 100); + --middle-color: rgb(133 72 38); + --middle-border: rgb(244, 227, 76); + --bad-color: rgb(159 49 51); + --bad-border: rgb(244, 76, 78); +} + +/* unset some styles from the classic stylesheet */ +div.document, +div.body, +div.related, +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6, +div.sphinxsidebar a, +div.sphinxsidebar p, +div.sphinxsidebar ul, +div.sphinxsidebar h3, +div.sphinxsidebar h3 a, +div.sphinxsidebar h4, +.menu a, +.menu p, +.menu ul, +.menu h3, +.menu h3 a, +.menu h4, +table.docutils td, +table.indextable tr.cap, +pre { + background-color: inherit; + color: inherit; +} + +/* Add underlines to links */ +a[href] { + text-decoration: underline 1px; +} + +/* Increase the underline offset for code to avoid obscuring underscores */ +a[href]:has(> code) { + text-underline-offset: 0.25em; +} + +/* No underline for navigation */ +a.headerlink, +div.genindex-jumpbox a, +div.modindex-jumpbox a, +div#search-results a, +div.sphinxsidebar a, +div.toctree-wrapper a, +div[role=navigation] a, +table.contentstable a, +table.indextable a { + text-decoration: none; +} + +/* Except when hovered */ +div.genindex-jumpbox a:hover, +div.modindex-jumpbox a:hover, +div#search-results a:hover, +div.sphinxsidebar a:hover, +div.toctree-wrapper a:hover, +div[role=navigation] a:hover, +table.contentstable a:hover, +table.indextable a:hover { + text-decoration: underline; + text-underline-offset: auto; +} + +body { + margin-left: 1em; + margin-right: 1em; +} + +.mobile-nav, +.menu-wrapper { + display: none; +} + +div.related { + margin-top: 0.5em; + margin-bottom: 1.2em; + padding: 0.5em 0; + border-width: 1px; + border-color: #ccc; +} + +.mobile-nav + div.related { + border-bottom-style: solid; +} + +.document + div.related { + border-top-style: solid; +} + +div.related a:hover { + color: #0095c4; +} + +.related .switchers { + display: inline-flex; +} + +.switchers > div { + margin-right: 5px; +} + +div.related ul::after { + content: ''; + clear: both; + display: block; +} + +.inline-search, +form.inline-search input { + display: inline; +} + +form.inline-search input[type='submit'] { + width: 40px; +} + +div.document { + display: flex; + /* Don't let long code literals extend beyond the right side of the screen */ + overflow-wrap: break-word; +} + +/* Don't let long code literals extend beyond the right side of the screen */ +span.pre { + white-space: unset; +} + +div.sphinxsidebar { + display: flex; + width: min(25vw, 350px); + float: none; + position: sticky; + top: 0; + max-height: 100vh; + color: #444; + background-color: #eee; + border-radius: 5px; + line-height: 130%; + font-size: smaller; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + margin-top: 1.5em; +} + +div.bodywrapper { + margin-left: min(25vw, 350px); +} + +div.sphinxsidebarwrapper { + box-sizing: border-box; + height: 100%; + overflow-x: hidden; + overflow-y: auto; + float: none; + flex-grow: 1; +} + +div.sphinxsidebarwrapper > h3:first-child { + margin-top: 0.2em; +} + +div.sphinxsidebarwrapper > ul > li > ul > li { + margin-bottom: 0.4em; +} + +div.sphinxsidebar a:hover { + color: #0095c4; +} + +form.inline-search input, +div.sphinxsidebar input, +div.related input { + font-family: -apple-system, BlinkMacSystemFont, avenir next, avenir, segoe ui, helvetica neue, helvetica, Cantarell, Ubuntu, roboto, noto, arial, sans-serif; + border: 1px solid #999999; + font-size: smaller; + border-radius: 3px; +} + +div.sphinxsidebar input[type='text'] { + max-width: 150px; +} + +#sidebarbutton { + display: flex; + justify-content: center; + align-items: center; + width: 12px; + min-width: 12px; + border-radius: 0 5px 5px 0; + border-left: none; +} + +#sidebarbutton:hover { + background-color: #AAAAAA; +} + +div.body { + padding: 0 0 0 1.2em; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + text-align: left; + line-height: 1.6; +} +div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6 { + margin: 0; + border: 0; + padding: 0.3em 0; +} + +div.body hr { + border: 0; + background-color: #ccc; + height: 1px; +} + +div.body pre { + border-radius: 3px; + border: 1px solid #ac9; +} + +/* Admonitions */ +:root { + --admonition-background: #eee; + --admonition-border: #ccc; + --admonition-color: black; + --attention-background: #bbddff5c; + --attention-border: #0000ff36; + --caution-background: #ffc; + --caution-border: #dd6; + --danger-background: #ffe4e4; + --danger-border: red; + --error-background: #ffe4e4; + --error-border: red; + --hint-background: #dfd; + --hint-border: green; + --seealso-background: #ffc; + --seealso-border: #dd6; + --tip-background: #dfd; + --tip-border: green; + --warning-background: #ffe4e4; + --warning-border: red; +} + +div.body div.admonition { + background-color: var(--admonition-background); + border: 1px solid var(--admonition-border); + border-radius: 3px; + color: var(--admonition-color); +} + +div.body div.admonition.attention { + background-color: var(--attention-background); + border-color: var(--attention-border); +} + +div.body div.admonition.caution { + background-color: var(--caution-background); + border-color: var(--caution-border); +} + +div.body div.admonition.danger { + background-color: var(--danger-background); + border-color: var(--danger-border); +} + +div.body div.admonition.error { + background-color: var(--error-background); + border-color: var(--error-border); +} + +div.body div.admonition.hint { + background-color: var(--hint-background); + border-color: var(--hint-border); +} + +div.body div.admonition.seealso { + background-color: var(--seealso-background); + border-color: var(--seealso-border); +} + +div.body div.admonition.tip { + background-color: var(--tip-background); + border-color: var(--tip-border); +} + +div.body div.admonition.warning { + background-color: var(--warning-background); + border-color: var(--warning-border); +} + +div.body div.impl-detail { + border-radius: 3px; +} + +div.body div.impl-detail > p { + margin: 0; +} + +div.body a { + color: #0072aa; +} + +div.body a:visited { + color: #6363bb; +} + +div.body a:hover { + color: #00b0e4; +} + +tt, code, pre { + font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace; + font-size: 96.5%; +} + +div.body pre { + line-height: 120%; +} + +div.body tt, +div.body code { + border-radius: 3px; +} + +div.body tt.descname, +div.body code.descname { + font-size: 120%; +} + +div.body tt.xref, +div.body a tt, +div.body code.xref, +div.body a code { + font-weight: normal; +} + +table.docutils { + border: 1px solid #ddd; + min-width: 20%; + border-radius: 3px; + margin-top: 10px; + margin-bottom: 10px; +} + +table.docutils td, +table.docutils th { + border: 1px solid #ddd !important; + border-radius: 3px; + padding: 0.3em 0.5em; +} + +table p, +table li { + text-align: left !important; +} + +table.docutils th { + background-color: #eee; +} + +table.footnote, +table.footnote td { + border: 0 !important; +} + +div.footer { + line-height: 150%; + text-align: right; + width: auto; + margin-right: 10px; +} + +div.footer a { + text-underline-offset: auto; +} + +div.footer a:hover { + color: #0095c4; +} + +/* C API return value annotations */ +:root { + --refcount: var(--good-color); + --refcount-return-borrowed-ref: var(--middle-color); +} + +.refcount { + color: var(--refcount); +} + +.refcount.return_borrowed_ref { + color: var(--refcount-return-borrowed-ref) +} + +.stableabi { + color: #229; +} + +dl > dt span ~ em, +.sig { + font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace; +} + +.toctree-wrapper ul { + padding-left: 20px; +} + +.theme-selector { + margin-left: .5em; +} + +div.genindex-jumpbox, +div.genindex-jumpbox > p { + display: inline-flex; + flex-wrap: wrap; +} + +div.genindex-jumpbox a { + margin: 0 5px; + min-width: 30px; + text-align: center; +} + +.copybutton { + cursor: pointer; + position: absolute; + top: 0; + right: 0; + font-family: Menlo, Consolas, Monaco, Liberation Mono, Lucida Console, monospace; + font-size: 80%; + padding-left: .5em; + padding-right: .5em; + height: 100%; + max-height: min(100%, 2.4em); + border-radius: 0 3px 0 0; + color: #000; + background-color: #fff; + border: 1px solid #ac9; /* follows div.body pre */ + display: none; +} + +.copybutton:hover { + background-color: #eee; +} + +.copybutton:active { + background-color: #ddd; +} + +.highlight:active .copybutton { + display: block; +} + +.highlight:hover .copybutton { + display: block; +} + +@media (max-width: 1023px) { + /* Body layout */ + div.body { + min-width: 100%; + padding: 0; + font-size: 0.875rem; + } + div.bodywrapper { + margin: 0; + } + /* Typography */ + div.body h1 { + font-size: 1.625rem; + } + div.body h2 { + font-size: 1.25rem; + } + div.body h3, div.body h4, div.body h5 { + font-size: 1rem; + } + /* Override default styles to make more readable */ + div.body ul { + padding-inline-start: 1rem; + } + div.body blockquote { + margin-inline-start: 1rem; + margin-inline-end: 0; + } + /* Remove sidebar and top related bar */ + div.related, div.sphinxsidebar { + display: none; + } + /* Anchorlinks are not hidden by fixed-positioned navbar when scrolled to */ + html { + scroll-padding-top: 40px; + } + body { + margin-top: 40px; + } + + /* Top navigation bar */ + .mobile-nav { + display: block; + height: 40px; + width: 100%; + position: fixed; + top: 0; + left: 0; + box-shadow: rgba(0, 0, 0, 0.25) 0 0 2px 0; + z-index: 1; + } + .mobile-nav * { + box-sizing: border-box; + } + .nav-content { + position: absolute; + z-index: 1; + height: 40px; + width: 100%; + display: flex; + background-color: white; + } + .nav-items-wrapper { + display: flex; + flex: auto; + padding: .25rem; + align-items: stretch; + } + .nav-logo { + margin-right: 1rem; + flex-shrink: 0; + align-self: center; + } + .nav-content img { + display: block; + width: 20px; + } + .version_switcher_placeholder { + margin-right: 1rem; + } + .version_switcher_placeholder > select { + height: 100%; + } + .nav-content .search { + display: flex; + flex: auto; + border: 1px solid #a9a9a9; + align-items: stretch; + } + .nav-content .search input[type=search] { + border: 0; + padding-left: 24px; + width: 100%; + flex: 1; + } + .nav-content .search input[type=submit] { + height: 100%; + box-shadow: none; + border: 0; + border-left: 1px solid #a9a9a9; + cursor: pointer; + margin-right: 0; + } + .nav-content .search svg { + position: absolute; + align-self: center; + padding-left: 4px; + } + .toggler__input { + display: none; + } + .toggler__label { + width: 40px; + cursor: pointer; + display: flex; + align-items: center; + justify-content: center; + padding: 8px; + flex-shrink: 0; + } + .toggler__label:hover, .toggler__label:focus { + background-color: rgba(127 127 127 / 50%); + } + .toggler__label > span { + position: relative; + flex: none; + height: 2px; + width: 100%; + background: currentColor; + transition: all 400ms ease; + } + .toggler__label > span::before, + .toggler__label > span::after { + content: ''; + height: 2px; + width: 100%; + background: inherit; + position: absolute; + left: 0; + top: -8px; + } + .toggler__label > span::after { + top: 8px; + } + .toggler__input:checked ~ nav > .toggler__label span { + transform: rotate(135deg); + } + .toggler__input:checked ~ nav > .toggler__label span::before { + transform: rotate(90deg); + } + .toggler__input:checked ~ nav > .toggler__label span::before, + .toggler__input:checked ~ nav > .toggler__label span::after { + top: 0; + } + .toggler__input:checked:hover ~ nav > .toggler__label span { + transform: rotate(315deg); + } + .toggler__input:checked ~ .menu-wrapper { + visibility: visible; + left: 0; + } + + /* Sliding side menu */ + .menu-wrapper { + display: block; + position: fixed; + top: 0; + transition: left 400ms ease; + left: -310px; + width: 300px; + height: 100%; + background-color: #eee; + color: #444444; + box-shadow: 0 0 10px rgba(0, 0, 0, 0.2); + overflow-y: auto; + } + .menu-wrapper.open { + visibility: visible; + left: 0; + } + .menu { + padding: 40px 10px 30px 20px; + } + .menu-wrapper h3, + .menu-wrapper h4 { + margin-bottom: 0; + font-weight: normal; + } + .menu-wrapper h4 { + font-size: 1.3em; + } + .menu-wrapper h3 { + font-size: 1.4em; + } + .menu-wrapper h3 + p, + .menu-wrapper h4 + p { + margin-top: 0.5rem; + } + .menu a { + font-size: smaller; + text-decoration: none; + } + .menu ul { + list-style: none; + line-height: 1.4; + overflow-wrap: break-word; + padding-left: 0; + } + .menu ul ul { + margin-left: 20px; + list-style: square; + } + .menu ul li { + margin-bottom: 0.5rem; + } + .language_switcher_placeholder { + margin-top: 2rem; + } + .language_switcher_placeholder select { + width: 100%; + } + .document { + position: relative; + z-index: 0; + } + /*Responsive tables*/ + .responsive-table__container { + width: 100%; + overflow-x: auto; + } + + .menu .theme-selector-label { + margin-top: .5em; + display: flex; + width: 100%; + } + + .menu .theme-selector { + flex: auto; + } +} + +@media (min-width: 1024px) { + div.footer { + margin-top: -2em; + } +} + +/* Version change directives */ +:root { + --versionadded: var(--good-color); + --versionchanged: var(--middle-color); + --deprecated: var(--bad-color); + + --versionadded-border: var(--good-border); + --versionchanged-border: var(--middle-border); + --deprecated-border: var(--bad-border); +} + +div.versionadded, +div.versionchanged, +div.deprecated, +div.deprecated-removed { + border-left: 3px solid; + padding: 0 1rem; +} + +div.versionadded { + border-left-color: var(--versionadded-border); +} + +div.versionchanged { + border-left-color: var(--versionchanged-border); +} + +div.deprecated, +div.deprecated-removed, +div.versionremoved { + border-left-color: var(--deprecated-border); +} + +div.versionadded .versionmodified { + color: var(--versionadded); +} + +div.versionchanged .versionmodified { + color: var(--versionchanged); +} + +div.deprecated .versionmodified, +div.deprecated-removed .versionmodified, +div.versionremoved .versionmodified { + color: var(--deprecated); +} + +/* Hide header when printing */ +@media print { + div.mobile-nav { + display: none; + } +} diff --git a/_docs_/_static/pydoctheme_dark.css b/_docs_/_static/pydoctheme_dark.css new file mode 100644 index 0000000..582e4dd --- /dev/null +++ b/_docs_/_static/pydoctheme_dark.css @@ -0,0 +1,191 @@ +/* Common colours */ +:root { + --good-color: rgb(79 196 100); + --good-border: var(--good-color); + --middle-color: rgb(244, 227, 76); + --middle-border: var(--middle-color); + --bad-color: rgb(244, 76, 78); + --bad-border: var(--bad-color); +} + + +/* Browser elements */ +:root { + scrollbar-color: #616161 transparent; + color-scheme: dark; +} + +html, +body { + background-color: #222; + color: rgba(255, 255, 255, 0.87); +} + +div.related { + color: rgba(255, 255, 255, 0.7); /* classic overwrite */ + border-color: #424242; +} + +/* SIDEBAR */ +div.sphinxsidebar, .menu-wrapper { + background-color: #333; + color: inherit; +} + +#sidebarbutton { + /* important to overwrite style attribute */ + background-color: #555 !important; + color: inherit !important; +} + +div.sidebar, aside.sidebar { + background-color: #424242; + border-color: #616161; +} + +/* ANCHORS AND HIGHLIGHTS */ +div.body a { + color: #7af; +} + +div.body a:visited { + color: #09e; +} + +a.headerlink:hover { + background-color: #424242; +} + +div.related a { + color: currentColor; +} + +div.footer, +div.footer a { + color: currentColor; /* classic overwrites */ +} + +dt:target, +span.highlighted { + background-color: #616161; +} + +.footnote:target { + background-color: #2c3e50; +} + +/* Below for most things in text */ + +dl.field-list > dt { + background-color: #434; +} + +table.docutils td, +table.docutils th { + border-color: #616161 !important; +} + +table.docutils th { + background-color: #424242; +} + +.stableabi { + color: #bbf; +} + +div.body pre { + border-color: #616161; +} + +code { + background-color: #424242; +} + +div.body div.seealso { + background-color: rgba(255, 255, 0, 0.1); +} + +div.warning { + background-color: rgba(255, 0, 0, 0.2); +} + +.warning code { + background-color: rgba(255, 0, 0, 0.5); +} + +/* Admonitions */ +:root { + --admonition-background: #ffffff1a; + --admonition-border: currentColor; + --admonition-color: #ffffffde; + --attention-background: #ffffff1a; + --attention-border: currentColor; + --caution-background: #ffff001a; + --caution-border: #dd6; + --danger-background: #f003; + --danger-border: #f66; + --error-background: #f003; + --error-border: #f66; + --hint-background: #0044117a; + --hint-border: green; + --seealso-background: #ffff001a; + --seealso-border: #dd6; + --tip-background: #0044117a; + --tip-border: green; + --warning-background: #ff000033; + --warning-border: #ff6666; +} + +aside.topic, +div.topic, +div.note, +nav.contents { + background-color: rgba(255, 255, 255, 0.1); + border-color: currentColor; +} + +.note code { + background-color: rgba(255, 255, 255, 0.1); +} + +.mobile-nav { + box-shadow: rgba(255, 255, 255, 0.25) 0 0 2px 0; +} + +.nav-content { + background-color: black; +} + +img.invert-in-dark-mode { + filter: invert(1) hue-rotate(.5turn); +} + +/* -- object description styles --------------------------------------------- */ + +/* C++ specific styling */ + +/* Override Sphinx's basic.css to fix colour contrast */ +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #5283ff; +} + +/* Version change directives */ +:root { + --versionadded: var(--good-color); + --versionchanged: var(--middle-color); + --deprecated: var(--bad-color); +} + +.copybutton { + color: #ac9; /* follows div.body pre */ + background-color: #222222; /* follows body */ +} + +.copybutton:hover { + background-color: #434343; +} + +.copybutton:active { + background-color: #656565; +} diff --git a/_docs_/_static/pygments.css b/_docs_/_static/pygments.css new file mode 100644 index 0000000..6f8b210 --- /dev/null +++ b/_docs_/_static/pygments.css @@ -0,0 +1,75 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; 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: #f8f8f8; } +.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */ +.highlight .err { border: 1px solid #F00 } /* Error */ +.highlight .k { color: #008000; font-weight: bold } /* Keyword */ +.highlight .o { color: #666 } /* Operator */ +.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */ +.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */ +.highlight .cp { color: #9C6500 } /* Comment.Preproc */ +.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */ +.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */ +.highlight .cs { color: #3D7B7B; font-style: italic } /* 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: #E40000 } /* Generic.Error */ +.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ +.highlight .gi { color: #008400 } /* Generic.Inserted */ +.highlight .go { color: #717171 } /* Generic.Output */ +.highlight .gp { color: #000080; 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: #008000; font-weight: bold } /* Keyword.Constant */ +.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ +.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ +.highlight .kp { color: #008000 } /* Keyword.Pseudo */ +.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ +.highlight .kt { color: #B00040 } /* Keyword.Type */ +.highlight .m { color: #666 } /* Literal.Number */ +.highlight .s { color: #BA2121 } /* Literal.String */ +.highlight .na { color: #687822 } /* Name.Attribute */ +.highlight .nb { color: #008000 } /* Name.Builtin */ +.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */ +.highlight .no { color: #800 } /* Name.Constant */ +.highlight .nd { color: #A2F } /* Name.Decorator */ +.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */ +.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */ +.highlight .nf { color: #00F } /* Name.Function */ +.highlight .nl { color: #767600 } /* Name.Label */ +.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */ +.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */ +.highlight .nv { color: #19177C } /* Name.Variable */ +.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */ +.highlight .w { color: #BBB } /* Text.Whitespace */ +.highlight .mb { color: #666 } /* Literal.Number.Bin */ +.highlight .mf { color: #666 } /* Literal.Number.Float */ +.highlight .mh { color: #666 } /* Literal.Number.Hex */ +.highlight .mi { color: #666 } /* Literal.Number.Integer */ +.highlight .mo { color: #666 } /* Literal.Number.Oct */ +.highlight .sa { color: #BA2121 } /* Literal.String.Affix */ +.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */ +.highlight .sc { color: #BA2121 } /* Literal.String.Char */ +.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */ +.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ +.highlight .s2 { color: #BA2121 } /* Literal.String.Double */ +.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */ +.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */ +.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */ +.highlight .sx { color: #008000 } /* Literal.String.Other */ +.highlight .sr { color: #A45A77 } /* Literal.String.Regex */ +.highlight .s1 { color: #BA2121 } /* Literal.String.Single */ +.highlight .ss { color: #19177C } /* Literal.String.Symbol */ +.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #00F } /* Name.Function.Magic */ +.highlight .vc { color: #19177C } /* Name.Variable.Class */ +.highlight .vg { color: #19177C } /* Name.Variable.Global */ +.highlight .vi { color: #19177C } /* Name.Variable.Instance */ +.highlight .vm { color: #19177C } /* Name.Variable.Magic */ +.highlight .il { color: #666 } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_docs_/_static/pygments_dark.css b/_docs_/_static/pygments_dark.css new file mode 100644 index 0000000..a5da35b --- /dev/null +++ b/_docs_/_static/pygments_dark.css @@ -0,0 +1,85 @@ +pre { line-height: 125%; } +td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; } +span.linenos { color: inherit; 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: #49483e } +.highlight { background: #272822; color: #F8F8F2 } +.highlight .c { color: #959077 } /* Comment */ +.highlight .err { color: #ED007E; background-color: #1E0010 } /* Error */ +.highlight .esc { color: #F8F8F2 } /* Escape */ +.highlight .g { color: #F8F8F2 } /* Generic */ +.highlight .k { color: #66D9EF } /* Keyword */ +.highlight .l { color: #AE81FF } /* Literal */ +.highlight .n { color: #F8F8F2 } /* Name */ +.highlight .o { color: #FF4689 } /* Operator */ +.highlight .x { color: #F8F8F2 } /* Other */ +.highlight .p { color: #F8F8F2 } /* Punctuation */ +.highlight .ch { color: #959077 } /* Comment.Hashbang */ +.highlight .cm { color: #959077 } /* Comment.Multiline */ +.highlight .cp { color: #959077 } /* Comment.Preproc */ +.highlight .cpf { color: #959077 } /* Comment.PreprocFile */ +.highlight .c1 { color: #959077 } /* Comment.Single */ +.highlight .cs { color: #959077 } /* Comment.Special */ +.highlight .gd { color: #FF4689 } /* Generic.Deleted */ +.highlight .ge { color: #F8F8F2; font-style: italic } /* Generic.Emph */ +.highlight .ges { color: #F8F8F2; font-weight: bold; font-style: italic } /* Generic.EmphStrong */ +.highlight .gr { color: #F8F8F2 } /* Generic.Error */ +.highlight .gh { color: #F8F8F2 } /* Generic.Heading */ +.highlight .gi { color: #A6E22E } /* Generic.Inserted */ +.highlight .go { color: #66D9EF } /* Generic.Output */ +.highlight .gp { color: #FF4689; font-weight: bold } /* Generic.Prompt */ +.highlight .gs { color: #F8F8F2; font-weight: bold } /* Generic.Strong */ +.highlight .gu { color: #959077 } /* Generic.Subheading */ +.highlight .gt { color: #F8F8F2 } /* Generic.Traceback */ +.highlight .kc { color: #66D9EF } /* Keyword.Constant */ +.highlight .kd { color: #66D9EF } /* Keyword.Declaration */ +.highlight .kn { color: #FF4689 } /* Keyword.Namespace */ +.highlight .kp { color: #66D9EF } /* Keyword.Pseudo */ +.highlight .kr { color: #66D9EF } /* Keyword.Reserved */ +.highlight .kt { color: #66D9EF } /* Keyword.Type */ +.highlight .ld { color: #E6DB74 } /* Literal.Date */ +.highlight .m { color: #AE81FF } /* Literal.Number */ +.highlight .s { color: #E6DB74 } /* Literal.String */ +.highlight .na { color: #A6E22E } /* Name.Attribute */ +.highlight .nb { color: #F8F8F2 } /* Name.Builtin */ +.highlight .nc { color: #A6E22E } /* Name.Class */ +.highlight .no { color: #66D9EF } /* Name.Constant */ +.highlight .nd { color: #A6E22E } /* Name.Decorator */ +.highlight .ni { color: #F8F8F2 } /* Name.Entity */ +.highlight .ne { color: #A6E22E } /* Name.Exception */ +.highlight .nf { color: #A6E22E } /* Name.Function */ +.highlight .nl { color: #F8F8F2 } /* Name.Label */ +.highlight .nn { color: #F8F8F2 } /* Name.Namespace */ +.highlight .nx { color: #A6E22E } /* Name.Other */ +.highlight .py { color: #F8F8F2 } /* Name.Property */ +.highlight .nt { color: #FF4689 } /* Name.Tag */ +.highlight .nv { color: #F8F8F2 } /* Name.Variable */ +.highlight .ow { color: #FF4689 } /* Operator.Word */ +.highlight .pm { color: #F8F8F2 } /* Punctuation.Marker */ +.highlight .w { color: #F8F8F2 } /* Text.Whitespace */ +.highlight .mb { color: #AE81FF } /* Literal.Number.Bin */ +.highlight .mf { color: #AE81FF } /* Literal.Number.Float */ +.highlight .mh { color: #AE81FF } /* Literal.Number.Hex */ +.highlight .mi { color: #AE81FF } /* Literal.Number.Integer */ +.highlight .mo { color: #AE81FF } /* Literal.Number.Oct */ +.highlight .sa { color: #E6DB74 } /* Literal.String.Affix */ +.highlight .sb { color: #E6DB74 } /* Literal.String.Backtick */ +.highlight .sc { color: #E6DB74 } /* Literal.String.Char */ +.highlight .dl { color: #E6DB74 } /* Literal.String.Delimiter */ +.highlight .sd { color: #E6DB74 } /* Literal.String.Doc */ +.highlight .s2 { color: #E6DB74 } /* Literal.String.Double */ +.highlight .se { color: #AE81FF } /* Literal.String.Escape */ +.highlight .sh { color: #E6DB74 } /* Literal.String.Heredoc */ +.highlight .si { color: #E6DB74 } /* Literal.String.Interpol */ +.highlight .sx { color: #E6DB74 } /* Literal.String.Other */ +.highlight .sr { color: #E6DB74 } /* Literal.String.Regex */ +.highlight .s1 { color: #E6DB74 } /* Literal.String.Single */ +.highlight .ss { color: #E6DB74 } /* Literal.String.Symbol */ +.highlight .bp { color: #F8F8F2 } /* Name.Builtin.Pseudo */ +.highlight .fm { color: #A6E22E } /* Name.Function.Magic */ +.highlight .vc { color: #F8F8F2 } /* Name.Variable.Class */ +.highlight .vg { color: #F8F8F2 } /* Name.Variable.Global */ +.highlight .vi { color: #F8F8F2 } /* Name.Variable.Instance */ +.highlight .vm { color: #F8F8F2 } /* Name.Variable.Magic */ +.highlight .il { color: #AE81FF } /* Literal.Number.Integer.Long */ \ No newline at end of file diff --git a/_docs_/_static/search-focus.js b/_docs_/_static/search-focus.js new file mode 100644 index 0000000..aa5b42f --- /dev/null +++ b/_docs_/_static/search-focus.js @@ -0,0 +1,21 @@ +function isInputFocused() { + const activeElement = document.activeElement; + return ( + activeElement.tagName === 'INPUT' || + activeElement.tagName === 'TEXTAREA' || + activeElement.isContentEditable + ); +} + +document.addEventListener('keydown', function(event) { + if (event.key === '/') { + if (!isInputFocused()) { + // Prevent "/" from being entered in the search box + event.preventDefault(); + + // Set the focus on the search box + const searchBox = document.getElementById('search-box'); + searchBox.focus(); + } + } +}); diff --git a/_docs_/_static/searchtools.js b/_docs_/_static/searchtools.js new file mode 100644 index 0000000..91f4be5 --- /dev/null +++ b/_docs_/_static/searchtools.js @@ -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); diff --git a/_docs_/_static/sidebar.js b/_docs_/_static/sidebar.js new file mode 100644 index 0000000..ac7b39e --- /dev/null +++ b/_docs_/_static/sidebar.js @@ -0,0 +1,64 @@ +/* + * This script makes the Sphinx sidebar collapsible. + * + * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds + * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton + * used to collapse and expand the sidebar. + * + * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden + * and the width of the sidebar and the margin-left of the document + * are decreased. When the sidebar is expanded the opposite happens. + * This script saves a per-browser/per-session cookie used to + * remember the position of the sidebar among the pages. + * Once the browser is closed the cookie is deleted and the position + * reset to the default (expanded). + * + */ + +const initialiseSidebar = () => { + + + + + // global elements used by the functions. + const bodyWrapper = document.getElementsByClassName("bodywrapper")[0] + const sidebar = document.getElementsByClassName("sphinxsidebar")[0] + const sidebarWrapper = document.getElementsByClassName('sphinxsidebarwrapper')[0] + const sidebarButton = document.getElementById("sidebarbutton") + const sidebarArrow = sidebarButton.querySelector('span') + + // for some reason, the document has no sidebar; do not run into errors + if (typeof sidebar === "undefined") return; + + const flipArrow = element => element.innerText = (element.innerText === "»") ? "«" : "»" + + const collapse_sidebar = () => { + bodyWrapper.style.marginLeft = ".8em"; + sidebar.style.width = ".8em" + sidebarWrapper.style.display = "none" + flipArrow(sidebarArrow) + sidebarButton.title = _('Expand sidebar') + window.localStorage.setItem("sidebar", "collapsed") + } + + const expand_sidebar = () => { + bodyWrapper.style.marginLeft = "" + sidebar.style.removeProperty("width") + sidebarWrapper.style.display = "" + flipArrow(sidebarArrow) + sidebarButton.title = _('Collapse sidebar') + window.localStorage.setItem("sidebar", "expanded") + } + + sidebarButton.addEventListener("click", () => { + (sidebarWrapper.style.display === "none") ? expand_sidebar() : collapse_sidebar() + }) + + if (!window.localStorage.getItem("sidebar")) return + const value = window.localStorage.getItem("sidebar") + if (value === "collapsed") collapse_sidebar(); + else if (value === "expanded") expand_sidebar(); +} + +if (document.readyState !== "loading") initialiseSidebar() +else document.addEventListener("DOMContentLoaded", initialiseSidebar) \ No newline at end of file diff --git a/_docs_/_static/sphinx_highlight.js b/_docs_/_static/sphinx_highlight.js new file mode 100644 index 0000000..8a96c69 --- /dev/null +++ b/_docs_/_static/sphinx_highlight.js @@ -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( + '

' + + '' + + _("Hide Search Matches") + + "

" + ) + ); + }, + + /** + * 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(); +}); diff --git a/_docs_/_static/themetoggle.js b/_docs_/_static/themetoggle.js new file mode 100644 index 0000000..f9394c6 --- /dev/null +++ b/_docs_/_static/themetoggle.js @@ -0,0 +1,24 @@ +const pydocthemeDark = document.getElementById('pydoctheme_dark_css') +const pygmentsDark = document.getElementById('pygments_dark_css') +const themeSelectors = document.getElementsByClassName('theme-selector') + +function activateTheme(theme) { + localStorage.setItem('currentTheme', theme); + [...themeSelectors].forEach(e => e.value = theme) + switch (theme) { + case 'light': + pydocthemeDark.media = 'not all' + pygmentsDark.media = 'not all' + break; + case 'dark': + pydocthemeDark.media = 'all' + pygmentsDark.media = 'all' + break; + default: + // auto + pydocthemeDark.media = '(prefers-color-scheme: dark)' + pygmentsDark.media = '(prefers-color-scheme: dark)' + } +} + +activateTheme(localStorage.getItem('currentTheme') || 'auto') diff --git a/_docs_/genindex.html b/_docs_/genindex.html new file mode 100644 index 0000000..6d015d7 --- /dev/null +++ b/_docs_/genindex.html @@ -0,0 +1,501 @@ + + + + + + + Index — geo documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + + +
+
+
+
+ + +

Index

+ +
+ A + | B + | C + | D + | E + | G + | H + | I + | J + | L + | M + | N + | O + | P + | S + | T + +
+

A

+ + + +
+ +

B

+ + +
+ +

C

+ + + +
+ +

D

+ + +
+ +

E

+ + + +
+ +

G

+ + + +
+ +

H

+ + + +
+ +

I

+ + + +
+ +

J

+ + +
+ +

L

+ + + +
+ +

M

+ + + +
+ +

N

+ + +
+ +

O

+ + + +
+ +

P

+ + + +
+ +

S

+ + + +
+ +

T

+ + + +
+ + + +
+
+
+
+ +
+
+ +
+ © + Copyright + 2025, Dirk Alders. +
+ This page is licensed under the Python Software Foundation License Version 2. +
+ Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. +
+ + +
+ + The Python Software Foundation is a non-profit corporation. +Please donate. +
+
+ +
+ + Created using Sphinx 8.2.3. +
+ + + \ No newline at end of file diff --git a/_docs_/index.html b/_docs_/index.html new file mode 100644 index 0000000..f695b0d --- /dev/null +++ b/_docs_/index.html @@ -0,0 +1,1003 @@ + + + + + + + + geo package — geo documentation + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + + +
+
+
+
+ +
+

geo package

+
+

geo (Geographic)

+

Author:

+ +

Description:

+
+

This Module support functionalities around geographic issues.

+
+

Submodules:

+ +

Unittest:

+
+

See also the unittest documentation.

+
+
+
+

Submodules

+
+
+

geo.gps module

+
+

geo.gps (Geo-Positioning)

+

Author:

+ +

Description:

+
+

This module is a submodule of geo and includes functions and classes for geographic issues (e.g. coordinate, area, tracks, …).

+
+

Contentlist:

+ +

Unittest:

+
+

See also the unittest documentation.

+
+
+
+
+class geo.gps.area(coord1, coord2)
+

Bases: object

+
+
Parameters:
+
+
+
+

Class to store a geographic area and support some calculations.

+

Example:

+
>>> import geo
+
+>>> ar = geo.gps.area(...)
+
+
+
+
+center_pos()
+
+

Warning

+

Needs sphinx documentation!

+
+
+ +
+
+coordinate_in_area(coord)
+
+

Warning

+

Needs sphinx documentation!

+
+
+ +
+
+corner_coordinates()
+
+

Warning

+

Needs sphinx documentation!

+
+
+ +
+
+extend_area(coord)
+
+

Warning

+

Needs sphinx documentation!

+
+
+ +
+
+osm_map(map_code)
+
+
Parameters:
+

map_code – Map code as defined in geo.osm (e.g. geo.osm.MAP_STANDARD)

+
+
+

This Method returns a geo.osm.map instance.

+
+

Warning

+

Needs sphinx documentation!

+
+
+ +
+ +
+
+class geo.gps.coordinate(**kwargs)
+

Bases: dict

+
+
Parameters:
+
    +

  • lon (float) – Londitude

    • +

  • lat (float) – Latitude

    • +

  • height (float) – Height

    • +

  • time (int) – Time (Seconds since 1970)

    • +
+
+
+

Class to store a geographic coodinate and support some calculations.

+

Example:

+
>>> import geo
+
+>>> ab = geo.gps.coordinate(lat=49.976596,lon=9.1481443)
+>>> gb = geo.gps.coordinate(lat=53.6908298,lon=12.1583252)
+>>> ab.dist_to(gb) / 1000
+462.3182843470017
+>>> ab.angle_to(gb) / math.pi * 180
+39.02285256685333
+
+
+
+
+HIGHT = 'hight'
+
+ +
+
+LATITUDE = 'lat'
+
+ +
+
+LONGITUDE = 'lon'
+
+ +
+
+TIME = 'time'
+
+ +
+
+angle_to(coord)
+

This Method calculates the geographic direction in radiant from this to the given coordinate.

+
+

Note

+

North is 0 (turning right). That means east is math.pi/2.

+
+
+
Parameters:
+

coord (corrdinate) – Target coordinate.

+
+
Returns:
+

The geographic direction in radiant.

+
+
Return type:
+

int or float

+
+
+
+ +
+
+dist_to(coord)
+

This Method calcultes the distance from this coordinate to a given coordinate.

+
+
Parameters:
+

coord (coordinate) – Target coordinate.

+
+
Returns:
+

The distance between two coordinates in meters.

+
+
Return type:
+

int or float

+
+
Raises:
+
    +
  • +
+
+
+
+ +
+ +
+
+class geo.gps.track
+

Bases: list

+

Class to store a a tracks and support some calculations.

+

Example:

+
>>> import geo
+
+>>> ...
+
+
+
+
+append(coord)
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+area()
+
+
Return type:
+

geo.gps.area or None

+
+
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+average_speed()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+end_date()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+extend(*args, **kwargs)
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+hightcharacteristic()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+insert(index, coord)
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+name()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+optimized_track()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+osm_map(map_code)
+
+ +
+
+passed_hight()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+set_name(name)
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+speedcharacteristic()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+start_date()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+total_distance()
+
+

Warning

+

Needs to be documented

+
+
+ +
+
+total_time()
+
+

Warning

+

Needs to be documented

+
+
+ +
+ +
+
+class geo.gps.tracklist
+

Bases: list

+

Class to store a a list of tracks and parse xml files created by a navigation system like Etrax Vista.

+

Example:

+
>>> import geo
+
+>>> ...
+
+
+
+
+load_from_file(xmlfilehandle)
+
+

Warning

+

Needs to be documented

+
+
+ +
+ +
+
+

geo.osm module

+
+

geo.osm (Open Streetmap)

+

Author:

+ +

Description:

+
+

This module is a submodule of geo and supports functions and classes for Open Streetmap.

+
+

Contentlist:

+ +

Unittest:

+
+

See also the unittest documentation.

+
+
+
+
+geo.osm.MAP_CYCLEMAP = 'CN'
+

MAP definition for Cyclemap

+
+ +
+
+geo.osm.MAP_HUMANITARIAN = 'HN'
+

MAP definition for Humanitarian Map

+
+ +
+
+geo.osm.MAP_LOCAL_TRAFIC = 'TN'
+

MAP definition for Local Trafic Map

+
+ +
+
+geo.osm.MAP_STANDARD = 'N'
+

MAP definition for Standard Map

+
+ +
+ +
+
Parameters:
+
+
+
Returns:
+

An openstreetmap-url for marking a position in a map.

+
+
Return type:
+

str

+
+
+

This Method generates an openstreetmap-url for marking a position in a map.

+
>>> import geo
+
+>>> gb = geo.gps.coordinate(lat=53.6908298,lon=12.1583252)
+>>> geo.osm.landmark_link(gb)
+'http://www.openstreetmap.org?mlat=53.690830&mlon=12.158325&zoom=13&layers=N'
+
+
+
+ +
+
+class geo.osm.map_spec(**kwargs)
+

Bases: object

+
+
+coord_to_point(coord)
+
+ +
+
+get_coord_range()
+
+ +
+
+get_map()
+
+ +
+
+get_resolution()
+
+ +
+
+point_to_coord(xy)
+
+ +
+ +
+
+class geo.osm.osm_map(**kwargs)
+

Bases: object

+
+ +
+
+

geo.sun module

+
+

geo.sun (Sun)

+

Author:

+ +

Description:

+
+

This module is a submodule of geo and supports functions and classes for sun position.

+
+

Contentlist:

+ +

Unittest:

+
+

See also the unittest documentation.

+
+
+
+
+geo.sun.BerechneZeitgleichung(T)
+
+ +
+
+geo.sun.InPi(x)
+
+ +
+
+geo.sun.JulianischesDatum(Jahr, Monat, Tag, Stunde, Minuten, Sekunden)
+
+ +
+
+geo.sun.Sonnenauf_untergang(JD, Zeitzone, coord)
+
+ +
+
+geo.sun.eps(T)
+
+ +
+
+geo.sun.sunrise(coord={'lat': 52.520008, 'lon': 13.404954}, date=None)
+
+
Parameters:
+
    +

  • coord (geo.gps.coordinate) – Target coordinate or None (default is central europe).

    • +

  • date (time.struct_time) – The day to calculate with or None (only year, month and day are relevant; default ist today)

    • +
+
+
Returns:
+

The date and time information for the sunrise

+
+
Return type:
+

time.struct_time

+
+
+

This Method calculates the time for sunrise for a given date and coordinate.

+
>>> import geo
+
+>>> ...
+
+
+
+ +
+
+geo.sun.sunset(coord={'lat': 52.520008, 'lon': 13.404954}, date=None)
+
+
Parameters:
+
    +

  • coord (geo.gps.coordinate) – Target coordinate or None (default is central europe).

    • +

  • date (time.struct_time) – The day to calculate with or None (only year, month and day are relevant; default ist today)

    • +
+
+
Returns:
+

The date and time information for the sunset

+
+
Return type:
+

time.struct_time

+
+
+

This Method calculates the time for sunrise for a given date and coordinate.

+
>>> import geo
+
+>>> ...
+
+
+
+ +
+
+ + +
+
+
+
+ +
+
+ +
+ © + Copyright + 2025, Dirk Alders. +
+ This page is licensed under the Python Software Foundation License Version 2. +
+ Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. +
+ + +
+ + The Python Software Foundation is a non-profit corporation. +Please donate. +
+
+ +
+ + Created using Sphinx 8.2.3. +
+ + + \ No newline at end of file diff --git a/_docs_/objects.inv b/_docs_/objects.inv new file mode 100644 index 0000000..ecbb3e7 --- /dev/null +++ b/_docs_/objects.inv @@ -0,0 +1,7 @@ +# Sphinx inventory version 2 +# Project: geo +# Version: +# The remainder of this file is compressed using zlib. +xڵW]o0}߯Д2BH,5<%cG3mzv@4SUuι>vsAuY#!xMXR>k(敡#C^wTrc.oXPJ{` uQ3&wF +m-нsMJ^QېۂóY(Z\5ȧQ'NN0W_Rx9U.Yݯa&%lӟWnH;5<f*NhfwCdL"/lZp+R:Y(/{++J 2D"}zBnZY,Q6׶4XmdnpaNaCy6.FN?SQp]8VۢϾ-UDq1hs<1I:.OђO&jӨ +Sp=؅z]E5sZ(Kh{zJeӖMeK#4"$"OPCZ('ҢQywk5VH0iۦZ)Pٰ]rN o; Q[] K~2̂ԁv* |=vrS-z6xHk/\tנR\Mq8;aarr o2 _˩D.j}[?(Xa%|$(JG:| Ӝ1) XIgxI&jJIðzP -o3}>m)e$LUu3y[uѝX]H{W)o6MgBYI*) Iˇ?c.S'qw >]4޾Y28(AxA@>`E1f;ǁR9A?\/#'ߔL \ No newline at end of file diff --git a/_docs_/py-modindex.html b/_docs_/py-modindex.html new file mode 100644 index 0000000..b69fea2 --- /dev/null +++ b/_docs_/py-modindex.html @@ -0,0 +1,250 @@ + + + + + + + Python Module Index — geo documentation + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + + +
+
+
+
+ + +

Python Module Index

+ +
+ g +
+ + + + + + + + + + + + + + + + +
 
+ g
+ geo +
    + geo.gps +
    + geo.osm +
    + geo.sun +
+ + +
+
+
+
+ +
+
+ +
+ © + Copyright + 2025, Dirk Alders. +
+ This page is licensed under the Python Software Foundation License Version 2. +
+ Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. +
+ + +
+ + The Python Software Foundation is a non-profit corporation. +Please donate. +
+
+ +
+ + Created using Sphinx 8.2.3. +
+ + + \ No newline at end of file diff --git a/_docs_/search.html b/_docs_/search.html new file mode 100644 index 0000000..0ba4317 --- /dev/null +++ b/_docs_/search.html @@ -0,0 +1,198 @@ + + + + + + + Search — geo documentation + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + +
+ +
+
+ + + +
+
+
+
+ +

Search

+ + + + +

+ Searching for multiple words only shows matches that contain + all words. +

+ + +
+ + + +
+ + +
+ + +
+
+
+
+ +
+
+ +
+ © + Copyright + 2025, Dirk Alders. +
+ This page is licensed under the Python Software Foundation License Version 2. +
+ Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License. +
+ + +
+ + The Python Software Foundation is a non-profit corporation. +Please donate. +
+
+ +
+ + Created using Sphinx 8.2.3. +
+ + + \ No newline at end of file diff --git a/_docs_/searchindex.js b/_docs_/searchindex.js new file mode 100644 index 0000000..61048b9 --- /dev/null +++ b/_docs_/searchindex.js @@ -0,0 +1 @@ +Search.setIndex({"alltitles":{"1. Copyright and Related Rights.":[[3,"copyright-and-related-rights"],[10,"copyright-and-related-rights"]],"2. Waiver.":[[3,"waiver"],[10,"waiver"]],"3. Public License Fallback.":[[3,"public-license-fallback"],[10,"public-license-fallback"]],"4. Limitations and Disclaimers.":[[3,"limitations-and-disclaimers"],[10,"limitations-and-disclaimers"]],"CC0 1.0 Universal licence":[[3,"cc0-1-0-universal-licence"],[10,"cc0-1-0-universal-licence"]],"Licence":[[3,null],[10,null]],"License for Sphinx":[[4,null],[11,null]],"Statement of Purpose":[[3,"statement-of-purpose"],[10,"statement-of-purpose"]],"Submodules":[[0,"submodules"]],"The MIT License (MIT)":[[2,null],[9,null]],"Zero-Clause BSD Licence":[[3,"zero-clause-bsd-licence"],[10,"zero-clause-bsd-licence"]],"geo (Geographic)":[[0,"geo-geographic"]],"geo package":[[0,null]],"geo.gps (Geo-Positioning)":[[0,"geo-gps-geo-positioning"]],"geo.gps module":[[0,"module-geo.gps"]],"geo.osm (Open Streetmap)":[[0,"geo-osm-open-streetmap"]],"geo.osm module":[[0,"module-geo.osm"]],"geo.sun (Sun)":[[0,"geo-sun-sun"]],"geo.sun module":[[0,"module-geo.sun"]]},"docnames":["index","venv/lib/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE","venv/lib/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE","venv/lib/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE","venv/lib/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module","venv/lib64/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE","venv/lib64/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE","venv/lib64/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE","venv/lib64/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["index.rst","venv/lib/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE.rst","venv/lib/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst","venv/lib/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.rst","venv/lib/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst","venv/lib/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst","venv/lib64/python3.13/site-packages/alabaster-1.0.0.dist-info/LICENSE.rst","venv/lib64/python3.13/site-packages/imagesize-1.4.1.dist-info/LICENSE.rst","venv/lib64/python3.13/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.rst","venv/lib64/python3.13/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/base.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/class.rst","venv/lib64/python3.13/site-packages/sphinx/ext/autosummary/templates/autosummary/module.rst"],"indexentries":{"angle_to() (geo.gps.coordinate method)":[[0,"geo.gps.coordinate.angle_to",false]],"append() (geo.gps.track method)":[[0,"geo.gps.track.append",false]],"area (class in geo.gps)":[[0,"geo.gps.area",false]],"area() (geo.gps.track method)":[[0,"geo.gps.track.area",false]],"average_speed() (geo.gps.track method)":[[0,"geo.gps.track.average_speed",false]],"berechnezeitgleichung() (in module geo.sun)":[[0,"geo.sun.BerechneZeitgleichung",false]],"center_pos() (geo.gps.area method)":[[0,"geo.gps.area.center_pos",false]],"coord_to_point() (geo.osm.map_spec method)":[[0,"geo.osm.map_spec.coord_to_point",false]],"coordinate (class in geo.gps)":[[0,"geo.gps.coordinate",false]],"coordinate_in_area() (geo.gps.area method)":[[0,"geo.gps.area.coordinate_in_area",false]],"corner_coordinates() (geo.gps.area method)":[[0,"geo.gps.area.corner_coordinates",false]],"dist_to() (geo.gps.coordinate method)":[[0,"geo.gps.coordinate.dist_to",false]],"end_date() (geo.gps.track method)":[[0,"geo.gps.track.end_date",false]],"eps() (in module geo.sun)":[[0,"geo.sun.eps",false]],"extend() (geo.gps.track method)":[[0,"geo.gps.track.extend",false]],"extend_area() (geo.gps.area method)":[[0,"geo.gps.area.extend_area",false]],"geo":[[0,"module-geo",false]],"geo.gps":[[0,"module-geo.gps",false]],"geo.osm":[[0,"module-geo.osm",false]],"geo.sun":[[0,"module-geo.sun",false]],"get_coord_range() (geo.osm.map_spec method)":[[0,"geo.osm.map_spec.get_coord_range",false]],"get_map() (geo.osm.map_spec method)":[[0,"geo.osm.map_spec.get_map",false]],"get_resolution() (geo.osm.map_spec method)":[[0,"geo.osm.map_spec.get_resolution",false]],"hight (geo.gps.coordinate attribute)":[[0,"geo.gps.coordinate.HIGHT",false]],"hightcharacteristic() (geo.gps.track method)":[[0,"geo.gps.track.hightcharacteristic",false]],"inpi() (in module geo.sun)":[[0,"geo.sun.InPi",false]],"insert() (geo.gps.track method)":[[0,"geo.gps.track.insert",false]],"julianischesdatum() (in module geo.sun)":[[0,"geo.sun.JulianischesDatum",false]],"landmark_link() (in module geo.osm)":[[0,"geo.osm.landmark_link",false]],"latitude (geo.gps.coordinate attribute)":[[0,"geo.gps.coordinate.LATITUDE",false]],"load_from_file() (geo.gps.tracklist method)":[[0,"geo.gps.tracklist.load_from_file",false]],"longitude (geo.gps.coordinate attribute)":[[0,"geo.gps.coordinate.LONGITUDE",false]],"map_cyclemap (in module geo.osm)":[[0,"geo.osm.MAP_CYCLEMAP",false]],"map_humanitarian (in module geo.osm)":[[0,"geo.osm.MAP_HUMANITARIAN",false]],"map_local_trafic (in module geo.osm)":[[0,"geo.osm.MAP_LOCAL_TRAFIC",false]],"map_spec (class in geo.osm)":[[0,"geo.osm.map_spec",false]],"map_standard (in module geo.osm)":[[0,"geo.osm.MAP_STANDARD",false]],"module":[[0,"module-geo",false],[0,"module-geo.gps",false],[0,"module-geo.osm",false],[0,"module-geo.sun",false]],"name() (geo.gps.track method)":[[0,"geo.gps.track.name",false]],"optimized_track() (geo.gps.track method)":[[0,"geo.gps.track.optimized_track",false]],"osm_map (class in geo.osm)":[[0,"geo.osm.osm_map",false]],"osm_map() (geo.gps.area method)":[[0,"geo.gps.area.osm_map",false]],"osm_map() (geo.gps.track method)":[[0,"geo.gps.track.osm_map",false]],"passed_hight() (geo.gps.track method)":[[0,"geo.gps.track.passed_hight",false]],"point_to_coord() (geo.osm.map_spec method)":[[0,"geo.osm.map_spec.point_to_coord",false]],"set_name() (geo.gps.track method)":[[0,"geo.gps.track.set_name",false]],"sonnenauf_untergang() (in module geo.sun)":[[0,"geo.sun.Sonnenauf_untergang",false]],"speedcharacteristic() (geo.gps.track method)":[[0,"geo.gps.track.speedcharacteristic",false]],"start_date() (geo.gps.track method)":[[0,"geo.gps.track.start_date",false]],"sunrise() (in module geo.sun)":[[0,"geo.sun.sunrise",false]],"sunset() (in module geo.sun)":[[0,"geo.sun.sunset",false]],"time (geo.gps.coordinate attribute)":[[0,"geo.gps.coordinate.TIME",false]],"total_distance() (geo.gps.track method)":[[0,"geo.gps.track.total_distance",false]],"total_time() (geo.gps.track method)":[[0,"geo.gps.track.total_time",false]],"track (class in geo.gps)":[[0,"geo.gps.track",false]],"tracklist (class in geo.gps)":[[0,"geo.gps.tracklist",false]]},"objects":{"":[[0,0,0,"-","geo"]],"geo":[[0,0,0,"-","gps"],[0,0,0,"-","osm"],[0,0,0,"-","sun"]],"geo.gps":[[0,1,1,"","area"],[0,1,1,"","coordinate"],[0,1,1,"","track"],[0,1,1,"","tracklist"]],"geo.gps.area":[[0,2,1,"","center_pos"],[0,2,1,"","coordinate_in_area"],[0,2,1,"","corner_coordinates"],[0,2,1,"","extend_area"],[0,2,1,"","osm_map"]],"geo.gps.coordinate":[[0,3,1,"","HIGHT"],[0,3,1,"","LATITUDE"],[0,3,1,"","LONGITUDE"],[0,3,1,"","TIME"],[0,2,1,"","angle_to"],[0,2,1,"","dist_to"]],"geo.gps.track":[[0,2,1,"","append"],[0,2,1,"","area"],[0,2,1,"","average_speed"],[0,2,1,"","end_date"],[0,2,1,"","extend"],[0,2,1,"","hightcharacteristic"],[0,2,1,"","insert"],[0,2,1,"","name"],[0,2,1,"","optimized_track"],[0,2,1,"","osm_map"],[0,2,1,"","passed_hight"],[0,2,1,"","set_name"],[0,2,1,"","speedcharacteristic"],[0,2,1,"","start_date"],[0,2,1,"","total_distance"],[0,2,1,"","total_time"]],"geo.gps.tracklist":[[0,2,1,"","load_from_file"]],"geo.osm":[[0,4,1,"","MAP_CYCLEMAP"],[0,4,1,"","MAP_HUMANITARIAN"],[0,4,1,"","MAP_LOCAL_TRAFIC"],[0,4,1,"","MAP_STANDARD"],[0,5,1,"","landmark_link"],[0,1,1,"","map_spec"],[0,1,1,"","osm_map"]],"geo.osm.map_spec":[[0,2,1,"","coord_to_point"],[0,2,1,"","get_coord_range"],[0,2,1,"","get_map"],[0,2,1,"","get_resolution"],[0,2,1,"","point_to_coord"]],"geo.sun":[[0,5,1,"","BerechneZeitgleichung"],[0,5,1,"","InPi"],[0,5,1,"","JulianischesDatum"],[0,5,1,"","Sonnenauf_untergang"],[0,5,1,"","eps"],[0,5,1,"","sunrise"],[0,5,1,"","sunset"]]},"objnames":{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","data","Python data"],"5":["py","function","Python function"]},"objtypes":{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:data","5":"py:function"},"terms":{"":[3,10],"0":0,"01":0,"02285256685333":0,"1":0,"1000":0,"11":[3,10],"12":0,"13":0,"14":0,"1481443":0,"158325":0,"1583252":0,"180":0,"1970":0,"1996":[3,10],"2":0,"2007":[4,11],"2010":[1,8],"2011":[1,8],"2014":0,"2016":[2,9],"2020":[1,8],"2024":[3,10],"2025":[4,11],"3182843470017":0,"39":0,"404954":0,"462":0,"49":0,"52":0,"520008":0,"53":0,"6908298":0,"690830":0,"9":[0,3,10],"96":[3,10],"976596":0,"A":[1,2,3,4,8,9,10,11],"AND":[1,2,3,4,8,9,10,11],"AS":[1,2,3,4,8,9,10,11],"BE":[1,2,3,4,8,9,10,11],"BUT":[1,2,4,8,9,11],"BY":[1,4,8,11],"FOR":[1,2,3,4,8,9,10,11],"For":[3,10],"IF":[1,4,8,11],"IN":[1,2,3,4,8,9,10,11],"In":[3,10],"NO":[1,2,3,4,8,9,10,11],"NOT":[1,2,4,8,9,11],"No":[3,10],"OF":[1,2,3,4,8,9,10,11],"ON":[1,4,8,11],"OR":[1,2,3,4,8,9,10,11],"One":0,"SUCH":[1,4,8,11],"THE":[1,2,3,4,8,9,10,11],"TO":[1,2,3,4,8,9,10,11],"That":0,"The":[0,1,3,8,10],"These":[3,10],"To":[3,10],"WITH":[2,3,9,10],"ab":0,"abandon":[3,10],"abov":[1,2,4,8,9,11],"absenc":[3,10],"account":[3,10],"accuraci":[3,10],"acknowledg":[3,10],"action":[2,3,9,10],"adam":[3,10],"adapt":[3,10],"addit":[3,10],"advertis":[3,10],"advis":[1,4,8,11],"affect":[3,10],"affirm":[3,10],"against":[3,10],"alder":0,"alexand":0,"all":[2,3,4,9,10,11],"also":0,"amend":[3,10],"an":[0,2,3,9,10],"angle_to":0,"ani":[1,2,3,4,8,9,10,11],"append":0,"appli":[3,10],"applic":[3,10],"ar":[0,1,3,4,8,10,11],"area":0,"arg":0,"aris":[1,2,3,4,8,9,10,11],"armin":[1,8],"around":0,"assert":[3,10],"associ":[2,3,9,10],"astronomi":0,"author":[0,2,3,4,9,10,11],"authorship":[3,10],"automat":[3,10],"avail":[3,10],"average_spe":0,"base":[0,1,3,8,10],"below":[3,4,10,11],"benefit":[3,10],"berechnezeitgleichung":0,"between":0,"binari":[1,4,8,11],"block":[7,14],"brodbeck":0,"bsd":[4,11],"build":[3,10],"busi":[1,4,8,11],"c":[1,3,4,8,10,11],"calcul":0,"calcult":0,"calski":0,"can":[3,10],"cancel":[3,10],"case":[3,10],"caus":[1,3,4,8,10,11],"center_po":0,"central":0,"certain":[3,10],"charg":[2,9],"claim":[2,3,9,10],"class":0,"claus":[4,11],"clear":[3,10],"cn":0,"code":[0,1,4,8,11],"commerci":[3,10],"common":[3,10],"commun":[3,10],"compens":[3,10],"competit":[3,10],"concern":[3,10],"condit":[1,2,4,8,9,11],"confer":[3,10],"connect":[2,3,9,10],"consent":[3,10],"consequenti":[1,3,4,8,10,11],"consider":[3,10],"contempl":[3,10],"contentlist":0,"contract":[1,2,3,4,8,9,10,11],"contrari":[3,10],"contravent":[3,10],"contribut":[3,10],"contributor":[1,4,8,11],"coodin":0,"coord":0,"coord1":0,"coord2":0,"coord_to_point":0,"coordin":0,"coordinate_in_area":0,"copi":[2,3,9,10],"copyright":[1,2,4,8,9,11],"corner":0,"corner_coordin":0,"corrdin":0,"correspond":[3,10],"council":[3,10],"creat":0,"creativ":[3,10],"creator":[3,10],"cultur":[3,10],"current":[3,10],"cyclemap":0,"dai":0,"damag":[1,2,3,4,8,9,10,11],"data":[1,3,4,8,10,11],"databas":[3,10],"date":[0,3,10],"de":0,"deal":[2,9],"deem":[3,10],"default":0,"defect":[3,10],"defin":[0,3,10],"definit":0,"depict":[3,10],"deriv":[1,8],"descript":0,"detriment":[3,10],"dict":0,"direct":[0,1,3,4,8,10,11],"dirk":0,"disclaim":[1,4,8,11],"discover":[3,10],"displai":[3,10],"disrupt":[3,10],"dissemin":[3,10],"dist_to":0,"distanc":0,"distribut":[1,2,3,4,8,9,10,11],"do":[2,9],"document":[0,1,2,3,4,8,9,10,11],"dr":0,"durat":[3,10],"duti":[3,10],"e":0,"each":[3,10],"east":0,"ec":[3,10],"effect":[3,10],"effort":[3,10],"either":[3,10],"elect":[3,10],"end_dat":0,"endblock":[7,14],"endfor":[7,14],"endif":[7,14],"endors":[1,8],"enjoy":[3,10],"ep":0,"equit":[3,10],"equival":[3,10],"error":[3,10],"escap":[5,6,7,12,13,14],"etrax":0,"europ":0,"european":[3,10],"even":[1,4,8,11],"event":[1,2,3,4,8,9,10,11],"exampl":0,"exclus":[3,10],"exemplari":[1,4,8,11],"exercis":[3,10],"exist":[3,10],"expect":[3,10],"express":[1,2,3,4,8,9,10,11],"extend":0,"extend_area":0,"extens":[3,10],"extent":[3,10],"extract":[3,10],"fear":[3,10],"fee":[3,10],"file":[0,2,4,9,11],"first":0,"fit":[1,2,3,4,8,9,10,11],"float":0,"follow":[1,2,3,4,8,9,10,11],"forcier":[1,8],"form":[1,3,4,8,10,11],"formula":0,"free":[2,3,9,10],"freeli":[3,10],"from":[0,1,2,3,8,9,10],"fulli":[3,10],"fullnam":[5,6,7,12,13,14],"function":0,"furnish":[2,9],"further":[3,10],"futur":[3,10],"g":0,"gain":[3,10],"gb":0,"gener":0,"get_coord_rang":0,"get_map":0,"get_resolut":0,"given":0,"good":[1,4,8,11],"grant":[2,3,9,10],"greater":[3,10],"greatest":[3,10],"ha":[3,10],"he":[3,10],"height":0,"heir":[3,10],"held":[3,10],"her":[3,10],"herebi":[2,3,9,10],"hi":[3,10],"hight":0,"hightcharacterist":0,"hn":0,"holder":[1,2,4,8,9,11],"howev":[1,4,8,11],"html":0,"http":0,"humanitarian":0,"i":[0,1,2,3,4,8,9,10,11],"ideal":[3,10],"ii":[3,10],"iii":[3,10],"imag":[3,10],"implement":[0,3,10],"impli":[1,2,3,4,8,9,10,11],"import":0,"incident":[1,4,8,11],"includ":[0,1,2,3,4,8,9,10,11],"incorpor":[3,10],"index":0,"indic":[4,11],"indirect":[1,3,4,8,10,11],"ineffect":[3,10],"info":0,"inform":0,"infring":[3,10],"inpi":0,"insert":0,"instanc":0,"int":0,"intend":[3,10],"interrupt":[1,4,8,11],"invalid":[3,10],"irrevoc":[3,10],"issu":0,"ist":0,"item":[7,14],"its":[3,10],"iv":[3,10],"jahr":0,"jd":0,"jeff":[1,8],"judg":[3,10],"julianischesdatum":0,"jurisdict":[3,10],"kenneth":[1,8],"kind":[2,3,9,10],"klupp":0,"knowledg":[3,10],"known":[3,10],"kwarg":0,"landmark_link":0,"larg":[3,10],"lat":0,"latent":[3,10],"later":[3,10],"latitud":0,"law":[3,10],"layer":0,"legal":[3,10],"level":0,"lexikon":0,"liabil":[1,2,4,8,9,11],"liabl":[1,2,3,4,8,9,10,11],"licenc":[4,11],"like":[0,3,10],"limit":[1,2,4,8,9,11],"list":[0,1,4,8,11],"load_from_fil":0,"local":0,"lon":0,"londitud":0,"longitud":0,"loss":[1,3,4,8,10,11],"made":[3,10],"mai":[1,3,8,10],"make":[3,10],"map":0,"map_cod":0,"map_cyclemap":0,"map_humanitarian":0,"map_local_traf":0,"map_spec":0,"map_standard":0,"march":[3,10],"mark":0,"materi":[1,4,8,11],"math":0,"maximum":[3,10],"mean":[0,3,10],"medium":[3,10],"member":[3,10],"merchant":[1,2,3,4,8,9,10,11],"merg":[2,9],"met":[1,4,8,11],"meter":0,"method":0,"minuten":0,"mlat":0,"mlon":0,"mockeri":0,"modif":[1,4,8,11],"modifi":[2,3,9,10],"modul":[7,14],"monat":0,"month":0,"moral":[3,10],"more":0,"most":[3,10],"motiv":[3,10],"mount":0,"must":[1,4,8,11],"n":0,"name":[0,1,8],"nation":[3,10],"navig":0,"necessari":[3,10],"need":0,"neglig":[1,3,4,8,10,11],"neighbor":[3,10],"neu":0,"non":[3,10],"none":0,"noninfring":[2,9],"north":0,"notic":[1,2,4,8,9,11],"now":[3,10],"number":[3,10],"object":0,"oblig":[3,10],"obtain":[2,3,9,10],"offer":[3,10],"onli":0,"openstreetmap":0,"optimized_track":0,"org":0,"origin":[1,3,8,10],"osm_map":0,"other":[1,2,3,4,8,9,10,11],"otherwis":[1,2,3,4,8,9,10,11],"out":[1,2,3,4,8,9,10,11],"overtli":[3,10],"owner":[1,3,8,10],"paragraph":[3,10],"paramet":0,"parliament":[3,10],"pars":0,"part":[3,10],"parti":[3,10],"partial":[3,10],"particular":[1,2,3,4,8,9,10,11],"passed_hight":0,"patent":[3,10],"perform":[3,10],"perman":[3,10],"permiss":[1,2,3,8,9,10],"permit":[1,2,3,4,8,9,10,11],"person":[2,3,9,10],"pertain":[3,10],"pi":0,"point_to_coord":0,"portion":[2,9],"possibl":[1,3,4,8,10,11],"present":[3,10],"preserv":[3,10],"prior":[1,8],"privaci":[3,10],"procur":[1,4,8,11],"product":[1,3,8,10],"profit":[1,3,4,8,10,11],"project":[3,4,10,11],"promot":[1,3,8,10],"protect":[3,10],"provid":[1,2,3,4,8,9,10,11],"publicli":[3,10],"publish":[2,9],"purpos":[1,2,4,8,9,11],"quiet":[3,10],"radiant":0,"rais":0,"reason":[3,10],"redistribut":[1,3,4,8,10,11],"regard":[3,10],"reitz":[1,8],"relev":0,"reliabl":[3,10],"relinquish":[3,10],"remain":[3,10],"remaind":[3,10],"represent":[3,10],"reproduc":[1,3,4,8,10,11],"reput":[3,10],"requir":[3,10],"resciss":[3,10],"reserv":[1,4,8,11],"respect":[3,10],"respons":[3,10],"restrict":[2,9],"result":[3,10],"retain":[1,3,4,8,10,11],"return":0,"reus":[3,10],"revoc":[3,10],"right":[0,1,2,4,8,9,11],"roland":0,"ronach":[1,8],"royalti":[3,10],"rubric":[7,14],"scientif":[3,10],"second":0,"see":[0,4,11],"sekunden":0,"sell":[2,9],"servic":[1,4,8,11],"set_nam":0,"shall":[1,2,3,4,8,9,10,11],"she":[3,10],"shibukawa":[2,9],"should":[3,10],"similar":[3,10],"sinc":0,"so":[2,3,9,10],"softwar":[1,2,3,4,8,9,10,11],"some":[0,1,8],"sonnenauf_untergang":0,"sourc":[1,4,8,11],"special":[1,3,4,8,10,11],"specif":[1,8],"speedcharacterist":0,"sphinx":0,"standard":0,"start_dat":0,"statutori":[3,10],"store":0,"str":0,"strict":[1,4,8,11],"struct_tim":0,"stund":0,"subject":[2,3,9,10],"sublicens":[2,3,9,10],"subsequ":[3,10],"substanti":[2,9],"substitut":[1,4,8,11],"successor":[3,10],"sudo":0,"sunris":0,"sunset":0,"support":0,"surrend":[3,10],"system":0,"t":0,"tag":0,"take":[3,10],"target":0,"team":[4,11],"term":[3,10],"termin":[3,10],"territori":[3,10],"theme":[1,8],"theori":[1,4,8,11],"thereof":[3,10],"thi":[0,1,2,3,4,8,9,10,11],"those":[3,10],"through":[3,10],"throughout":[3,10],"time":[0,3,10],"titl":[3,10],"tn":0,"todai":0,"tort":[1,2,4,8,9,11],"tortiou":[3,10],"total_dist":0,"total_tim":0,"track":0,"tracklist":0,"trademark":[3,10],"trafic":0,"transfer":[3,10],"translat":[3,10],"treati":[3,10],"turn":0,"turner":[3,10],"two":[0,4,11],"type":0,"uncondit":[3,10],"uncondition":[3,10],"under":[3,4,10,11],"underlin":[5,6,7,12,13,14],"understand":[3,10],"unfair":[3,10],"unittest":0,"unknown":[3,10],"unless":[4,11],"upon":[3,10],"url":0,"us":[1,2,3,4,8,9,10,11],"version":[3,10],"vista":0,"voluntarili":[3,10],"wa":[3,10],"wai":[1,4,8,11],"waiv":[3,10],"warranti":[1,2,3,4,8,9,10,11],"well":[3,10],"whatsoev":[3,10],"whether":[1,2,3,4,8,9,10,11],"whom":[2,9],"wiki":0,"wish":[3,10],"without":[1,2,3,4,8,9,10,11],"work":[1,3,8,10],"world":[3,10],"worldwid":[3,10],"written":[1,8],"www":0,"x":0,"xml":0,"xmlfilehandl":0,"xy":0,"year":0,"yoshiki":[2,9],"zeitgleichung":0,"zeitzon":0,"zoom":0,"zoom_level":0},"titles":["geo package","<no title>","The MIT License (MIT)","Licence","License for Sphinx","<no title>","<no title>","<no title>","<no title>","The MIT License (MIT)","Licence","License for Sphinx","<no title>","<no title>","<no title>"],"titleterms":{"0":[3,10],"1":[3,10],"2":[3,10],"3":[3,10],"4":[3,10],"The":[2,9],"bsd":[3,10],"cc0":[3,10],"claus":[3,10],"copyright":[3,10],"disclaim":[3,10],"fallback":[3,10],"geo":0,"geograph":0,"gp":0,"licenc":[3,10],"licens":[2,3,4,9,10,11],"limit":[3,10],"mit":[2,9],"modul":0,"open":0,"osm":0,"packag":0,"posit":0,"public":[3,10],"purpos":[3,10],"relat":[3,10],"right":[3,10],"sphinx":[4,11],"statement":[3,10],"streetmap":0,"submodul":0,"sun":0,"univers":[3,10],"waiver":[3,10],"zero":[3,10]}}) \ No newline at end of file diff --git a/_examples_/Makefile b/_examples_/Makefile new file mode 100644 index 0000000..181812c --- /dev/null +++ b/_examples_/Makefile @@ -0,0 +1,18 @@ +.ONESHELL: +SHELL = /usr/bin/bash +MAKEFLAGS += --no-print-directory +.SILENT: + +EXAMPLES := $(wildcard *.py) +EXAMPLES := $(filter-out config.py, $(EXAMPLES)) +LOGFILES := ${EXAMPLES:.py=.log} + +.PHONY: all +all: $(LOGFILES) + +%.log: %.py + python3 $< > $@ + +clean: + echo -e "\e[1m * Example logs...\e[0m" + rm -f $(LOGFILES)