+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ On Read the Docs
+
+ Project Home
+
+
+ Builds
+
+
+ Downloads
+
+
+
+ Search
+
+
+
+
+
+
+ Hosted by Read the Docs
+
+
+
+ `;
+
+ // 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 = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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 = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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..c7fe6c6
--- /dev/null
+++ b/_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/_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..6f8b210
--- /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 #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/_static/searchtools.js b/_static/searchtools.js
new file mode 100644
index 0000000..91f4be5
--- /dev/null
+++ b/_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/_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(
+ '
' +
+ '' +
+ _("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/genindex.html b/genindex.html
new file mode 100644
index 0000000..29d876b
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,258 @@
+
+
+
+
+
+
+
+
Index — pyladoc documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pyladoc
+
+
+
+
+
+
+
+
+
+
Index
+
+
+
A
+ |
B
+ |
C
+ |
D
+ |
E
+ |
F
+ |
G
+ |
I
+ |
L
+ |
N
+ |
R
+ |
T
+
+
+
A
+
+
+
B
+
+
+
C
+
+
+
D
+
+
+
E
+
+
+
F
+
+
+
G
+
+
+
I
+
+
+
L
+
+
+
N
+
+
+
R
+
+
+
T
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..77fae2d
--- /dev/null
+++ b/index.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
Pyladoc — pyladoc documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pyladoc
+
+
+
+
+
+
+
+
+
+
+Pyladoc
+
+Description
+Pyladoc is a python package for programmatically generating HTML and
+PDF/LaTeX output. This package targets specifically applications where reports
+or results with Pandas-tables and Matplotlib-figures are generated
+to be displayed as website and as PDF document without involving any manual
+formatting steps.
+This package focuses on the “Document in Code” approach for cases
+where a lot of calculations and data handling is done but not a lot of
+document text needs to be displayed. The multiline string capability of Python
+handles this very well. In comparison to “Code in Document”-templates
+python tools supports this approach out of the box - similar doch docstrings.
+As backend for PDF generation LaTeX is used. There are excellent engines for
+rendering HTML to PDF, but even if there is no requirement for an
+accurate typesetting and what not, placing programmatically content of variable
+composition and element sizes on fixed size pages without manual intervention
+is a hard problem where LaTeX is superior.
+
+
+Example outputs
+
+
+The documents are generated by the script tests/test_rendering_example1_doc.py
+
+Supported primitives
+
+Text (can be Markdown or HTML formatted)
Headings
Tables (Pandas, Markdown or HTML)
Matplotlib figures
LaTeX equations (block or inline)
Named references for figures, tables and equations
+
+
+Key Features
+
+HTML and PDF/LaTeX rendering of the same document
Single file output including figures
Figure and equation embedding in HTML by inline SVG, SVG in Base64 or PNG in Base64
Figure embedding in LaTeX as PGF/TikZ
Tested on Linux and Windows
+
+
+
+
+Installation
+It can be installed with pip:
+
+
+
+Dependencies
+Pyladoc depends on the markdown package.
+Optional dependencies are:
+
+Matplotlib python package for rendering LaTeX equations for HTML output
LaTeX for exporting to PDF or exporting Matplotlib figures to LaTeX (PGF/TikZ rendering)
Pandas and Matplotlib for including Pandas Tables and Matplotlib figures (obviously)
+For the included template the following LaTeX setup works on Ubuntu:
+ apt-get update
+sudo apt-get install -y texlive-latex-extra texlive-fonts-extra lmodern texlive-xetex texlive-science
+
+
+
+Usage
+It is easy to use as the following example code shows:
+import pyladoc
+import pandas as pd
+
+doc = pyladoc . DocumentWriter ()
+
+doc . add_markdown ( """
+ # Example
+ This is inline LaTeX: $$ \\ lambda$$
+
+ This is a LaTeX block with a number:
+ $$
+ \\ label{eq:test1}
+ \\ lambda_{ \t ext {mix} } = \\ sum_{i=1}^ {n} \\ frac{x_i \\ lambda_i}{ \\ sum_{j=1}^ {n} x_j \\ Phi_ {ij} }
+ $$
+
+ This is an example table. The table @table:pandas_example shows some random data.
+ """ )
+
+some_data = {
+ 'Row1' : [ "Line1" , "Line2" , "Line3" ],
+ 'Row2' : [ 120 , 100 , 110 ],
+ 'Row3' : [ '12 g/km' , '> 150 g/km' , '110 g/km' ]
+}
+df = pd . DataFrame ( some_data )
+doc . add_table ( df , 'This is a pandas example table' , 'pandas_example' )
+
+html_code = doc . to_html ()
+print ( html_code )
+
+doc . to_pdf ( 'test.pdf' )
+
+
+
+Contributing
+Contributions are welcome, please open an issue or submit a pull request on GitHub.
+
+
+Developer Guide
+To get started with developing the pyladoc
+First, clone the repository to your local machine using Git:
+ clone https://github.com/Nonannet/pyladoc.git
+cd pyladoc
+
+
It’s recommended to setup an venv:
+ -m venv venv
+source venv/bin/activate # On Windows use `venv\Scripts\activate`
+
+
Install the package and dev-dependencies while keeping files in the
+current directory:
+
+Ensure that everything is set up correctly by running the tests:
+
+
+
+License
+This project is licensed under the MIT License - see the LICENSE
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/media/output_example.png b/media/output_example.png
new file mode 100644
index 0000000..2d13124
Binary files /dev/null and b/media/output_example.png differ
diff --git a/modules.html b/modules.html
new file mode 100644
index 0000000..3eebdc9
--- /dev/null
+++ b/modules.html
@@ -0,0 +1,637 @@
+
+
+
+
+
+
+
+
+
Pyladoc classes, functions and submodules — pyladoc documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pyladoc
+
+
+
+
+
+
+
+
+
+Pyladoc classes, functions and submodules
+
+DocumentWriter Class
+
+
+class pyladoc. DocumentWriter
+Bases: object
+A class to create a document for exporting to HTML or LaTeX.
+
+
+add_diagram ( fig caption = '' ref_id = '' prefix_pattern = 'Figure {}: ' ref_type = 'fig' centered = True )
+Adds a diagram to the document.
+
+Parameters:
+
+fig (None
caption (str
ref_id (str
prefix_pattern (str
ref_type (str
centered (bool
+Return type:
+None
+
+
+
+
+
+add_document ( doc )
+
+Return type:
+None
+
+
+
+
+
+add_equation ( latex_equation ref_id = '' ref_type = 'eq' )
+Adds a LaTeX equation to the document.
+
+Parameters:
+
+latex_equation (str
ref_id (str
+Return type:
+None
+
+
+
+
+
+add_h1 ( text )
+Adds a h1 heading to the document.
+
+Parameters:
+text (str
+Return type:
+None
+
+
+
+
+
+add_h2 ( text )
+Adds a h2 heading to the document.
+
+Parameters:
+text (str
+Return type:
+None
+
+
+
+
+
+add_h3 ( text )
+Adds a h3 heading to the document.
+
+Parameters:
+text (str
+Return type:
+None
+
+
+
+
+
+add_html ( text )
+Adds HTML formatted text to the document. For the LaTeX
+export only basic HTML for text formatting and tables
+is supported.
+
+Parameters:
+text (str
+Return type:
+None
+
+
+
+
+
+add_markdown ( text section_class = '' )
+Adds a markdown formatted text to the document.
+
+Parameters:
+
+
+Return type:
+None
+
+
+
+
+
+add_table ( table caption = '' ref_id = '' prefix_pattern = 'Table {}: ' ref_type = 'table' centered = True )
+Adds a table to the document.
+
+Parameters:
+
+table (None
caption (str
ref_id (str
prefix_pattern (str
ref_type (str
centered (bool
+Return type:
+None
+
+
+
+
+
+add_text ( text section_class = '' )
+Adds a text paragraph to the document.
+
+Parameters:
+
+
+Return type:
+None
+
+
+
+
+
+new_field ( name )
+
+Return type:
+DocumentWriter
+
+
+
+
+
+to_html ( figure_format = 'svg' base64_svgs = False figure_scale = 1 )
+Export the document to HTML. Figures will bew embedded in the HTML code.
+The format can be selected between png in base64, inline svg or svg in base64.
+
+Parameters:
+
+figure_format (Literal 'svg' 'png' 'pgf'
base64_svgs (bool
+Return type:
+str
+Returns:
+The HTML code
+
+
+
+
+
+to_latex ( font_family = None table_renderer = 'simple' figure_scale = 1 )
+Export the document to LaTeX. Figures will be embedded as pgf graphics.
+
+Parameters:
+
+font_family (Literal None 'serif' 'sans-serif'
table_renderer (Literal 'pandas' 'simple'
+Return type:
+str
+Returns:
+The LaTeX code
+
+
+
+
+
+to_pdf ( file_path font_family = None table_renderer = 'simple' latex_template_path = '' figure_scale = 1 engine = 'pdflatex' )
+Export the document to a PDF file using LaTeX.
+
+Parameters:
+
+file_path (str
font_family (Literal None 'serif' 'sans-serif'
latex_template_path (str
engine (Literal 'pdflatex' 'lualatex' 'xelatex' 'tectonic'
+Return type:
+bool
+Returns:
+True if the PDF file was successfully created
+
+
+
+
+
+
+
+Functions
+
+
+pyladoc. escape_html ( text )
+Escapes special HTML characters in a given string.
+
+Parameters:
+text (str
+Return type:
+str
+Returns:
+Escaped text save for inserting into HTML code
+
+
+
+
+
+pyladoc. figure_to_string ( fig unique_id figure_format = 'svg' font_family = None scale = 1 alt_text = '' base64 = False )
+Converts a matplotlib figure to a ascii-string. For png base64 encoding is
+used in general, for svg base64 encoding can be enabled. For base64 encoded
+figures a img-tag is included in the output.
+
+Parameters:
+
+fig (None
figure_format (Literal 'svg' 'png' 'pgf'
font_family (str None
scale (float
alt_text (str
base64 (bool
+Return type:
+str
+Returns:
+The figure as ascii-string
+
+
+
+
+
+pyladoc. inject_to_template ( content template_path = '' internal_template = '' )
+injects a content string into a template. The placeholder <!–CONTENT–>
+will be replaced by the content. If the placeholder is prefixed with a
+‘%’ comment character, this character will be replaced as well.
+
+Parameters:
+
+
+Return type:
+str
+Returns:
+Template with included content
+
+
+
+
+
+pyladoc. latex_to_figure ( latex_code )
+
+Return type:
+None
+
+
+
+
+
+Submodule latex
+
+
+pyladoc.latex. basic_formatter ( value )
+
+Return type:
+str
+
+
+
+
+
+pyladoc.latex. compile ( latex_code output_file = '' encoding = 'utf-8' engine = 'pdflatex' )
+Compiles LaTeX code to a PDF file.
+
+Parameters:
+
+latex_code (str
output_file (str
encoding (str
engine (Literal 'pdflatex' 'lualatex' 'xelatex' 'tectonic'
+Returns:
+
+
+Return type:
+A tuple with three elements
+
+
+
+
+
+pyladoc.latex. escape_text ( text )
+Escapes special LaTeX characters and often used unicode characters in a given string.
+
+Parameters:
+text (str
+Return type:
+str
+Returns:
+Escaped text
+
+
+
+
+
+pyladoc.latex. from_html ( html_code )
+Converts HTML code to LaTeX code using HTMLParser.
+
+Parameters:
+html_code (str
+Return type:
+str
+Returns:
+The LaTeX code.
+
+
+
+
+
+pyladoc.latex. get_equation_code ( equation reference block = False )
+Converts an equation string to LaTeX code.
+
+Parameters:
+
+
+Return type:
+str
+
+
+
+
+
+pyladoc.latex. inject_latex_command ( text command )
+
+Return type:
+str
+
+
+
+
+
+pyladoc.latex. normalize_label_text ( text )
+Replace any special non-allowed character in the lable text.
+
+Parameters:
+text (str
+Return type:
+str
+Returns:
+Normalized text
+
+
+
+
+
+pyladoc.latex. render_pandas_styler_table ( df_style caption = '' label = '' centering = True )
+Converts a pandas Styler object to LaTeX table.
+
+Parameters:
+
+df_style (None
caption (str
label (str
centering (bool
+Return type:
+str
+Returns:
+The LaTeX code.
+
+
+
+
+
+pyladoc.latex. to_ascii ( text )
+Replaces/escapes often used unicode characters in LaTeX code or text
+with its LaTeX ascii equivalents.
+
+Parameters:
+text (str
+Return type:
+str
+Returns:
+The escaped text.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000..8345e8f
Binary files /dev/null and b/objects.inv differ
diff --git a/readme.html b/readme.html
new file mode 100644
index 0000000..c31a49a
--- /dev/null
+++ b/readme.html
@@ -0,0 +1,269 @@
+
+
+
+
+
+
+
+
+
Pyladoc — pyladoc documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pyladoc
+
+
+
+
+
+
+
+
+
+Pyladoc
+
+Description
+Pyladoc is a python package for programmatically generating HTML and
+PDF/LaTeX output. This package targets specifically applications where reports
+or results with Pandas-tables and Matplotlib-figures are generated
+to be displayed as website and as PDF document without involving any manual
+formatting steps.
+This package focuses on the “Document in Code” approach for cases
+where a lot of calculations and data handling is done but not a lot of
+document text needs to be displayed. The multiline string capability of Python
+handles this very well. In comparison to “Code in Document”-templates
+python tools supports this approach out of the box - similar doch docstrings.
+As backend for PDF generation LaTeX is used. There are excellent engines for
+rendering HTML to PDF, but even if there is no requirement for an
+accurate typesetting and what not, placing programmatically content of variable
+composition and element sizes on fixed size pages without manual intervention
+is a hard problem where LaTeX is superior.
+
+
+Example outputs
+
+
+The documents are generated by the script tests/test_rendering_example1_doc.py
+
+Supported primitives
+
+Text (can be Markdown or HTML formatted)
Headings
Tables (Pandas, Markdown or HTML)
Matplotlib figures
LaTeX equations (block or inline)
Named references for figures, tables and equations
+
+
+Key Features
+
+HTML and PDF/LaTeX rendering of the same document
Single file output including figures
Figure and equation embedding in HTML by inline SVG, SVG in Base64 or PNG in Base64
Figure embedding in LaTeX as PGF/TikZ
Tested on Linux and Windows
+
+
+
+
+Installation
+It can be installed with pip:
+
+
+
+Dependencies
+Pyladoc depends on the markdown package.
+Optional dependencies are:
+
+Matplotlib python package for rendering LaTeX equations for HTML output
LaTeX for exporting to PDF or exporting Matplotlib figures to LaTeX (PGF/TikZ rendering)
Pandas and Matplotlib for including Pandas Tables and Matplotlib figures (obviously)
+For the included template the following LaTeX setup works on Ubuntu:
+ apt-get update
+sudo apt-get install -y texlive-latex-extra texlive-fonts-extra lmodern texlive-xetex texlive-science
+
+
+
+Usage
+It is easy to use as the following example code shows:
+import pyladoc
+import pandas as pd
+
+doc = pyladoc . DocumentWriter ()
+
+doc . add_markdown ( """
+ # Example
+ This is inline LaTeX: $$ \\ lambda$$
+
+ This is a LaTeX block with a number:
+ $$
+ \\ label{eq:test1}
+ \\ lambda_{ \t ext {mix} } = \\ sum_{i=1}^ {n} \\ frac{x_i \\ lambda_i}{ \\ sum_{j=1}^ {n} x_j \\ Phi_ {ij} }
+ $$
+
+ This is an example table. The table @table:pandas_example shows some random data.
+ """ )
+
+some_data = {
+ 'Row1' : [ "Line1" , "Line2" , "Line3" ],
+ 'Row2' : [ 120 , 100 , 110 ],
+ 'Row3' : [ '12 g/km' , '> 150 g/km' , '110 g/km' ]
+}
+df = pd . DataFrame ( some_data )
+doc . add_table ( df , 'This is a pandas example table' , 'pandas_example' )
+
+html_code = doc . to_html ()
+print ( html_code )
+
+doc . to_pdf ( 'test.pdf' )
+
+
+
+Contributing
+Contributions are welcome, please open an issue or submit a pull request on GitHub.
+
+
+Developer Guide
+To get started with developing the pyladoc
+First, clone the repository to your local machine using Git:
+ clone https://github.com/Nonannet/pyladoc.git
+cd pyladoc
+
+
It’s recommended to setup an venv:
+ -m venv venv
+source venv/bin/activate # On Windows use `venv\Scripts\activate`
+
+
Install the package and dev-dependencies while keeping files in the
+current directory:
+
+Ensure that everything is set up correctly by running the tests:
+
+
+
+License
+This project is licensed under the MIT License - see the LICENSE
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..793a1f6
--- /dev/null
+++ b/search.html
@@ -0,0 +1,121 @@
+
+
+
+
+
+
+
+
Search — pyladoc documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ pyladoc
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000..c36ae6d
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles":{"Contents:":[[0,null]],"Contributing":[[0,"contributing"],[2,"contributing"]],"Dependencies":[[0,"dependencies"],[2,"dependencies"]],"Description":[[0,"description"],[2,"description"]],"Developer Guide":[[0,"developer-guide"],[2,"developer-guide"]],"DocumentWriter Class":[[1,"documentwriter-class"]],"Example outputs":[[0,"example-outputs"],[2,"example-outputs"]],"Functions":[[1,"functions"]],"Installation":[[0,"installation"],[2,"installation"]],"Key Features":[[0,"key-features"],[2,"key-features"]],"License":[[0,"license"],[2,"license"]],"Pyladoc":[[0,"pyladoc"],[2,null]],"Pyladoc classes, functions and submodules":[[1,null]],"Submodule latex":[[1,"submodule-latex"]],"Supported primitives":[[0,"supported-primitives"],[2,"supported-primitives"]],"Usage":[[0,"usage"],[2,"usage"]],"Usage Scenarios":[[0,"usage-scenarios"],[2,"usage-scenarios"]]},"docnames":["index","modules","readme"],"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.md","modules.md","readme.md"],"indexentries":{"add_diagram() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_diagram",false]],"add_document() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_document",false]],"add_equation() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_equation",false]],"add_h1() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h1",false]],"add_h2() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h2",false]],"add_h3() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_h3",false]],"add_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_html",false]],"add_markdown() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_markdown",false]],"add_table() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_table",false]],"add_text() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.add_text",false]],"basic_formatter() (in module pyladoc.latex)":[[1,"pyladoc.latex.basic_formatter",false]],"compile() (in module pyladoc.latex)":[[1,"pyladoc.latex.compile",false]],"documentwriter (class in pyladoc)":[[1,"pyladoc.DocumentWriter",false]],"escape_html() (in module pyladoc)":[[1,"pyladoc.escape_html",false]],"escape_text() (in module pyladoc.latex)":[[1,"pyladoc.latex.escape_text",false]],"figure_to_string() (in module pyladoc)":[[1,"pyladoc.figure_to_string",false]],"from_html() (in module pyladoc.latex)":[[1,"pyladoc.latex.from_html",false]],"get_equation_code() (in module pyladoc.latex)":[[1,"pyladoc.latex.get_equation_code",false]],"inject_latex_command() (in module pyladoc.latex)":[[1,"pyladoc.latex.inject_latex_command",false]],"inject_to_template() (in module pyladoc)":[[1,"pyladoc.inject_to_template",false]],"latex_to_figure() (in module pyladoc)":[[1,"pyladoc.latex_to_figure",false]],"new_field() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.new_field",false]],"normalize_label_text() (in module pyladoc.latex)":[[1,"pyladoc.latex.normalize_label_text",false]],"render_pandas_styler_table() (in module pyladoc.latex)":[[1,"pyladoc.latex.render_pandas_styler_table",false]],"to_ascii() (in module pyladoc.latex)":[[1,"pyladoc.latex.to_ascii",false]],"to_html() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_html",false]],"to_latex() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_latex",false]],"to_pdf() (pyladoc.documentwriter method)":[[1,"pyladoc.DocumentWriter.to_pdf",false]]},"objects":{"pyladoc":[[1,0,1,"","DocumentWriter"],[1,2,1,"","escape_html"],[1,2,1,"","figure_to_string"],[1,2,1,"","inject_to_template"],[1,2,1,"","latex_to_figure"]],"pyladoc.DocumentWriter":[[1,1,1,"","add_diagram"],[1,1,1,"","add_document"],[1,1,1,"","add_equation"],[1,1,1,"","add_h1"],[1,1,1,"","add_h2"],[1,1,1,"","add_h3"],[1,1,1,"","add_html"],[1,1,1,"","add_markdown"],[1,1,1,"","add_table"],[1,1,1,"","add_text"],[1,1,1,"","new_field"],[1,1,1,"","to_html"],[1,1,1,"","to_latex"],[1,1,1,"","to_pdf"]],"pyladoc.latex":[[1,2,1,"","basic_formatter"],[1,2,1,"","compile"],[1,2,1,"","escape_text"],[1,2,1,"","from_html"],[1,2,1,"","get_equation_code"],[1,2,1,"","inject_latex_command"],[1,2,1,"","normalize_label_text"],[1,2,1,"","render_pandas_styler_table"],[1,2,1,"","to_ascii"]]},"objnames":{"0":["py","class","Python class"],"1":["py","method","Python method"],"2":["py","function","Python function"]},"objtypes":{"0":"py:class","1":"py:method","2":"py:function"},"terms":{"":[0,2],"1":[0,1,2],"100":[0,2],"110":[0,2],"12":[0,2],"120":[0,2],"150":[0,2],"8":1,"A":1,"As":[0,2],"For":[0,1,2],"If":1,"In":[0,2],"It":[0,2],"On":[0,2],"The":[0,1,2],"There":[0,2],"To":[0,2],"accur":[0,2],"activ":[0,2],"add":1,"add_diagram":1,"add_docu":1,"add_equ":1,"add_h1":1,"add_h2":1,"add_h3":1,"add_html":1,"add_markdown":[0,1,2],"add_tabl":[0,1,2],"add_text":1,"allow":1,"alt":1,"alt_text":1,"an":[0,1,2],"ani":[0,1,2],"applic":[0,2],"approach":[0,2],"apt":[0,2],"ar":[0,2],"ascii":1,"backend":[0,2],"base":1,"base64":[0,1,2],"base64_svg":1,"basic":1,"basic_formatt":1,"between":1,"bew":1,"bin":[0,2],"block":[0,1,2],"bool":1,"boolean":1,"box":[0,2],"calcul":[0,2],"can":[0,1,2],"capabl":[0,2],"caption":1,"case":[0,2],"cd":[0,2],"center":1,"charact":1,"class":0,"clone":[0,2],"code":[0,1,2],"column":1,"com":[0,2],"command":1,"comment":1,"comparison":[0,2],"compil":1,"composit":[0,2],"content":[1,2],"convert":1,"correctli":[0,2],"creat":1,"current":[0,2],"custom":1,"data":[0,2],"datafram":[0,1,2],"default":1,"detail":[0,2],"determin":1,"dev":[0,2],"df":[0,2],"df_style":1,"diagram":1,"directori":[0,2],"displai":[0,1,2],"doc":[0,1,2],"doch":[0,2],"docstr":[0,2],"document":[0,1,2],"documentwrit":[0,2],"done":[0,2],"e":[0,1,2],"each":1,"easi":[0,2],"element":[0,1,2],"embed":[0,1,2],"enabl":1,"encod":1,"engin":[0,1,2],"ensur":[0,2],"eq":[0,1,2],"equat":[0,1,2],"equip":[0,2],"equival":1,"error":1,"escap":1,"escape_html":1,"escape_text":1,"even":[0,2],"everyth":[0,2],"excel":[0,2],"export":[0,1,2],"express":1,"extra":[0,2],"factor":1,"fals":1,"famili":1,"fig":1,"figur":[0,1,2],"figure_format":1,"figure_scal":1,"figure_to_str":1,"file":[0,1,2],"file_path":1,"first":[0,2],"fix":[0,2],"float":1,"focus":[0,2],"follow":[0,2],"font":[0,1,2],"font_famili":1,"format":[0,1,2],"frac":[0,2],"from_html":1,"front":1,"function":0,"g":[0,1,2],"gener":[0,1,2],"get":[0,2],"get_equation_cod":1,"git":[0,2],"github":[0,2],"given":1,"graphic":1,"guess":1,"h1":1,"h2":1,"h3":1,"ha":1,"handl":[0,2],"hard":[0,2],"head":[0,1,2],"html":[0,1,2],"html_code":[0,1,2],"htmlparser":1,"http":[0,2],"i":[0,1,2],"id":1,"ij":[0,2],"imag":1,"img":1,"import":[0,2],"includ":[0,1,2],"indic":1,"individu":1,"inject":1,"inject_latex_command":1,"inject_to_templ":1,"inlin":[0,1,2],"input":1,"insert":1,"intern":1,"internal_templ":1,"intervent":[0,2],"involv":[0,2],"issu":[0,2],"its":1,"j":[0,2],"keep":[0,2],"km":[0,2],"lab":[0,2],"label":[0,1,2],"labl":1,"lambda":[0,2],"lambda_":[0,2],"lambda_i":[0,2],"latex":[0,2],"latex_cod":1,"latex_equ":1,"latex_template_path":1,"latex_to_figur":1,"line1":[0,2],"line2":[0,2],"line3":[0,2],"linux":[0,2],"list":1,"liter":1,"lmodern":[0,2],"local":[0,2],"lot":[0,2],"lualatex":1,"m":[0,2],"machin":[0,2],"manual":[0,2],"markdown":[0,1,2],"matplotlib":[0,1,2],"mit":[0,2],"mix":[0,2],"multilin":[0,2],"n":[0,2],"name":[0,1,2],"need":[0,2],"new_field":1,"non":1,"nonannet":[0,2],"none":1,"normal":1,"normalize_label_text":1,"number":[0,1,2],"object":1,"obvious":[0,2],"often":1,"onli":1,"open":[0,2],"option":[0,2],"out":[0,2],"output":1,"output_fil":1,"overwrit":1,"packag":[0,2],"page":[0,2],"panda":[0,1,2],"pandas_exampl":[0,2],"paragraph":1,"paramet":1,"path":1,"pd":[0,2],"pdf":[0,1,2],"pdflatex":1,"pgf":[0,1,2],"phi_":[0,2],"pip":[0,2],"place":[0,2],"placehold":1,"pleas":[0,2],"png":[0,1,2],"prefix":1,"prefix_pattern":1,"print":[0,2],"problem":[0,2],"programmat":[0,2],"project":[0,2],"provid":1,"pull":[0,2],"py":[0,2],"pytest":[0,2],"python":[0,2],"random":[0,2],"recommend":[0,2],"ref_id":1,"ref_typ":1,"refer":[0,1,2],"referenc":1,"render":[0,1,2],"render_pandas_styler_t":1,"replac":1,"report":[0,2],"repositori":[0,2],"request":[0,2],"requir":[0,2],"result":[0,2],"return":1,"row1":[0,2],"row2":[0,2],"row3":[0,2],"run":[0,2],"same":[0,2],"san":1,"save":1,"scale":1,"scienc":[0,2],"script":[0,2],"section":1,"section_class":1,"see":[0,2],"select":1,"separ":1,"serif":1,"set":[0,2],"setup":[0,2],"show":[0,2],"similar":[0,2],"simpl":1,"singl":[0,2],"size":[0,1,2],"some":[0,2],"some_data":[0,2],"sourc":[0,2],"special":1,"specif":[0,2],"start":[0,2],"step":[0,2],"str":1,"string":[0,1,2],"styler":1,"submit":[0,2],"submodul":0,"success":1,"successfulli":1,"sudo":[0,2],"sum_":[0,2],"superior":[0,2],"support":1,"svg":[0,1,2],"tabl":[0,1,2],"table_render":1,"tag":1,"target":[0,2],"tecton":1,"templat":[0,1,2],"template_path":1,"test":[0,2],"test1":[0,2],"test_html_render1":[0,2],"test_latex_render1":[0,2],"test_rendering_example1_doc":[0,2],"texliv":[0,2],"text":[0,1,2],"thi":[0,1,2],"three":1,"tikz":[0,2],"to_ascii":1,"to_html":[0,1,2],"to_latex":1,"to_pdf":[0,1,2],"tool":[0,2],"true":1,"tupl":1,"type":1,"typeset":[0,2],"ubuntu":[0,2],"under":[0,2],"unicod":1,"unique_id":1,"up":[0,2],"updat":[0,2],"us":[0,1,2],"utf":1,"valu":1,"variabl":[0,2],"venv":[0,2],"veri":[0,2],"wa":1,"warn":1,"webservic":[0,2],"websit":[0,2],"welcom":[0,2],"well":[0,1,2],"what":[0,2],"where":[0,2],"whether":1,"while":[0,2],"window":[0,2],"without":[0,2],"work":[0,2],"x_i":[0,2],"x_j":[0,2],"xelatex":1,"xetex":[0,2],"y":[0,2],"your":[0,2]},"titles":["Pyladoc","Pyladoc classes, functions and submodules","Pyladoc"],"titleterms":{"class":1,"content":0,"contribut":[0,2],"depend":[0,2],"descript":[0,2],"develop":[0,2],"documentwrit":1,"exampl":[0,2],"featur":[0,2],"function":1,"guid":[0,2],"instal":[0,2],"kei":[0,2],"latex":1,"licens":[0,2],"output":[0,2],"primit":[0,2],"pyladoc":[0,1,2],"scenario":[0,2],"submodul":1,"support":[0,2],"usag":[0,2]}})
\ No newline at end of file
