2025-05-26 08:14:43 +00:00
|
|
|
|
|
|
|
|
<!DOCTYPE html>
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<html lang="en" data-content_root="./" >
|
|
|
|
|
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><title>Search - pyladoc documentation</title>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<script data-cfasync="false">
|
|
|
|
|
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
|
|
|
|
|
document.documentElement.dataset.theme = localStorage.getItem("theme") || "";
|
|
|
|
|
</script>
|
|
|
|
|
<!--
|
|
|
|
|
this give us a css class that will be invisible only if js is disabled
|
|
|
|
|
-->
|
|
|
|
|
<noscript>
|
|
|
|
|
<style>
|
|
|
|
|
.pst-js-only { display: none !important; }
|
|
|
|
|
|
|
|
|
|
</style>
|
|
|
|
|
</noscript>
|
|
|
|
|
|
|
|
|
|
<!-- Loaded before other Sphinx assets -->
|
|
|
|
|
<link href="_static/styles/theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
|
|
|
|
|
<link href="_static/styles/pydata-sphinx-theme.css?digest=8878045cc6db502f8baf" rel="stylesheet" />
|
|
|
|
|
|
|
|
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8f2a1f02" />
|
|
|
|
|
|
|
|
|
|
<!-- So that users can add custom icons -->
|
|
|
|
|
<script src="_static/scripts/fontawesome.js?digest=8878045cc6db502f8baf"></script>
|
|
|
|
|
<!-- Pre-loaded scripts that we'll load fully later -->
|
|
|
|
|
<link rel="preload" as="script" href="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf" />
|
|
|
|
|
<link rel="preload" as="script" href="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf" />
|
|
|
|
|
|
|
|
|
|
<script src="_static/documentation_options.js?v=5929fcd5"></script>
|
|
|
|
|
<script src="_static/doctools.js?v=9bcbadda"></script>
|
|
|
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
|
|
|
<script>DOCUMENTATION_OPTIONS.pagename = 'search';</script>
|
|
|
|
|
<script src="_static/searchtools.js"></script>
|
|
|
|
|
<script src="_static/language_data.js"></script>
|
|
|
|
|
<script src="searchindex.js"></script>
|
2025-05-26 08:14:43 +00:00
|
|
|
<link rel="index" title="Index" href="genindex.html" />
|
2025-06-06 17:22:10 +00:00
|
|
|
<link rel="search" title="Search" href="#" />
|
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
|
|
|
<meta name="docsearch:language" content="en"/>
|
|
|
|
|
<meta name="docsearch:version" content="" />
|
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<div id="pst-skip-link" class="skip-link d-print-none"><a href="#main-content">Skip to main content</a></div>
|
|
|
|
|
|
|
|
|
|
<div id="pst-scroll-pixel-helper"></div>
|
|
|
|
|
|
|
|
|
|
<button type="button" class="btn rounded-pill" id="pst-back-to-top">
|
|
|
|
|
<i class="fa-solid fa-arrow-up"></i>Back to top</button>
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
<dialog id="pst-search-dialog">
|
|
|
|
|
|
|
|
|
|
<form class="bd-search d-flex align-items-center"
|
|
|
|
|
action="#"
|
|
|
|
|
method="get">
|
|
|
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|
|
|
|
<input type="search"
|
|
|
|
|
class="form-control"
|
|
|
|
|
name="q"
|
|
|
|
|
placeholder="Search the docs ..."
|
|
|
|
|
aria-label="Search the docs ..."
|
|
|
|
|
autocomplete="off"
|
|
|
|
|
autocorrect="off"
|
|
|
|
|
autocapitalize="off"
|
|
|
|
|
spellcheck="false"/>
|
|
|
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
|
|
|
|
|
</form>
|
|
|
|
|
</dialog>
|
|
|
|
|
|
|
|
|
|
<div class="pst-async-banner-revealer d-none">
|
|
|
|
|
<aside id="bd-header-version-warning" class="d-none d-print-none" aria-label="Version warning"></aside>
|
2025-05-26 08:14:43 +00:00
|
|
|
</div>
|
|
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
<header class="bd-header navbar navbar-expand-lg bd-navbar d-print-none">
|
|
|
|
|
<div class="bd-header__inner bd-page-width">
|
|
|
|
|
<button class="pst-navbar-icon sidebar-toggle primary-toggle" aria-label="Site navigation">
|
|
|
|
|
<span class="fa-solid fa-bars"></span>
|
|
|
|
|
</button>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="col-lg-3 navbar-header-items__start">
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a class="navbar-brand logo" href="index.html">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="title logo__title">pyladoc documentation</p>
|
|
|
|
|
|
|
|
|
|
</a></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="col-lg-9 navbar-header-items">
|
|
|
|
|
|
|
|
|
|
<div class="me-auto navbar-header-items__center">
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item">
|
|
|
|
|
<nav>
|
|
|
|
|
<ul class="bd-navbar-elements navbar-nav">
|
|
|
|
|
|
|
|
|
|
<li class="nav-item ">
|
|
|
|
|
<a class="nav-link nav-internal" href="_autogenerated/index.html">
|
|
|
|
|
Classes and functions
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
2025-05-26 08:14:43 +00:00
|
|
|
</ul>
|
2025-06-06 17:22:10 +00:00
|
|
|
</nav></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="navbar-header-items__end">
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item navbar-persistent--container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|
|
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|
|
|
|
<span class="search-button__default-text">Search</span>
|
|
|
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item">
|
|
|
|
|
|
|
|
|
|
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|
|
|
|
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
|
|
|
|
|
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
|
|
|
|
|
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
|
|
|
|
|
</button></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
2025-05-26 08:14:43 +00:00
|
|
|
</div>
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="navbar-persistent--mobile">
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
<button class="btn search-button-field search-button__button pst-js-only" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|
|
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|
|
|
|
<span class="search-button__default-text">Search</span>
|
|
|
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd class="kbd-shortcut__modifier">K</kbd></span>
|
|
|
|
|
</button>
|
|
|
|
|
</div>
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
</div>
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
</header>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="bd-container">
|
|
|
|
|
<div class="bd-container__inner bd-page-width">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<dialog id="pst-primary-sidebar-modal"></dialog>
|
|
|
|
|
<div id="pst-primary-sidebar" class="bd-sidebar-primary bd-sidebar hide-on-wide">
|
|
|
|
|
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
<div class="sidebar-header-items sidebar-primary__section">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="sidebar-header-items__center">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item">
|
|
|
|
|
<nav>
|
|
|
|
|
<ul class="bd-navbar-elements navbar-nav">
|
|
|
|
|
|
|
|
|
|
<li class="nav-item ">
|
|
|
|
|
<a class="nav-link nav-internal" href="_autogenerated/index.html">
|
|
|
|
|
Classes and functions
|
|
|
|
|
</a>
|
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
|
</nav></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="sidebar-header-items__end">
|
|
|
|
|
|
|
|
|
|
<div class="navbar-item">
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
<button class="btn btn-sm nav-link pst-navbar-icon theme-switch-button pst-js-only" aria-label="Color mode" data-bs-title="Color mode" data-bs-placement="bottom" data-bs-toggle="tooltip">
|
|
|
|
|
<i class="theme-switch fa-solid fa-sun fa-lg" data-mode="light" title="Light"></i>
|
|
|
|
|
<i class="theme-switch fa-solid fa-moon fa-lg" data-mode="dark" title="Dark"></i>
|
|
|
|
|
<i class="theme-switch fa-solid fa-circle-half-stroke fa-lg" data-mode="auto" title="System Settings"></i>
|
|
|
|
|
</button></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="sidebar-primary-items__end sidebar-primary__section">
|
|
|
|
|
<div class="sidebar-primary-item">
|
|
|
|
|
<div id="ethical-ad-placement"
|
|
|
|
|
class="flat"
|
|
|
|
|
data-ea-publisher="readthedocs"
|
|
|
|
|
data-ea-type="readthedocs-sidebar"
|
|
|
|
|
data-ea-manual="true">
|
|
|
|
|
</div></div>
|
2025-05-26 08:14:43 +00:00
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
<main id="main-content" class="bd-main" role="main">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="bd-content">
|
|
|
|
|
<div class="bd-article-container">
|
|
|
|
|
|
|
|
|
|
<div class="bd-header-article d-print-none"></div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="bd-search-container">
|
|
|
|
|
<h1>Search</h1>
|
|
|
|
|
<noscript>
|
|
|
|
|
<div class="admonition error">
|
|
|
|
|
<p class="admonition-title">Error</p>
|
|
|
|
|
<p>Please activate JavaScript to enable the search functionality.</p>
|
|
|
|
|
</div>
|
|
|
|
|
</noscript>
|
|
|
|
|
|
|
|
|
|
<form class="bd-search d-flex align-items-center"
|
|
|
|
|
action="#"
|
|
|
|
|
method="get">
|
|
|
|
|
<i class="fa-solid fa-magnifying-glass"></i>
|
|
|
|
|
<input type="search"
|
|
|
|
|
class="form-control"
|
|
|
|
|
name="q"
|
|
|
|
|
placeholder="Search the docs ..."
|
|
|
|
|
aria-label="Search the docs ..."
|
|
|
|
|
autocomplete="off"
|
|
|
|
|
autocorrect="off"
|
|
|
|
|
autocapitalize="off"
|
|
|
|
|
spellcheck="false"/>
|
|
|
|
|
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
|
|
|
|
|
</form>
|
|
|
|
|
<div id="search-results"></div>
|
2025-05-26 08:14:43 +00:00
|
|
|
</div>
|
|
|
|
|
<script>
|
2025-06-06 17:22:10 +00:00
|
|
|
// Activate the search field on page load
|
|
|
|
|
let searchInput = document.querySelector("form.bd-search input");
|
|
|
|
|
if (searchInput) {
|
|
|
|
|
searchInput.focus();
|
|
|
|
|
searchInput.select();
|
|
|
|
|
console.log("[PST]: Set focus on search field.");
|
|
|
|
|
}
|
2025-05-26 08:14:43 +00:00
|
|
|
</script>
|
2025-06-06 17:22:10 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<footer class="prev-next-footer d-print-none">
|
|
|
|
|
|
|
|
|
|
<div class="prev-next-area">
|
|
|
|
|
</div>
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
<footer class="bd-footer-content">
|
|
|
|
|
|
|
|
|
|
</footer>
|
|
|
|
|
|
|
|
|
|
</main>
|
|
|
|
|
</div>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<!-- Scripts loaded after <body> so the DOM is not blocked -->
|
|
|
|
|
<script defer src="_static/scripts/bootstrap.js?digest=8878045cc6db502f8baf"></script>
|
|
|
|
|
<script defer src="_static/scripts/pydata-sphinx-theme.js?digest=8878045cc6db502f8baf"></script>
|
|
|
|
|
|
|
|
|
|
<footer class="bd-footer">
|
|
|
|
|
<div class="bd-footer__inner bd-page-width">
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
<div class="footer-items__start">
|
|
|
|
|
|
|
|
|
|
<div class="footer-item">
|
|
|
|
|
|
|
|
|
|
<p class="copyright">
|
|
|
|
|
|
|
|
|
|
© Copyright 2025, Nicolas Kruse.
|
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<div class="footer-item">
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
<p class="sphinx-version">
|
|
|
|
|
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
|
|
|
|
|
<br/>
|
|
|
|
|
</p>
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="footer-items__end">
|
|
|
|
|
|
|
|
|
|
<div class="footer-item">
|
|
|
|
|
<p class="theme-version">
|
|
|
|
|
<!-- # L10n: Setting the PST URL as an argument as this does not need to be localized -->
|
|
|
|
|
Built with the <a href="https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html">PyData Sphinx Theme</a> 0.16.1.
|
|
|
|
|
</p></div>
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
</div>
|
2025-05-26 08:14:43 +00:00
|
|
|
|
2025-06-06 17:22:10 +00:00
|
|
|
</footer>
|
|
|
|
|
</body>
|
2025-05-26 08:14:43 +00:00
|
|
|
</html>
|
