404
- -Page not found
- - -
-
-
-
- -
+
- Versions + ${config.versions.active + .map( + (version) => ` +
- + ${version.slug} + + `, + ) + .join("\n")} +
-
+
- Downloads + ${Object.entries(config.versions.current.downloads) + .map( + ([name, url]) => ` +
- + ${downloadsNameDisplay[name]} + + `, + ) + .join("\n")} +
+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+ babelon package — babelon 0.3.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ "
-author = "Vinicius de Souza "
-release = __version__
-
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-extensions = [
- "sphinx.ext.autodoc",
- "sphinx.ext.githubpages",
- "sphinx_rtd_theme",
- "sphinx_click",
- "sphinx_autodoc_typehints",
- "myst_parser",
-]
-
-# generate autosummary pages
-autosummary_generate = True
-
-# The master toctree document.
-master_doc = "index"
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = "en"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
-
-templates_path = ["_templates"]
-
-# -- Options for HTML output -------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_theme = "sphinx_rtd_theme"
-html_static_path = ["_static"]
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#
-if os.path.exists("logo.png"):
- html_logo = "logo.png"
diff --git a/css/theme_extra.css b/css/theme_extra.css
deleted file mode 100644
index ab0631a..0000000
--- a/css/theme_extra.css
+++ /dev/null
@@ -1,197 +0,0 @@
-/*
- * Wrap inline code samples otherwise they shoot of the side and
- * can't be read at all.
- *
- * https://github.com/mkdocs/mkdocs/issues/313
- * https://github.com/mkdocs/mkdocs/issues/233
- * https://github.com/mkdocs/mkdocs/issues/834
- */
-.rst-content code {
- white-space: pre-wrap;
- word-wrap: break-word;
- padding: 2px 5px;
-}
-
-/**
- * Make code blocks display as blocks and give them the appropriate
- * font size and padding.
- *
- * https://github.com/mkdocs/mkdocs/issues/855
- * https://github.com/mkdocs/mkdocs/issues/834
- * https://github.com/mkdocs/mkdocs/issues/233
- */
-.rst-content pre code {
- white-space: pre;
- word-wrap: normal;
- display: block;
- padding: 12px;
- font-size: 12px;
-}
-
-/**
- * Fix code colors
- *
- * https://github.com/mkdocs/mkdocs/issues/2027
- */
-.rst-content code {
- color: #E74C3C;
-}
-
-.rst-content pre code {
- color: #000;
- background: #f8f8f8;
-}
-
-/*
- * Fix link colors when the link text is inline code.
- *
- * https://github.com/mkdocs/mkdocs/issues/718
- */
-a code {
- color: #2980B9;
-}
-a:hover code {
- color: #3091d1;
-}
-a:visited code {
- color: #9B59B6;
-}
-
-/*
- * The CSS classes from highlight.js seem to clash with the
- * ReadTheDocs theme causing some code to be incorrectly made
- * bold and italic.
- *
- * https://github.com/mkdocs/mkdocs/issues/411
- */
-pre .cs, pre .c {
- font-weight: inherit;
- font-style: inherit;
-}
-
-/*
- * Fix some issues with the theme and non-highlighted code
- * samples. Without and highlighting styles attached the
- * formatting is broken.
- *
- * https://github.com/mkdocs/mkdocs/issues/319
- */
-.rst-content .no-highlight {
- display: block;
- padding: 0.5em;
- color: #333;
-}
-
-
-/*
- * Additions specific to the search functionality provided by MkDocs
- */
-
-.search-results {
- margin-top: 23px;
-}
-
-.search-results article {
- border-top: 1px solid #E1E4E5;
- padding-top: 24px;
-}
-
-.search-results article:first-child {
- border-top: none;
-}
-
-form .search-query {
- width: 100%;
- border-radius: 50px;
- padding: 6px 12px;
- border-color: #D1D4D5;
-}
-
-/*
- * Improve inline code blocks within admonitions.
- *
- * https://github.com/mkdocs/mkdocs/issues/656
- */
- .rst-content .admonition code {
- color: #404040;
- border: 1px solid #c7c9cb;
- border: 1px solid rgba(0, 0, 0, 0.2);
- background: #f8fbfd;
- background: rgba(255, 255, 255, 0.7);
-}
-
-/*
- * Account for wide tables which go off the side.
- * Override borders to avoid weirdness on narrow tables.
- *
- * https://github.com/mkdocs/mkdocs/issues/834
- * https://github.com/mkdocs/mkdocs/pull/1034
- */
-.rst-content .section .docutils {
- width: 100%;
- overflow: auto;
- display: block;
- border: none;
-}
-
-td, th {
- border: 1px solid #e1e4e5 !important;
- border-collapse: collapse;
-}
-
-/*
- * Without the following amendments, the navigation in the theme will be
- * slightly cut off. This is due to the fact that the .wy-nav-side has a
- * padding-bottom of 2em, which must not necessarily align with the font-size of
- * 90 % on the .rst-current-version container, combined with the padding of 12px
- * above and below. These amendments fix this in two steps: First, make sure the
- * .rst-current-version container has a fixed height of 40px, achieved using
- * line-height, and then applying a padding-bottom of 40px to this container. In
- * a second step, the items within that container are re-aligned using flexbox.
- *
- * https://github.com/mkdocs/mkdocs/issues/2012
- */
- .wy-nav-side {
- padding-bottom: 40px;
-}
-
-/* For section-index only */
-.wy-menu-vertical .current-section p {
- background-color: #e3e3e3;
- color: #404040;
-}
-
-/*
- * The second step of above amendment: Here we make sure the items are aligned
- * correctly within the .rst-current-version container. Using flexbox, we
- * achieve it in such a way that it will look like the following:
- *
- * [No repo_name]
- * Next >> // On the first page
- * << Previous Next >> // On all subsequent pages
- *
- * [With repo_name]
- * Next >> // On the first page
- * << Previous Next >> // On all subsequent pages
- *
- * https://github.com/mkdocs/mkdocs/issues/2012
- */
-.rst-versions .rst-current-version {
- padding: 0 12px;
- display: flex;
- font-size: initial;
- justify-content: space-between;
- align-items: center;
- line-height: 40px;
-}
-
-/*
- * Please note that this amendment also involves removing certain inline-styles
- * from the file ./mkdocs/themes/readthedocs/versions.html.
- *
- * https://github.com/mkdocs/mkdocs/issues/2012
- */
-.rst-current-version span {
- flex: 1;
- text-align: center;
-}
diff --git a/genindex.html b/genindex.html
new file mode 100644
index 0000000..ff6d11f
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,596 @@
+
+
+
+
+
+
+
+ Index — babelon 0.3.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Welcome to babelon’s documentation! — babelon 0.3.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ NUL 2>NUL
-if errorlevel 9009 (
- echo.
- echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
- echo.installed, then set the SPHINXBUILD environment variable to point
- echo.to the full path of the 'sphinx-build' executable. Alternatively you
- echo.may add the Sphinx directory to PATH.
- echo.
- echo.If you don't have Sphinx installed, grab it from
- echo.https://www.sphinx-doc.org/
- exit /b 1
-)
-
-if "%1" == "" goto help
-
-%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-goto end
-
-:help
-%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
-
-:end
-popd
diff --git a/modules.html b/modules.html
new file mode 100644
index 0000000..b574fda
--- /dev/null
+++ b/modules.html
@@ -0,0 +1,273 @@
+
+
+
+
+
+
+
+
+ babelon — babelon 0.3.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Python Module Index — babelon 0.3.1 documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ {{schema.description}}
-
-
-
+
+
+ Search — babelon 0.3.1 documentation
+
+
+
+
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
+
+
+ `;
+
+ // Inject the generated flyout into the body HTML element.
+ document.body.insertAdjacentHTML("beforeend", flyout);
+
+ // Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
+ document
+ .querySelector("#flyout-search-form")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+ })
+}
+
+if (themeLanguageSelector || themeVersionSelector) {
+ function onSelectorSwitch(event) {
+ const option = event.target.selectedIndex;
+ const item = event.target.options[option];
+ window.location.href = item.dataset.url;
+ }
+
+ document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ const config = event.detail.data();
+
+ const versionSwitch = document.querySelector(
+ "div.switch-menus > div.version-switch",
+ );
+ if (themeVersionSelector) {
+ let versions = config.versions.active;
+ if (config.versions.current.hidden || config.versions.current.type === "external") {
+ versions.unshift(config.versions.current);
+ }
+ const versionSelect = `
+
+ `;
+
+ versionSwitch.innerHTML = versionSelect;
+ versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+
+ const languageSwitch = document.querySelector(
+ "div.switch-menus > div.language-switch",
+ );
+
+ if (themeLanguageSelector) {
+ if (config.projects.translations.length) {
+ // Add the current language to the options on the selector
+ let languages = config.projects.translations.concat(
+ config.projects.current,
+ );
+ languages = languages.sort((a, b) =>
+ a.language.name.localeCompare(b.language.name),
+ );
+
+ const languageSelect = `
+
+ `;
+
+ languageSwitch.innerHTML = languageSelect;
+ languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
+ }
+ else {
+ languageSwitch.remove();
+ }
+ }
+ });
+}
+
+document.addEventListener("readthedocs-addons-data-ready", function (event) {
+ // Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
+ document
+ .querySelector("[role='search'] input")
+ .addEventListener("focusin", () => {
+ const event = new CustomEvent("readthedocs-search-show");
+ document.dispatchEvent(event);
+ });
+});
\ No newline at end of file
diff --git a/_static/language_data.js b/_static/language_data.js
new file mode 100644
index 0000000..367b8ed
--- /dev/null
+++ b/_static/language_data.js
@@ -0,0 +1,199 @@
+/*
+ * language_data.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * This script contains the language-specific data used by searchtools.js,
+ * namely the list of stopwords, stemmer, scorer and splitter.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+
+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/_static/minus.png b/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/_static/minus.png differ
diff --git a/_static/plus.png b/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/_static/plus.png differ
diff --git a/_static/pygments.css b/_static/pygments.css
new file mode 100644
index 0000000..84ab303
--- /dev/null
+++ b/_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 #FF0000 } /* Error */
+.highlight .k { color: #008000; font-weight: bold } /* Keyword */
+.highlight .o { color: #666666 } /* 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: #0044DD } /* 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: #666666 } /* Literal.Number */
+.highlight .s { color: #BA2121 } /* Literal.String */
+.highlight .na { color: #687822 } /* Name.Attribute */
+.highlight .nb { color: #008000 } /* Name.Builtin */
+.highlight .nc { color: #0000FF; font-weight: bold } /* Name.Class */
+.highlight .no { color: #880000 } /* Name.Constant */
+.highlight .nd { color: #AA22FF } /* Name.Decorator */
+.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
+.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
+.highlight .nf { color: #0000FF } /* Name.Function */
+.highlight .nl { color: #767600 } /* Name.Label */
+.highlight .nn { color: #0000FF; font-weight: bold } /* Name.Namespace */
+.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
+.highlight .nv { color: #19177C } /* Name.Variable */
+.highlight .ow { color: #AA22FF; font-weight: bold } /* Operator.Word */
+.highlight .w { color: #bbbbbb } /* Text.Whitespace */
+.highlight .mb { color: #666666 } /* Literal.Number.Bin */
+.highlight .mf { color: #666666 } /* Literal.Number.Float */
+.highlight .mh { color: #666666 } /* Literal.Number.Hex */
+.highlight .mi { color: #666666 } /* Literal.Number.Integer */
+.highlight .mo { color: #666666 } /* 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: #0000FF } /* 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: #666666 } /* Literal.Number.Integer.Long */
\ No newline at end of file
diff --git a/_static/searchtools.js b/_static/searchtools.js
new file mode 100644
index 0000000..b08d58c
--- /dev/null
+++ b/_static/searchtools.js
@@ -0,0 +1,620 @@
+/*
+ * searchtools.js
+ * ~~~~~~~~~~~~~~~~
+ *
+ * Sphinx JavaScript utilities for the full-text search.
+ *
+ * :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
+ * :license: BSD, see LICENSE for details.
+ *
+ */
+"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] = 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,
+ };
+}
+
+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] = item;
+
+ let listItem = document.createElement("li");
+ 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 = _(
+ "Search finished, found ${resultCount} page(s) matching the search query."
+ ).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].
+// 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.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].
+ 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],
+ ]);
+ }
+ }
+ }
+
+ // 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],
+ ];
+ 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]],
+ ]);
+ };
+ 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 = [];
+ const arr = [
+ { files: terms[word], score: Scorer.term },
+ { files: titleTerms[word], 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, {});
+ scoreMap.get(file)[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)[w]));
+ // add result to the result list
+ results.push([
+ docNames[file],
+ titles[file],
+ "",
+ null,
+ score,
+ filenames[file],
+ ]);
+ }
+ 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/_static/sphinx_highlight.js b/_static/sphinx_highlight.js
new file mode 100644
index 0000000..8a96c69
--- /dev/null
+++ b/_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(
+ '
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ + Hosted by Read the Docs + +
+ -
+
- On Read the Docs +
- + Project Home + +
- + Builds + +
- + Downloads + +
-
+
- Search +
- + + +
+ + Hosted by Read the Docs + +
' + + '' + + _("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/babelon.html b/babelon.html new file mode 100644 index 0000000..cebbfd4 --- /dev/null +++ b/babelon.html @@ -0,0 +1,923 @@ + + + + + + + + +
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/conf.py b/conf.py
deleted file mode 100644
index f4d59cb..0000000
--- a/conf.py
+++ /dev/null
@@ -1,60 +0,0 @@
-"""Configuration file for the Sphinx documentation builder."""
-# For the full list of built-in configuration values, see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-import os
-from datetime import date
-
-from babelon import __version__
-
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-
-project = "babelon"
-copyright = f"{date.today().year}, Vinicius de Souza
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ babelon package
+Submodules
+babelon.babelon_io module
+babelon.io.
+-
+
- +babelon.babelon_io.convert_file(input_path, output, drop_unknown_columns=True, output_format=None) +
Convert a file from one format to another.
+-
+
- Parameters: +
-
+
input_path (
str) – The path to the input babelon tsv file
+output (
TextIO) – The path to the output file. If none is given, will default to using stdout.
+drop_unknown_columns (
bool) – If true, columns unknown to Babelon format are dropped prior to processing.
+output_format (
Optional[str]) – The format to which the SSSOM TSV should be converted.
+
+- Return type: +
+None
+
-
+
- +babelon.babelon_io.parse_file(input_path, output_path) +
Parse a Babelon metadata file and write to a table.
+-
+
- Return type: +
+None
+
-
+
- Args:
input_path (str): The path to the input file in one of the legal formats, eg obographs, aligmentapi-xml +output_path (TextIO): The path to the output file.
+
+- Raises:
ValueError: [description]
+
+
-
+
- +babelon.babelon_io.to_babelon_linkml_document(bdf) +
Load a LinkML YAML representation from a BabelonDataFrame.
+
-
+
- +babelon.babelon_io.to_json(bdf) +
Convert a mapping set dataframe to a JSON object.
+-
+
- Return type: +
+JsonObj
+
-
+
- +babelon.babelon_io.to_owl_graph(bdf) +
Convert a mapping set dataframe to OWL in an RDF graph.
+-
+
- Return type: +
+Graph
+
-
+
- +babelon.babelon_io.to_rdf_graph(bdf) +
Convert a mapping set dataframe to an RDF graph.
+-
+
- Return type: +
+Graph
+
-
+
- +babelon.babelon_io.write_json(bdf, output, serialisation='json') +
Write a mapping set dataframe to the file as JSON.
+-
+
- Return type: +
+None
+
-
+
- Args:
bdf (BabelonDataFrame): The path to the input file in one of the legal formats, eg obographs, aligmentapi-xml +output (TextIO): The path or stream of the output. +serialisation (str): the target serialisation (must be ‘json’)
+
+- Raises:
ValueError: [description]
+
+
-
+
- +babelon.babelon_io.write_owl(bdf, output, serialisation='owl') +
Write a mapping set dataframe to the file as OWL.
+-
+
- Return type: +
+None
+
-
+
- Args:
bdf (BabelonDataFrame): The path to the input file in one of the legal formats, eg obographs, aligmentapi-xml +output (TextIO): The path or stream of the output. +serialisation (str): the target serialisation (must be ‘json’)
+
+- Raises:
ValueError: [description]
+
+
babelon.cli module
+Command line interface for Babelon.
+babelon.constants module
+Constants for babelon toolkit.
+babelon.dataclasses module
+-
+
- +class babelon.dataclasses.EntityReference(v) +
Bases:
+UriorcurieA reference to a mapped entity. This is represented internally as a string, and as a resource in RDF
+-
+
- +type_class_curie = 'rdfs:Resource' +
-
+
- +type_class_uri = rdflib.term.URIRef('http://www.w3.org/2000/01/rdf-schema#Resource') +
-
+
- +type_model_uri = rdflib.term.URIRef('https://w3id.org/babelon/EntityReference') +
-
+
- +type_name = 'EntityReference' +
-
+
- +class babelon.dataclasses.Profile(translations=<factory>, translation_provider=None, profile_id=None, profile_version=None, comment=None, **_kwargs) +
Bases:
+YAMLRootRepresents a set of translation that together compose a language profile.
+-
+
-
+class_class_curie:
ClassVar[str] = 'babelon:Profile'
+
-
+
-
+class_class_uri:
ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/babelon/Profile')
+
-
+
-
+class_model_uri:
ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/babelon/Profile')
+
-
+
-
+class_name:
ClassVar[str] = 'profile'
+
-
+
-
+comment:
Optional[str] = None
+
-
+
-
+profile_id:
Optional[str] = None
+
-
+
-
+profile_version:
Optional[str] = None
+
-
+
-
+translation_provider:
Optional[str] = None
+
-
+
-
+translations:
Union[dict,Translation,List[Union[dict,Translation]],None]
+
-
+class_class_curie:
-
+
- +class babelon.dataclasses.Translation(subject_id=None, predicate_id=None, source_value=None, source_language=None, translation_value=None, translation_language=None, source_version=None, translation_type=None, translator=None, translator_expertise=None, translation_date=None, translation_confidence=None, translation_precision=None, translation_status=None, source=None, comment=None, **_kwargs) +
Bases:
+YAMLRootRepresents and individual translation
+-
+
-
+class_class_curie:
ClassVar[str] = 'owl:Axiom'
+
-
+
-
+class_class_uri:
ClassVar[URIRef] = rdflib.term.URIRef('http://www.w3.org/2002/07/owl#Axiom')
+
-
+
-
+class_model_uri:
ClassVar[URIRef] = rdflib.term.URIRef('https://w3id.org/babelon/Translation')
+
-
+
-
+class_name:
ClassVar[str] = 'translation'
+
-
+
-
+comment:
Optional[str] = None
+
-
+
-
+predicate_id:
Union[str,EntityReference] = None
+
-
+
-
+source:
Optional[str] = None
+
-
+
-
+source_language:
str= None
+
-
+
-
+source_value:
str= None
+
-
+
-
+source_version:
Optional[str] = None
+
-
+
-
+subject_id:
Union[str,EntityReference] = None
+
-
+
-
+translation_confidence:
Optional[float] = None
+
-
+
-
+translation_date:
Optional[str] = None
+
-
+
-
+translation_language:
Optional[str] = None
+
-
+
-
+translation_precision:
Union[str,TranslationPrecisionEnum,None] = None
+
-
+
-
+translation_status:
Union[str,TranslationStatusEnum,None] = None
+
-
+
-
+translation_type:
Union[str,TranslationTypeEnum,None] = None
+
-
+
-
+translation_value:
Optional[str] = None
+
-
+
-
+translator:
Optional[str] = None
+
-
+
-
+translator_expertise:
Union[str,TranslatorExpertiseEnum,None] = None
+
-
+class_class_curie:
-
+
- +class babelon.dataclasses.TranslationPrecisionEnum(code) +
Bases:
+EnumDefinitionImpl-
+
- +BROADER = PermissibleValue({ 'text': 'BROADER', 'description': 'The translation value has a somewhat broader meaning than the source value.' }) +
-
+
- +CLOSE = PermissibleValue({ 'text': 'CLOSE', 'description': 'The translation value is close in meaning to the source value, but not exact.' }) +
-
+
- +EXACT = PermissibleValue({'text': 'EXACT', 'description': 'The translation is exact.'}) +
-
+
- +NARROWER = PermissibleValue({ 'text': 'NARROWER', 'description': 'The translation value has a somewhat narrower meaning than the source value.' }) +
-
+
- +class babelon.dataclasses.TranslationStatusEnum(code) +
Bases:
+EnumDefinitionImpl-
+
- +CANDIDATE = PermissibleValue({ 'text': 'CANDIDATE', 'description': ('The translation has been suggested from an entity (algorithm, person) ' 'outside the core team managing the translation.') }) +
-
+
- +NOT_TRANSLATED = PermissibleValue({'text': 'NOT_TRANSLATED', 'description': 'This translation is incomplete.'}) +
-
+
- +OFFICIAL = PermissibleValue({ 'text': 'OFFICIAL', 'description': ('The translation has been accepted by the core team managing the language ' 'profile.') }) +
-
+
- +UNDER_REVIEW = PermissibleValue({ 'text': 'UNDER_REVIEW', 'description': ('The translation has been suggested from an entity (algorithm, person) inside ' 'the core team managing the translation, but not yet officially ratified.') }) +
-
+
- +class babelon.dataclasses.TranslationTypeEnum(code) +
Bases:
+EnumDefinitionImpl-
+
- +AUGMENTATION = PermissibleValue({ 'text': 'AUGMENTATION', 'description': ('The record corresponds to an additional language specific terminological ' 'element without a corresponding element in the source language.') }) +
-
+
- +CORRECTION = PermissibleValue({ 'text': 'CORRECTION', 'description': ('The record corresponds to a translation of a source value into a translation ' 'value, but rather than being an exact translation, it suggests a change to ' 'the original source value.') }) +
-
+
- +TRANSLATION = PermissibleValue({ 'text': 'TRANSLATION', 'description': ('The record corresponds to an actual translation of a source value into a ' 'translation value.') }) +
-
+
- +class babelon.dataclasses.TranslatorExpertiseEnum(code) +
Bases:
+EnumDefinitionImpl-
+
- +ALGORITHM = PermissibleValue({'text': 'ALGORITHM', 'description': 'The translator is a machine, not a person.'}) +
-
+
- +DOMAIN_EXPERT = PermissibleValue({ 'text': 'DOMAIN_EXPERT', 'description': ('The translator is an expert of the domain of the ontology, for example an ' 'expert in anatomy when translating terms from an anatomy ontology such as ' 'Uberon.') }) +
-
+
- +DOMAIN_STUDENT = PermissibleValue({ 'text': 'DOMAIN_STUDENT', 'description': ('The translator is a student of the domain of the ontology, for example a ' 'student of anatomy, when translating terms from an anatomy ontology such as ' 'Uberon.') }) +
-
+
- +LAYPERSON = PermissibleValue({ 'text': 'LAYPERSON', 'description': ('The translator is an interested lay person with no specific knowledge of the ' 'domain.') }) +
-
+
- +PROFESSIONAL_TRANSLATOR = PermissibleValue({ 'text': 'PROFESSIONAL_TRANSLATOR', 'description': 'The translator is a professional translator by trade.' }) +
-
+
- +class babelon.dataclasses.slots +
Bases:
+object-
+
- +comment = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/comment'), name='comment', curie='babelon:comment', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/comment'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +predicate_id = Slot(uri=rdflib.term.URIRef('http://www.w3.org/2002/07/owl#annotatedProperty'), name='predicate_id', curie='owl:annotatedProperty', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/predicate_id'), domain=None, range=typing.Union[str, babelon.dataclasses.EntityReference, NoneType], mappings=None, pattern=None) +
-
+
- +profile_id = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/profile_id'), name='profile_id', curie='babelon:profile_id', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/profile_id'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +profile_version = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/profile_version'), name='profile_version', curie='babelon:profile_version', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/profile_version'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +source = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source'), name='source', curie='babelon:source', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/source'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +source_language = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source_language'), name='source_language', curie='babelon:source_language', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/source_language'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +source_value = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source_value'), name='source_value', curie='babelon:source_value', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/source_value'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +source_version = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source_version'), name='source_version', curie='babelon:source_version', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/source_version'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +subject_id = Slot(uri=rdflib.term.URIRef('http://www.w3.org/2002/07/owl#annotatedSource'), name='subject_id', curie='owl:annotatedSource', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/subject_id'), domain=None, range=typing.Union[str, babelon.dataclasses.EntityReference, NoneType], mappings=None, pattern=None) +
-
+
- +translation_confidence = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_confidence'), name='translation_confidence', curie='babelon:translation_confidence', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_confidence'), domain=None, range=typing.Optional[float], mappings=None, pattern=None) +
-
+
- +translation_date = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_date'), name='translation_date', curie='babelon:translation_date', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_date'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +translation_language = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_language'), name='translation_language', curie='babelon:translation_language', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_language'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +translation_precision = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_precision'), name='translation_precision', curie='babelon:translation_precision', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_precision'), domain=None, range=typing.Union[str, ForwardRef('TranslationPrecisionEnum'), NoneType], mappings=None, pattern=None) +
-
+
- +translation_predicate_id = Slot(uri=rdflib.term.URIRef('http://www.w3.org/2002/07/owl#annotatedProperty'), name='translation_predicate_id', curie='owl:annotatedProperty', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_predicate_id'), domain=<class 'babelon.dataclasses.Translation'>, range=typing.Union[str, babelon.dataclasses.EntityReference], mappings=None, pattern=None) +
-
+
- +translation_provider = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_provider'), name='translation_provider', curie='babelon:translation_provider', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_provider'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +translation_source_language = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source_language'), name='translation_source_language', curie='babelon:source_language', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_source_language'), domain=<class 'babelon.dataclasses.Translation'>, range=<class 'str'>, mappings=None, pattern=None) +
-
+
- +translation_source_value = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/source_value'), name='translation_source_value', curie='babelon:source_value', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_source_value'), domain=<class 'babelon.dataclasses.Translation'>, range=<class 'str'>, mappings=None, pattern=None) +
-
+
- +translation_status = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_status'), name='translation_status', curie='babelon:translation_status', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_status'), domain=None, range=typing.Union[str, ForwardRef('TranslationStatusEnum'), NoneType], mappings=None, pattern=None) +
-
+
- +translation_subject_id = Slot(uri=rdflib.term.URIRef('http://www.w3.org/2002/07/owl#annotatedSource'), name='translation_subject_id', curie='owl:annotatedSource', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_subject_id'), domain=<class 'babelon.dataclasses.Translation'>, range=typing.Union[str, babelon.dataclasses.EntityReference], mappings=None, pattern=None) +
-
+
- +translation_type = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_type'), name='translation_type', curie='babelon:translation_type', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_type'), domain=None, range=typing.Union[str, ForwardRef('TranslationTypeEnum'), NoneType], mappings=None, pattern=None) +
-
+
- +translation_value = Slot(uri=rdflib.term.URIRef('http://www.w3.org/2002/07/owl#annotatedTarget'), name='translation_value', curie='owl:annotatedTarget', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translation_value'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +translations = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translations'), name='translations', curie='babelon:translations', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translations'), domain=None, range=typing.Union[dict, babelon.dataclasses.Translation, typing.List[typing.Union[dict, babelon.dataclasses.Translation]], NoneType], mappings=None, pattern=None) +
-
+
- +translator = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translator'), name='translator', curie='babelon:translator', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translator'), domain=None, range=typing.Optional[str], mappings=None, pattern=None) +
-
+
- +translator_expertise = Slot(uri=rdflib.term.URIRef('https://w3id.org/babelon/translator_expertise'), name='translator_expertise', curie='babelon:translator_expertise', model_uri=rdflib.term.URIRef('https://w3id.org/babelon/translator_expertise'), domain=None, range=typing.Union[str, ForwardRef('TranslatorExpertiseEnum'), NoneType], mappings=None, pattern=None) +
babelon.translate module
+Translate Babelon profiles.
+-
+
- +class babelon.translate.OpenAITranslator(model='gpt-4-turbo-preview') +
Bases:
+TranslatorA specific translator class that uses GPT-4 for translation.
+-
+
- +model_name() +
Return the unique name of the model.
+
-
+
- +translate(text_to_translate, language_code) +
Translate text using OpenAI’s GPT-4 API (hypothetical).
+Args: +text_to_translate (str): The text to be translated. +language_code (str): The target language code (e.g., ‘de’ for German).
+Returns: +str: The translated text.
+
-
+
- +class babelon.translate.Translator +
Bases:
+objectA generic translator class.
+-
+
- +model_name() +
Return the unique name of the model.
+-
+
- Raises:
NotImplementedError: If the method is not implemented in the subclass
+
+
-
+
- +translate(text, target_language) +
Translate the provided text into the target language.
+-
+
- Args:
text (str): The text to be translated. +target_language (str): The language to translate the text into.
+
+- Raises:
NotImplementedError: If the method is not implemented in the subclass.
+
+
-
+
- +babelon.translate.get_translator_model(model='gpt-4') +
Instantiate translator model based on string.
+-
+
- Args:
model (str): The model to be instatiated.
+
+- Raises:
ValueError: If the model does not exist.
+
+
-
+
- +babelon.translate.prepare_translation_for_ontology(ontology, language_code, df_babelon, terms, fields, include_not_translated=False, update_translation_status=True) +
Prepare a babelon translation table for an ontology.
+
-
+
- +babelon.translate.translate_profile(babelon_df, language_code='en', update_existing=False, model='gpt-4') +
Iterate through DataFrame rows and translate values.
+
babelon.translation_profile module
+Translation Profile.
+-
+
- +babelon.translation_profile.statistics_translation_profile(translation_profile) +
Take as an input a babelon profile (TSV) and returns some basic stats. +:rtype:
+None+
+number of translations by source_language, target_language +number of translations by source_language, target_language, predicate_id +number of translations by source_language, target_language, translation_status
+-
+
- Args:
translation_profile (Path): translation profile
+
+
-
+
- +babelon.translation_profile.table_print(title, data) +
Print grouped translation data.
+-
+
- Args:
title (str): Table title +data (pd.DataFrame): Translation groupped data
+
+
babelon.utils module
+Utility methods for babelon processing.
+-
+
- +class babelon.utils.BabelonDataFrame(df, converter=<factory>) +
Bases:
+objectA collection of mappings represented as a DataFrame, together with additional metadata.
+-
+
-
+converter:
Converter
+
-
+
-
+df:
DataFrame
+
-
+
- +property prefix_map +
Get a simple, bijective prefix map.
+
-
+
- +classmethod with_converter(converter, df) +
Instantiate with a converter instead of a vanilla prefix map.
+-
+
- Return type: +
- + +
-
+converter:
-
+
- +babelon.utils.assemble_xliff_file(translation_units) +
-
+
- +babelon.utils.assemble_xliff_translation_unit(identifier, id_normalised, label, element, value) +
-
+
- +babelon.utils.drop_unknown_columns_babelon(df) +
Sort a babelon Dataframe according to key columns.
+
-
+
- +babelon.utils.generate_translation_units(identifier, label, definition, synonyms) +
-
+
- +babelon.utils.get_converter() +
Get default SSSOM converter.
+
-
+
- +babelon.utils.parse_babelon(input_path, drop_unknown_columns=False) +
Parse a babelon TSV file into a BabelonDataFrame.
+
-
+
- +babelon.utils.raise_for_bad_path(file_path) +
Throw exception if file path is invalid.
+-
+
- Return type: +
+None
+
-
+
- Args:
file_path: The file path or URL to be validated.
+
+- Raises:
FileNotFoundError: If the provided file path is not a valid file or URL.
+
+
-
+
- +babelon.utils.sort_babelon(df) +
Sort a babelon Dataframe according to key columns.
+
Module contents
+babelon package.
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/img/favicon.ico b/img/favicon.ico
deleted file mode 100644
index e85006a..0000000
Binary files a/img/favicon.ico and /dev/null differ
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..ed18664
--- /dev/null
+++ b/index.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+ + +A
+| + | + |
B
+| + |
|
+
C
+D
+| + | + |
E
+| + | + |
G
+| + | + |
L
+| + |
M
+
|
+
N
+| + | + |
O
+| + | + |
P
+| + | + |
R
+| + |
S
+| + | + |
T
+U
+| + |
W
+| + | + |
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/js/html5shiv.min.js b/js/html5shiv.min.js
deleted file mode 100644
index 1a01c94..0000000
--- a/js/html5shiv.min.js
+++ /dev/null
@@ -1,4 +0,0 @@
-/**
-* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
-*/
-!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000..71249f0
Binary files /dev/null and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
new file mode 100644
index 0000000..d384a43
--- /dev/null
+++ b/py-modindex.html
@@ -0,0 +1,155 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ babelon
+
+
+-
+
- babelon package
-
+
- Submodules +
- babelon.babelon_io module + +
- babelon.cli module +
- babelon.constants module +
- babelon.dataclasses module
-
+
EntityReference+
+Profile+
+Translation-
+
Translation.class_class_curie
+Translation.class_class_uri
+Translation.class_model_uri
+Translation.class_name
+Translation.comment
+Translation.predicate_id
+Translation.source
+Translation.source_language
+Translation.source_value
+Translation.source_version
+Translation.subject_id
+Translation.translation_confidence
+Translation.translation_date
+Translation.translation_language
+Translation.translation_precision
+Translation.translation_status
+Translation.translation_type
+Translation.translation_value
+Translation.translator
+Translation.translator_expertise
+
+TranslationPrecisionEnum+
+TranslationStatusEnum+
+TranslationTypeEnum+
+TranslatorExpertiseEnum+
+slots-
+
slots.comment
+slots.predicate_id
+slots.profile_id
+slots.profile_version
+slots.source
+slots.source_language
+slots.source_value
+slots.source_version
+slots.subject_id
+slots.translation_confidence
+slots.translation_date
+slots.translation_language
+slots.translation_precision
+slots.translation_predicate_id
+slots.translation_provider
+slots.translation_source_language
+slots.translation_source_value
+slots.translation_status
+slots.translation_subject_id
+slots.translation_type
+slots.translation_value
+slots.translations
+slots.translator
+slots.translator_expertise
+
+
+ - babelon.translate module + +
- babelon.translation_profile module + +
- babelon.utils module + +
- Module contents +
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search.html b/search.html
index c66a5d0..edd197f 100644
--- a/search.html
+++ b/search.html
@@ -1,120 +1,120 @@
+
+
-
+
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Python Module Index
+ +
+ b
+
+
+ | + b | ||
| + |
+ babelon | + |
| + |
+ babelon.babelon_io | + |
| + |
+ babelon.cli | + |
| + |
+ babelon.constants | + |
| + |
+ babelon.dataclasses | + |
| + |
+ babelon.translate | + |
| + |
+ babelon.translation_profile | + |
| + |
+ babelon.utils | + |
-