update docs config (separate modules and autosummary)
This commit is contained in:
parent
2335001a80
commit
2c72ce80e5
4
.gitignore
vendored
4
.gitignore
vendored
@ -8,4 +8,6 @@ localsys.egg-info/
|
||||
# vendor and build files
|
||||
dist/
|
||||
build/
|
||||
docs/sphinx/_build/
|
||||
docs/_autoref/
|
||||
docs/_autosummary/
|
||||
docs/_build/
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
'''
|
||||
Accessor
|
||||
**Accessor**
|
||||
|
||||
Provides access to an underlying schema through a supported set of operations. Class
|
||||
methods could be general, high-level SQL wrappers, or convenience functions for common
|
||||
|
||||
@ -1,34 +0,0 @@
|
||||
co4.accessors package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.accessors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.accessors.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.accessors.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.accessors.table module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: co4.accessors.table
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.accessors.vss module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.accessors.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,18 +0,0 @@
|
||||
co4.collectors package
|
||||
======================
|
||||
|
||||
.. automodule:: co4.collectors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.collectors.core module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: co4.collectors.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,26 +0,0 @@
|
||||
co4.composers package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.composers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.composers.core module
|
||||
-------------------------
|
||||
|
||||
.. automodule:: co4.composers.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.composers.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.composers.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,34 +0,0 @@
|
||||
co4.databases package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.databases
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.databases.core module
|
||||
-------------------------
|
||||
|
||||
.. automodule:: co4.databases.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.databases.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.databases.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.databases.vss module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.databases.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,34 +0,0 @@
|
||||
co4.managers package
|
||||
====================
|
||||
|
||||
.. automodule:: co4.managers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.managers.core module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.managers.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.managers.fts module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: co4.managers.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.managers.vss module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: co4.managers.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,70 +0,0 @@
|
||||
co4 package
|
||||
===========
|
||||
|
||||
.. automodule:: co4
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
co4.accessors
|
||||
co4.collectors
|
||||
co4.composers
|
||||
co4.databases
|
||||
co4.managers
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.accessor module
|
||||
-------------------
|
||||
|
||||
.. automodule:: co4.accessor
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.co4 module
|
||||
--------------
|
||||
|
||||
.. automodule:: co4.co4
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.collector module
|
||||
--------------------
|
||||
|
||||
.. automodule:: co4.collector
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.composer module
|
||||
-------------------
|
||||
|
||||
.. automodule:: co4.composer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.indexer module
|
||||
------------------
|
||||
|
||||
.. automodule:: co4.indexer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.manager module
|
||||
------------------
|
||||
|
||||
.. automodule:: co4.manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,7 +1,7 @@
|
||||
co4
|
||||
co3
|
||||
===
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
co4
|
||||
co3
|
||||
|
||||
BIN
docs/_build/doctrees/_autoref/co4.accessors.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.accessors.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/co4.collectors.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.collectors.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/co4.composers.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.composers.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/co4.databases.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.databases.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/co4.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/co4.managers.doctree
vendored
BIN
docs/_build/doctrees/_autoref/co4.managers.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/_autoref/modules.doctree
vendored
BIN
docs/_build/doctrees/_autoref/modules.doctree
vendored
Binary file not shown.
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/index.doctree
vendored
BIN
docs/_build/doctrees/index.doctree
vendored
Binary file not shown.
Binary file not shown.
Binary file not shown.
2
docs/_build/html/.buildinfo
vendored
2
docs/_build/html/.buildinfo
vendored
@ -1,4 +1,4 @@
|
||||
# Sphinx build info version 1
|
||||
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
|
||||
config: 84df2ad39c764f4e875b6546ac3281a5
|
||||
config: 42689903516d5840d143a46f4ba615c6
|
||||
tags: 645f666f9bcd5a90fca523b33c5a78b7
|
||||
|
||||
300
docs/_build/html/_autoref/co4.accessors.html
vendored
300
docs/_build/html/_autoref/co4.accessors.html
vendored
@ -1,300 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="co4.collectors package" href="co4.collectors.html" /><link rel="prev" title="co4 package" href="co4.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4.accessors package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="co4.html">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-accessors-package">
|
||||
<h1>co4.accessors package<a class="headerlink" href="#co4-accessors-package" title="Link to this heading">#</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-accessors-fts-module">
|
||||
<h2>co4.accessors.fts module<a class="headerlink" href="#co4-accessors-fts-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-accessors-table-module">
|
||||
<h2>co4.accessors.table module<a class="headerlink" href="#co4-accessors-table-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-accessors-vss-module">
|
||||
<h2>co4.accessors.vss module<a class="headerlink" href="#co4-accessors-vss-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="co4.collectors.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4.collectors package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="co4.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4 package</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4.accessors package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-accessors-fts-module">co4.accessors.fts module</a></li>
|
||||
<li><a class="reference internal" href="#co4-accessors-table-module">co4.accessors.table module</a></li>
|
||||
<li><a class="reference internal" href="#co4-accessors-vss-module">co4.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
292
docs/_build/html/_autoref/co4.collectors.html
vendored
292
docs/_build/html/_autoref/co4.collectors.html
vendored
@ -1,292 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="co4.composers package" href="co4.composers.html" /><link rel="prev" title="co4.accessors package" href="co4.accessors.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4.collectors package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="co4.html">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-collectors-package">
|
||||
<h1>co4.collectors package<a class="headerlink" href="#co4-collectors-package" title="Link to this heading">#</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-collectors-core-module">
|
||||
<h2>co4.collectors.core module<a class="headerlink" href="#co4-collectors-core-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="co4.composers.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4.composers package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="co4.accessors.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4.accessors package</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4.collectors package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-collectors-core-module">co4.collectors.core module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
296
docs/_build/html/_autoref/co4.composers.html
vendored
296
docs/_build/html/_autoref/co4.composers.html
vendored
@ -1,296 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="co4.databases package" href="co4.databases.html" /><link rel="prev" title="co4.collectors package" href="co4.collectors.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4.composers package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="co4.html">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-composers-package">
|
||||
<h1>co4.composers package<a class="headerlink" href="#co4-composers-package" title="Link to this heading">#</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-composers-core-module">
|
||||
<h2>co4.composers.core module<a class="headerlink" href="#co4-composers-core-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-composers-fts-module">
|
||||
<h2>co4.composers.fts module<a class="headerlink" href="#co4-composers-fts-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="co4.databases.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4.databases package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="co4.collectors.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4.collectors package</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4.composers package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-composers-core-module">co4.composers.core module</a></li>
|
||||
<li><a class="reference internal" href="#co4-composers-fts-module">co4.composers.fts module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
300
docs/_build/html/_autoref/co4.databases.html
vendored
300
docs/_build/html/_autoref/co4.databases.html
vendored
@ -1,300 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="co4.managers package" href="co4.managers.html" /><link rel="prev" title="co4.composers package" href="co4.composers.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4.databases package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="co4.html">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-databases-package">
|
||||
<h1>co4.databases package<a class="headerlink" href="#co4-databases-package" title="Link to this heading">#</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-databases-core-module">
|
||||
<h2>co4.databases.core module<a class="headerlink" href="#co4-databases-core-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-databases-fts-module">
|
||||
<h2>co4.databases.fts module<a class="headerlink" href="#co4-databases-fts-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-databases-vss-module">
|
||||
<h2>co4.databases.vss module<a class="headerlink" href="#co4-databases-vss-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="co4.managers.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4.managers package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="co4.composers.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4.composers package</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4.databases package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-databases-core-module">co4.databases.core module</a></li>
|
||||
<li><a class="reference internal" href="#co4-databases-fts-module">co4.databases.fts module</a></li>
|
||||
<li><a class="reference internal" href="#co4-databases-vss-module">co4.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
352
docs/_build/html/_autoref/co4.html
vendored
352
docs/_build/html/_autoref/co4.html
vendored
@ -1,352 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="co4.accessors package" href="co4.accessors.html" /><link rel="prev" title="co4 package docs" href="../index.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4 package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-package">
|
||||
<h1>co4 package<a class="headerlink" href="#co4-package" title="Link to this heading">#</a></h1>
|
||||
<section id="subpackages">
|
||||
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading">#</a></h2>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html#co4-accessors-fts-module">co4.accessors.fts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html#co4-accessors-table-module">co4.accessors.table module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html#co4-accessors-vss-module">co4.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html#co4-collectors-core-module">co4.collectors.core module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.composers.html">co4.composers package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html#co4-composers-core-module">co4.composers.core module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html#co4-composers-fts-module">co4.composers.fts module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.databases.html">co4.databases package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html#co4-databases-core-module">co4.databases.core module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html#co4-databases-fts-module">co4.databases.fts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html#co4-databases-vss-module">co4.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.managers.html">co4.managers package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html#co4-managers-core-module">co4.managers.core module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html#co4-managers-fts-module">co4.managers.fts module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html#co4-managers-vss-module">co4.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-accessor-module">
|
||||
<h2>co4.accessor module<a class="headerlink" href="#co4-accessor-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-co4-module">
|
||||
<h2>co4.co4 module<a class="headerlink" href="#co4-co4-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-collector-module">
|
||||
<h2>co4.collector module<a class="headerlink" href="#co4-collector-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-composer-module">
|
||||
<h2>co4.composer module<a class="headerlink" href="#co4-composer-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-indexer-module">
|
||||
<h2>co4.indexer module<a class="headerlink" href="#co4-indexer-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-manager-module">
|
||||
<h2>co4.manager module<a class="headerlink" href="#co4-manager-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="co4.accessors.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4.accessors package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="../index.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">Home</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4 package</a><ul>
|
||||
<li><a class="reference internal" href="#subpackages">Subpackages</a></li>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-accessor-module">co4.accessor module</a></li>
|
||||
<li><a class="reference internal" href="#co4-co4-module">co4.co4 module</a></li>
|
||||
<li><a class="reference internal" href="#co4-collector-module">co4.collector module</a></li>
|
||||
<li><a class="reference internal" href="#co4-composer-module">co4.composer module</a></li>
|
||||
<li><a class="reference internal" href="#co4-indexer-module">co4.indexer module</a></li>
|
||||
<li><a class="reference internal" href="#co4-manager-module">co4.manager module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
300
docs/_build/html/_autoref/co4.managers.html
vendored
300
docs/_build/html/_autoref/co4.managers.html
vendored
@ -1,300 +0,0 @@
|
||||
<!doctype html>
|
||||
<html class="no-js" lang="en" data-content_root="../">
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" /><link rel="next" title="Documentation" href="../reference/documentation/index.html" /><link rel="prev" title="co4.databases package" href="co4.databases.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4.managers package - co4 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
|
||||
|
||||
|
||||
<style>
|
||||
body {
|
||||
--color-code-background: #f8f8f8;
|
||||
--color-code-foreground: black;
|
||||
|
||||
}
|
||||
@media not print {
|
||||
body[data-theme="dark"] {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
@media (prefers-color-scheme: dark) {
|
||||
body:not([data-theme="light"]) {
|
||||
--color-code-background: #202020;
|
||||
--color-code-foreground: #d0d0d0;
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
</style></head>
|
||||
<body>
|
||||
|
||||
<script>
|
||||
document.body.dataset.theme = localStorage.getItem("theme") || "auto";
|
||||
</script>
|
||||
|
||||
|
||||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||||
<title>Contents</title>
|
||||
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
|
||||
<path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||||
<title>Menu</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
|
||||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||||
<title>Expand</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
|
||||
<polyline points="9 18 15 12 9 6"></polyline>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun" viewBox="0 0 24 24">
|
||||
<title>Light mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
|
||||
<circle cx="12" cy="12" r="5"></circle>
|
||||
<line x1="12" y1="1" x2="12" y2="3"></line>
|
||||
<line x1="12" y1="21" x2="12" y2="23"></line>
|
||||
<line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
|
||||
<line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
|
||||
<line x1="1" y1="12" x2="3" y2="12"></line>
|
||||
<line x1="21" y1="12" x2="23" y2="12"></line>
|
||||
<line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
|
||||
<line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-moon" viewBox="0 0 24 24">
|
||||
<title>Dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none" />
|
||||
<path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
|
||||
</svg>
|
||||
</symbol>
|
||||
<symbol id="svg-sun-half" viewBox="0 0 24 24">
|
||||
<title>Auto light/dark mode</title>
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
|
||||
stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
|
||||
<path stroke="none" d="M0 0h24v24H0z" fill="none"/>
|
||||
<circle cx="12" cy="12" r="9" />
|
||||
<path d="M13 12h5" />
|
||||
<path d="M13 15h4" />
|
||||
<path d="M13 18h1" />
|
||||
<path d="M13 9h4" />
|
||||
<path d="M13 6h1" />
|
||||
</svg>
|
||||
</symbol>
|
||||
</svg>
|
||||
|
||||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||||
<label class="overlay sidebar-overlay" for="__navigation">
|
||||
<div class="visually-hidden">Hide navigation sidebar</div>
|
||||
</label>
|
||||
<label class="overlay toc-overlay" for="__toc">
|
||||
<div class="visually-hidden">Hide table of contents sidebar</div>
|
||||
</label>
|
||||
|
||||
|
||||
|
||||
<div class="page">
|
||||
<header class="mobile-header">
|
||||
<div class="header-left">
|
||||
<label class="nav-overlay-icon" for="__navigation">
|
||||
<div class="visually-hidden">Toggle site navigation sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-header-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
</header>
|
||||
<aside class="sidebar-drawer">
|
||||
<div class="sidebar-container">
|
||||
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
<input type="hidden" name="check_keywords" value="yes">
|
||||
<input type="hidden" name="area" value="default">
|
||||
</form>
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="co4.html">co4 package</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">co4.managers package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
</div>
|
||||
</aside>
|
||||
<div class="main">
|
||||
<div class="content">
|
||||
<div class="article-container">
|
||||
<a href="#" class="back-to-top muted-link">
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
||||
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
||||
</svg>
|
||||
<span>Back to top</span>
|
||||
</a>
|
||||
<div class="content-icon-container">
|
||||
|
||||
<div class="theme-toggle-container theme-toggle-content">
|
||||
<button class="theme-toggle">
|
||||
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
||||
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
||||
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
||||
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
||||
</button>
|
||||
</div>
|
||||
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
||||
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
||||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-managers-package">
|
||||
<h1>co4.managers package<a class="headerlink" href="#co4-managers-package" title="Link to this heading">#</a></h1>
|
||||
<section id="submodules">
|
||||
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-managers-core-module">
|
||||
<h2>co4.managers.core module<a class="headerlink" href="#co4-managers-core-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-managers-fts-module">
|
||||
<h2>co4.managers.fts module<a class="headerlink" href="#co4-managers-fts-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
<section id="co4-managers-vss-module">
|
||||
<h2>co4.managers.vss module<a class="headerlink" href="#co4-managers-vss-module" title="Link to this heading">#</a></h2>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
</div>
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="../reference/documentation/index.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">Documentation</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="co4.databases.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4.databases package</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
</div>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
||||
|
||||
</div>
|
||||
<div class="right-details">
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</footer>
|
||||
</div>
|
||||
<aside class="toc-drawer">
|
||||
|
||||
|
||||
<div class="toc-sticky toc-scroll">
|
||||
<div class="toc-title-container">
|
||||
<span class="toc-title">
|
||||
On this page
|
||||
</span>
|
||||
</div>
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#">co4.managers package</a><ul>
|
||||
<li><a class="reference internal" href="#submodules">Submodules</a></li>
|
||||
<li><a class="reference internal" href="#co4-managers-core-module">co4.managers.core module</a></li>
|
||||
<li><a class="reference internal" href="#co4-managers-fts-module">co4.managers.fts module</a></li>
|
||||
<li><a class="reference internal" href="#co4-managers-vss-module">co4.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
</html>
|
||||
169
docs/_build/html/_autoref/modules.html
vendored
169
docs/_build/html/_autoref/modules.html
vendored
@ -5,8 +5,8 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../genindex.html" /><link rel="search" title="Search" href="../search.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4 - co4 documentation</title>
|
||||
<!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
|
||||
<title>co3 - co3 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../index.html"><div class="brand">co4 documentation</div></a>
|
||||
<a href="../index.html"><div class="brand">co3 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -146,7 +146,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
<span class="sidebar-brand-text">co3 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
@ -156,18 +156,52 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="co4.html">co4 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="co3.html">co3 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co3 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="co3.accessors.html">co3.accessors package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of co3.accessors package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.accessors.fts.html">co3.accessors.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.accessors.sql.html">co3.accessors.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.accessors.vss.html">co3.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="co3.databases.html">co3.databases package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of co3.databases package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.databases.fts.html">co3.databases.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.databases.sql.html">co3.databases.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.databases.vss.html">co3.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="co3.managers.html">co3.managers package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of co3.managers package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.managers.fts.html">co3.managers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.managers.sql.html">co3.managers.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.managers.vss.html">co3.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="co3.util.html">co3.util package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of co3.util package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.util.db.html">co3.util.db module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.util.regex.html">co3.util.regex module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.util.types.html">co3.util.types module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../reference/test.html">Test</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -205,53 +239,96 @@
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4">
|
||||
<h1>co4<a class="headerlink" href="#co4" title="Link to this heading">#</a></h1>
|
||||
<section id="co3">
|
||||
<h1>co3<a class="headerlink" href="#co3" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co4.html">co4 package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co4.accessors.html">co4.accessors package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.accessors.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.accessors.html#co4-accessors-fts-module">co4.accessors.fts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.accessors.html#co4-accessors-table-module">co4.accessors.table module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.accessors.html#co4-accessors-vss-module">co4.accessors.vss module</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="co3.html">co3 package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.accessors.html">co3.accessors package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.accessors.html#submodules">Submodules</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co4.collectors.html">co4.collectors package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.collectors.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.collectors.html#co4-collectors-core-module">co4.collectors.core module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.components.html">co3.components package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.ComposableComponent"><code class="docutils literal notranslate"><span class="pre">ComposableComponent</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.Dictionary"><code class="docutils literal notranslate"><span class="pre">Dictionary</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.Document"><code class="docutils literal notranslate"><span class="pre">Document</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.Node"><code class="docutils literal notranslate"><span class="pre">Node</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.Relation"><code class="docutils literal notranslate"><span class="pre">Relation</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.components.html#co3.components.SQLTable"><code class="docutils literal notranslate"><span class="pre">SQLTable</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co4.composers.html">co4.composers package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.composers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.composers.html#co4-composers-core-module">co4.composers.core module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.composers.html#co4-composers-fts-module">co4.composers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.databases.html">co3.databases package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.databases.html#submodules">Submodules</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co4.databases.html">co4.databases package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.databases.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.databases.html#co4-databases-core-module">co4.databases.core module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.databases.html#co4-databases-fts-module">co4.databases.fts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.databases.html#co4-databases-vss-module">co4.databases.vss module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.engines.html">co3.engines package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.engines.html#co3.engines.SQLEngine"><code class="docutils literal notranslate"><span class="pre">SQLEngine</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co4.managers.html">co4.managers package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.managers.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.managers.html#co4-managers-core-module">co4.managers.core module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.managers.html#co4-managers-fts-module">co4.managers.fts module</a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co4.managers.html#co4-managers-vss-module">co4.managers.vss module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.managers.html">co3.managers package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.managers.html#submodules">Submodules</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.schemas.html">co3.schemas package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.schemas.html#co3.schemas.RelationalSchema"><code class="docutils literal notranslate"><span class="pre">RelationalSchema</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.schemas.html#co3.schemas.SQLSchema"><code class="docutils literal notranslate"><span class="pre">SQLSchema</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.util.html">co3.util package</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.util.html#submodules">Submodules</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co3.html#submodules">Submodules</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.accessor.html">co3.accessor module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.accessor.html#co3.accessor.Accessor"><code class="docutils literal notranslate"><span class="pre">Accessor</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.co3.html">co3.co3 module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.co3.html#co3.co3.CO3"><code class="docutils literal notranslate"><span class="pre">CO3</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.co3.html#co3.co3.FormatRegistryMeta"><code class="docutils literal notranslate"><span class="pre">FormatRegistryMeta</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.co3.html#co3.co3.collate"><code class="docutils literal notranslate"><span class="pre">collate()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.collector.html">co3.collector module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.collector.html#co3.collector.Collector"><code class="docutils literal notranslate"><span class="pre">Collector</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.component.html">co3.component module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.component.html#co3.component.Component"><code class="docutils literal notranslate"><span class="pre">Component</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.database.html">co3.database module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.database.html#co3.database.Database"><code class="docutils literal notranslate"><span class="pre">Database</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.engine.html">co3.engine module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.engine.html#co3.engine.Engine"><code class="docutils literal notranslate"><span class="pre">Engine</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.indexer.html">co3.indexer module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.indexer.html#co3.indexer.CacheBlock"><code class="docutils literal notranslate"><span class="pre">CacheBlock</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.indexer.html#co3.indexer.Indexer"><code class="docutils literal notranslate"><span class="pre">Indexer</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.manager.html">co3.manager module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.manager.html#co3.manager.Manager"><code class="docutils literal notranslate"><span class="pre">Manager</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.mapper.html">co3.mapper module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.mapper.html#co3.mapper.ComposableMapper"><code class="docutils literal notranslate"><span class="pre">ComposableMapper</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.mapper.html#co3.mapper.Mapper"><code class="docutils literal notranslate"><span class="pre">Mapper</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="co3.schema.html">co3.schema module</a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="co3.schema.html#co3.schema.Schema"><code class="docutils literal notranslate"><span class="pre">Schema</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-accessor-module">co4.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-co4-module">co4.co4 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-collector-module">co4.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-composer-module">co4.composer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-indexer-module">co4.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="co4.html#co4-manager-module">co4.manager module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -269,7 +346,7 @@
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
Copyright © 2024, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
@ -290,7 +367,7 @@
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../_static/doctools.js?v=9a2dae69"></script>
|
||||
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
|
||||
@ -1,34 +0,0 @@
|
||||
co4.accessors package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.accessors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.accessors.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.accessors.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.accessors.table module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: co4.accessors.table
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.accessors.vss module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.accessors.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,18 +0,0 @@
|
||||
co4.collectors package
|
||||
======================
|
||||
|
||||
.. automodule:: co4.collectors
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.collectors.core module
|
||||
--------------------------
|
||||
|
||||
.. automodule:: co4.collectors.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,26 +0,0 @@
|
||||
co4.composers package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.composers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.composers.core module
|
||||
-------------------------
|
||||
|
||||
.. automodule:: co4.composers.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.composers.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.composers.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,34 +0,0 @@
|
||||
co4.databases package
|
||||
=====================
|
||||
|
||||
.. automodule:: co4.databases
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.databases.core module
|
||||
-------------------------
|
||||
|
||||
.. automodule:: co4.databases.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.databases.fts module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.databases.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.databases.vss module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.databases.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,34 +0,0 @@
|
||||
co4.managers package
|
||||
====================
|
||||
|
||||
.. automodule:: co4.managers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.managers.core module
|
||||
------------------------
|
||||
|
||||
.. automodule:: co4.managers.core
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.managers.fts module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: co4.managers.fts
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.managers.vss module
|
||||
-----------------------
|
||||
|
||||
.. automodule:: co4.managers.vss
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
70
docs/_build/html/_sources/_autoref/co4.rst.txt
vendored
70
docs/_build/html/_sources/_autoref/co4.rst.txt
vendored
@ -1,70 +0,0 @@
|
||||
co4 package
|
||||
===========
|
||||
|
||||
.. automodule:: co4
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
co4.accessors
|
||||
co4.collectors
|
||||
co4.composers
|
||||
co4.databases
|
||||
co4.managers
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
co4.accessor module
|
||||
-------------------
|
||||
|
||||
.. automodule:: co4.accessor
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.co4 module
|
||||
--------------
|
||||
|
||||
.. automodule:: co4.co4
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.collector module
|
||||
--------------------
|
||||
|
||||
.. automodule:: co4.collector
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.composer module
|
||||
-------------------
|
||||
|
||||
.. automodule:: co4.composer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.indexer module
|
||||
------------------
|
||||
|
||||
.. automodule:: co4.indexer
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
co4.manager module
|
||||
------------------
|
||||
|
||||
.. automodule:: co4.manager
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
@ -1,7 +1,7 @@
|
||||
co4
|
||||
co3
|
||||
===
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
co4
|
||||
co3
|
||||
|
||||
25
docs/_build/html/_sources/index.md.txt
vendored
25
docs/_build/html/_sources/index.md.txt
vendored
@ -1,24 +1,41 @@
|
||||
# `co4` package docs
|
||||
# `co3` package docs
|
||||
{ref}`genindex`
|
||||
{ref}`modindex`
|
||||
{ref}`search`
|
||||
|
||||
```{eval-rst}
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
|
||||
co3.Accessor
|
||||
co3.Collector
|
||||
co3.CO3
|
||||
co3.Database
|
||||
co3.Indexer
|
||||
co3.Manager
|
||||
co3.Mapper
|
||||
co3.Component
|
||||
co3.Schema
|
||||
co3.Engine
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
:caption: Autoref
|
||||
|
||||
_autoref/co4.rst
|
||||
_autoref/co3.rst
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
:caption: Contents
|
||||
|
||||
reference/test
|
||||
|
||||
reference/documentation/index
|
||||
reference/site/index
|
||||
```
|
||||
|
||||
```{include} ../../README.md
|
||||
```{include} ../README.md
|
||||
```
|
||||
|
||||
|
||||
|
||||
2
docs/_build/html/_static/basic.css
vendored
2
docs/_build/html/_static/basic.css
vendored
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx stylesheet -- basic theme.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
2
docs/_build/html/_static/doctools.js
vendored
2
docs/_build/html/_static/doctools.js
vendored
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Base JavaScript utilities for all Sphinx HTML documentation.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
|
||||
4
docs/_build/html/_static/language_data.js
vendored
4
docs/_build/html/_static/language_data.js
vendored
@ -5,7 +5,7 @@
|
||||
* This script contains the language-specific data used by searchtools.js,
|
||||
* namely the list of stopwords, stemmer, scorer and splitter.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -13,7 +13,7 @@
|
||||
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, is available */
|
||||
/* Non-minified version is copied as a separate JS file, if available */
|
||||
|
||||
/**
|
||||
* Porter Stemmer
|
||||
|
||||
155
docs/_build/html/_static/searchtools.js
vendored
155
docs/_build/html/_static/searchtools.js
vendored
@ -4,7 +4,7 @@
|
||||
*
|
||||
* Sphinx JavaScript utilities for the full-text search.
|
||||
*
|
||||
* :copyright: Copyright 2007-2023 by the Sphinx team, see AUTHORS.
|
||||
* :copyright: Copyright 2007-2024 by the Sphinx team, see AUTHORS.
|
||||
* :license: BSD, see LICENSE for details.
|
||||
*
|
||||
*/
|
||||
@ -99,7 +99,7 @@ const _displayItem = (item, searchTerms, highlightTerms) => {
|
||||
.then((data) => {
|
||||
if (data)
|
||||
listItem.appendChild(
|
||||
Search.makeSearchSummary(data, searchTerms)
|
||||
Search.makeSearchSummary(data, searchTerms, anchor)
|
||||
);
|
||||
// highlight search terms in the summary
|
||||
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
|
||||
@ -116,8 +116,8 @@ const _finishSearch = (resultCount) => {
|
||||
);
|
||||
else
|
||||
Search.status.innerText = _(
|
||||
`Search finished, found ${resultCount} page(s) matching the search query.`
|
||||
);
|
||||
"Search finished, found ${resultCount} page(s) matching the search query."
|
||||
).replace('${resultCount}', resultCount);
|
||||
};
|
||||
const _displayNextItem = (
|
||||
results,
|
||||
@ -137,6 +137,22 @@ const _displayNextItem = (
|
||||
// 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
|
||||
@ -160,13 +176,26 @@ const Search = {
|
||||
_queued_query: null,
|
||||
_pulse_status: -1,
|
||||
|
||||
htmlToText: (htmlString) => {
|
||||
htmlToText: (htmlString, anchor) => {
|
||||
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
|
||||
htmlElement.querySelectorAll(".headerlink").forEach((el) => { el.remove() });
|
||||
const docContent = htmlElement.querySelector('[role="main"]');
|
||||
if (docContent !== undefined) return docContent.textContent;
|
||||
for (const removalQuery of [".headerlinks", "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(
|
||||
"Content block not found. Sphinx search tries to obtain it via '[role=main]'. Could you check your theme or template."
|
||||
`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 "";
|
||||
},
|
||||
@ -239,16 +268,7 @@ const Search = {
|
||||
else Search.deferQuery(query);
|
||||
},
|
||||
|
||||
/**
|
||||
* execute search (requires search index to be loaded)
|
||||
*/
|
||||
query: (query) => {
|
||||
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;
|
||||
|
||||
_parseQuery: (query) => {
|
||||
// stem the search terms and add them to the correct list
|
||||
const stemmer = new Stemmer();
|
||||
const searchTerms = new Set();
|
||||
@ -284,16 +304,32 @@ const Search = {
|
||||
// console.info("required: ", [...searchTerms]);
|
||||
// console.info("excluded: ", [...excludedTerms]);
|
||||
|
||||
// array of [docname, title, anchor, descr, score, filename]
|
||||
let results = [];
|
||||
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();
|
||||
const queryLower = query.toLowerCase().trim();
|
||||
for (const [title, foundTitles] of Object.entries(allTitles)) {
|
||||
if (title.toLowerCase().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
||||
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
|
||||
for (const [file, id] of foundTitles) {
|
||||
let score = Math.round(100 * queryLower.length / title.length)
|
||||
results.push([
|
||||
normalResults.push([
|
||||
docNames[file],
|
||||
titles[file] !== title ? `${titles[file]} > ${title}` : title,
|
||||
id !== null ? "#" + id : "",
|
||||
@ -308,46 +344,47 @@ const Search = {
|
||||
// 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] of foundEntries) {
|
||||
let score = Math.round(100 * queryLower.length / entry.length)
|
||||
results.push([
|
||||
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) =>
|
||||
results.push(...Search.performObjectSearch(term, objectTerms))
|
||||
normalResults.push(...Search.performObjectSearch(term, objectTerms))
|
||||
);
|
||||
|
||||
// lookup as search terms in fulltext
|
||||
results.push(...Search.performTermsSearch(searchTerms, excludedTerms));
|
||||
normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
|
||||
|
||||
// let the scorer override scores with a custom scoring function
|
||||
if (Scorer.score) results.forEach((item) => (item[4] = Scorer.score(item)));
|
||||
|
||||
// now sort the results by score (in opposite order of appearance, since the
|
||||
// display function below uses pop() to retrieve items) and then
|
||||
// alphabetically
|
||||
results.sort((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
|
||||
if (Scorer.score) {
|
||||
normalResults.forEach((item) => (item[4] = Scorer.score(item)));
|
||||
nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
|
||||
}
|
||||
return leftScore > rightScore ? 1 : -1;
|
||||
});
|
||||
|
||||
// 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
|
||||
@ -361,7 +398,12 @@ const Search = {
|
||||
return acc;
|
||||
}, []);
|
||||
|
||||
results = results.reverse();
|
||||
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
|
||||
@ -466,15 +508,19 @@ const Search = {
|
||||
// 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) && !terms[word])
|
||||
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) && !titleTerms[word])
|
||||
arr.push({ files: titleTerms[word], score: Scorer.partialTitle });
|
||||
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;
|
||||
@ -496,9 +542,8 @@ const Search = {
|
||||
|
||||
// create the mapping
|
||||
files.forEach((file) => {
|
||||
if (fileMap.has(file) && fileMap.get(file).indexOf(word) === -1)
|
||||
fileMap.get(file).push(word);
|
||||
else fileMap.set(file, [word]);
|
||||
if (!fileMap.has(file)) fileMap.set(file, [word]);
|
||||
else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
|
||||
});
|
||||
});
|
||||
|
||||
@ -549,8 +594,8 @@ const Search = {
|
||||
* search summary for a given text. keywords is a list
|
||||
* of stemmed words.
|
||||
*/
|
||||
makeSearchSummary: (htmlText, keywords) => {
|
||||
const text = Search.htmlToText(htmlText);
|
||||
makeSearchSummary: (htmlText, keywords, anchor) => {
|
||||
const text = Search.htmlToText(htmlText, anchor);
|
||||
if (text === "") return null;
|
||||
|
||||
const textLower = text.toLowerCase();
|
||||
|
||||
987
docs/_build/html/genindex.html
vendored
987
docs/_build/html/genindex.html
vendored
File diff suppressed because it is too large
Load Diff
188
docs/_build/html/index.html
vendored
188
docs/_build/html/index.html
vendored
@ -3,10 +3,10 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="co4 package" href="_autoref/co4.html" />
|
||||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="co3 package" href="_autoref/co3.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>co4 documentation</title>
|
||||
<!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
|
||||
<title>co3 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="#"><div class="brand">co4 documentation</div></a>
|
||||
<a href="#"><div class="brand">co3 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -146,7 +146,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="#">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
<span class="sidebar-brand-text">co3 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
@ -156,18 +156,52 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="_autoref/co4.html">co4 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="_autoref/co3.html">co3 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co3 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.accessors.html">co3.accessors package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of co3.accessors package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.fts.html">co3.accessors.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.sql.html">co3.accessors.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.vss.html">co3.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.databases.html">co3.databases package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of co3.databases package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.fts.html">co3.databases.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.sql.html">co3.databases.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.vss.html">co3.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.managers.html">co3.managers package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of co3.managers package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.fts.html">co3.managers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.sql.html">co3.managers.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.vss.html">co3.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.util.html">co3.util package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of co3.util package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.db.html">co3.util.db module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.regex.html">co3.util.regex module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.types.html">co3.util.types module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/test.html">Test</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -205,30 +239,75 @@
|
||||
</label>
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="co4-package-docs">
|
||||
<h1><code class="docutils literal notranslate"><span class="pre">co4</span></code> package docs<a class="headerlink" href="#co4-package-docs" title="Link to this heading">#</a></h1>
|
||||
<section id="co3-package-docs">
|
||||
<h1><code class="docutils literal notranslate"><span class="pre">co3</span></code> package docs<a class="headerlink" href="#co3-package-docs" title="Link to this heading">¶</a></h1>
|
||||
<p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a>
|
||||
<a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a>
|
||||
<a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p>
|
||||
<div class="table-wrapper autosummary longtable docutils container">
|
||||
<table class="autosummary longtable docutils align-default">
|
||||
<tbody>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/co3.Accessor.html#co3.Accessor" title="co3.Accessor"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Accessor</span></code></a></p></td>
|
||||
<td><p>Access wrapper class for complex queries and easy integration with Composer tables.</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/co3.Collector.html#co3.Collector" title="co3.Collector"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Collector</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/co3.CO3.html#co3.CO3" title="co3.CO3"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.CO3</span></code></a></p></td>
|
||||
<td><p>CO3: COllate, COllect, COmpose - conversion & DB insertion base</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/co3.Database.html#co3.Database" title="co3.Database"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Database</span></code></a></p></td>
|
||||
<td><p>Generic Database definition</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/co3.Indexer.html#co3.Indexer" title="co3.Indexer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Indexer</span></code></a></p></td>
|
||||
<td><p>Indexer class</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/co3.Manager.html#co3.Manager" title="co3.Manager"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Manager</span></code></a></p></td>
|
||||
<td><p>Management wrapper class for table groupings.</p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/co3.Mapper.html#co3.Mapper" title="co3.Mapper"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Mapper</span></code></a></p></td>
|
||||
<td><p>Mapper base class for housing schema components and managing relationships between CO3 types and storage components (of type C).</p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/co3.Component.html#co3.Component" title="co3.Component"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Component</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-odd"><td><p><a class="reference internal" href="_autosummary/co3.Schema.html#co3.Schema" title="co3.Schema"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Schema</span></code></a></p></td>
|
||||
<td><p></p></td>
|
||||
</tr>
|
||||
<tr class="row-even"><td><p><a class="reference internal" href="_autosummary/co3.Engine.html#co3.Engine" title="co3.Engine"><code class="xref py py-obj docutils literal notranslate"><span class="pre">co3.Engine</span></code></a></p></td>
|
||||
<td><p>Engine base class.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="_autoref/co4.html">co4 package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="_autoref/co3.html">co3 package</a><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.html#subpackages">Subpackages</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.html">co3.accessors package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.html">co3.databases package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.html">co3.managers package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.html">co3.util package</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.html#submodules">Submodules</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#submodules">Submodules</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-accessor-module">co4.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-co4-module">co4.co4 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-collector-module">co4.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-composer-module">co4.composer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-indexer-module">co4.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.html#co4-manager-module">co4.manager module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
@ -236,9 +315,50 @@
|
||||
<div class="toctree-wrapper compound">
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/test.html">Test</a></li>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/documentation/index.html">Documentation</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</section>
|
||||
<section id="overview">
|
||||
<h1>Overview<a class="headerlink" href="#overview" title="Link to this heading">¶</a></h1>
|
||||
<p><code class="docutils literal notranslate"><span class="pre">co3</span></code> is a package for file conversion and associated database operations. The <code class="docutils literal notranslate"><span class="pre">CO3</span></code> base class
|
||||
provides a standard interface for performing conversions, preparing inserts, and
|
||||
interacting with database schemas that mirror the class hierarchy.</p>
|
||||
<p>Simplified description of the operational model:</p>
|
||||
<p><strong>Goal</strong>: interact with a storage medium (database, pickled structure, VSS framework) with
|
||||
a known schema.</p>
|
||||
<ul class="simple">
|
||||
<li><p><strong>Accessor</strong> to provide access to stored items</p></li>
|
||||
<li><p><strong>Composer</strong> to compose common access points (e.g., JOINed tables)</p></li>
|
||||
<li><p><strong>Indexer</strong> to index/cache access queries</p></li>
|
||||
<li><p><strong>Manager</strong> to manage storage state (e.g., supported inserts, database syncs)</p></li>
|
||||
<li><p><strong>Collector</strong> to collect data for updating storage state</p></li>
|
||||
<li><p><strong>Database</strong> to collect data for updating storage state</p></li>
|
||||
<li><p><strong>Mapper</strong> to collect data for updating storage state</p></li>
|
||||
<li><p><strong>Component</strong> to collect data for updating storage state</p></li>
|
||||
</ul>
|
||||
<p><strong>CO3</strong> is an abstract base class that makes it easy to integrate this model with object
|
||||
hierarchies that mirror a storage schema.</p>
|
||||
</section>
|
||||
<section id="detailed-structural-breakdown">
|
||||
<h1>Detailed structural breakdown<a class="headerlink" href="#detailed-structural-breakdown" title="Link to this heading">¶</a></h1>
|
||||
<p>There are a few pillars of the CO3 model that meaningfully group up functionality:</p>
|
||||
<ul class="simple">
|
||||
<li><p>Database: generic to a Component type, provides basic connection to a database at a
|
||||
specific address/location. The explicit Component type makes it easy to hook into
|
||||
appropriately typed functional objects:</p>
|
||||
<ul>
|
||||
<li><p>Manager: generic to a Component and Database type, provides a supported set of
|
||||
state-modifying operations to a constituent database</p></li>
|
||||
<li><p>Accessor: generic to a Component and Database type, provides a supported set of
|
||||
state inspection operations on a constituent database</p></li>
|
||||
<li><p>Indexer:</p></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li><p>Mapper: generic to a Component, serves as the fundamental connective component between
|
||||
types in the data representation hierarchy (CO3 subclasses) and database Components.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
</article>
|
||||
@ -246,12 +366,12 @@
|
||||
<footer>
|
||||
|
||||
<div class="related-pages">
|
||||
<a class="next-page" href="_autoref/co4.html">
|
||||
<a class="next-page" href="_autoref/co3.html">
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Next</span>
|
||||
</div>
|
||||
<div class="title">co4 package</div>
|
||||
<div class="title">co3 package</div>
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
@ -260,7 +380,7 @@
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
Copyright © 2024, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
@ -286,9 +406,11 @@
|
||||
<div class="toc-tree-container">
|
||||
<div class="toc-tree">
|
||||
<ul>
|
||||
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">co4</span></code> package docs</a><ul>
|
||||
<li><a class="reference internal" href="#"><code class="docutils literal notranslate"><span class="pre">co3</span></code> package docs</a><ul>
|
||||
</ul>
|
||||
</li>
|
||||
<li><a class="reference internal" href="#overview">Overview</a></li>
|
||||
<li><a class="reference internal" href="#detailed-structural-breakdown">Detailed structural breakdown</a></li>
|
||||
</ul>
|
||||
|
||||
</div>
|
||||
@ -299,7 +421,7 @@
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=888ff710"></script>
|
||||
<script src="_static/doctools.js?v=9a2dae69"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
|
||||
BIN
docs/_build/html/objects.inv
vendored
BIN
docs/_build/html/objects.inv
vendored
Binary file not shown.
@ -3,10 +3,10 @@
|
||||
<head><meta charset="utf-8"/>
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="Sphinx" href="sphinx.html" /><link rel="prev" title="co4.managers package" href="../../_autoref/co4.managers.html" />
|
||||
<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="next" title="Sphinx" href="sphinx.html" /><link rel="prev" title="Test" href="../test.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>Documentation - co4 documentation</title>
|
||||
<!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
|
||||
<title>Documentation - co3 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../index.html"><div class="brand">co4 documentation</div></a>
|
||||
<a href="../../index.html"><div class="brand">co3 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -146,7 +146,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
<span class="sidebar-brand-text">co3 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
@ -156,18 +156,52 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../_autoref/co4.html">co4 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../_autoref/co3.html">co3 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co3 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.accessors.html">co3.accessors package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of co3.accessors package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.fts.html">co3.accessors.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.sql.html">co3.accessors.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.vss.html">co3.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.databases.html">co3.databases package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of co3.databases package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.fts.html">co3.databases.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.sql.html">co3.databases.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.vss.html">co3.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.managers.html">co3.managers package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of co3.managers package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.fts.html">co3.managers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.sql.html">co3.managers.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.vss.html">co3.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.util.html">co3.util package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of co3.util package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.db.html">co3.util.db module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.regex.html">co3.util.regex module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.types.html">co3.util.types module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="../test.html">Test</a></li>
|
||||
<li class="toctree-l1 current has-children current-page"><a class="current reference internal" href="#">Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -206,7 +240,7 @@
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="documentation">
|
||||
<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">#</a></h1>
|
||||
<h1>Documentation<a class="headerlink" href="#documentation" title="Link to this heading">¶</a></h1>
|
||||
<div class="toctree-wrapper compound">
|
||||
</div>
|
||||
</section>
|
||||
@ -225,14 +259,14 @@
|
||||
</div>
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
</a>
|
||||
<a class="prev-page" href="../../_autoref/co4.managers.html">
|
||||
<a class="prev-page" href="../test.html">
|
||||
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
|
||||
<div class="page-info">
|
||||
<div class="context">
|
||||
<span>Previous</span>
|
||||
</div>
|
||||
|
||||
<div class="title">co4.managers package</div>
|
||||
<div class="title">Test</div>
|
||||
|
||||
</div>
|
||||
</a>
|
||||
@ -240,7 +274,7 @@
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
Copyright © 2024, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
@ -261,7 +295,7 @@
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
|
||||
@ -5,8 +5,8 @@
|
||||
<meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||||
<link rel="index" title="Index" href="../../genindex.html" /><link rel="search" title="Search" href="../../search.html" /><link rel="prev" title="Documentation" href="index.html" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
|
||||
<title>Sphinx - co4 documentation</title>
|
||||
<!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 -->
|
||||
<title>Sphinx - co3 documentation</title>
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="../../_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
@ -123,7 +123,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="../../index.html"><div class="brand">co4 documentation</div></a>
|
||||
<a href="../../index.html"><div class="brand">co3 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -146,7 +146,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="../../index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
<span class="sidebar-brand-text">co3 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="../../search.html" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
@ -156,18 +156,52 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../_autoref/co4.html">co4 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="../../_autoref/co3.html">co3 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co3 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.accessors.html">co3.accessors package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of co3.accessors package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.fts.html">co3.accessors.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.sql.html">co3.accessors.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.accessors.vss.html">co3.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.databases.html">co3.databases package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of co3.databases package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.fts.html">co3.databases.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.sql.html">co3.databases.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.databases.vss.html">co3.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.managers.html">co3.managers package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of co3.managers package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.fts.html">co3.managers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.sql.html">co3.managers.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.managers.vss.html">co3.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="../../_autoref/co3.util.html">co3.util package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of co3.util package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.db.html">co3.util.db module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.regex.html">co3.util.regex module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="../../_autoref/co3.util.types.html">co3.util.types module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="../../_autoref/co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul class="current">
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l1"><a class="reference internal" href="../test.html">Test</a></li>
|
||||
<li class="toctree-l1 current has-children"><a class="reference internal" href="index.html">Documentation</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
|
||||
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -206,7 +240,7 @@
|
||||
</div>
|
||||
<article role="main">
|
||||
<section id="sphinx">
|
||||
<h1>Sphinx<a class="headerlink" href="#sphinx" title="Link to this heading">#</a></h1>
|
||||
<h1>Sphinx<a class="headerlink" href="#sphinx" title="Link to this heading">¶</a></h1>
|
||||
<p>The primary driver of this package’s documentation is Sphinx’s <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> extension,
|
||||
using the <a class="reference external" href="https://pradyunsg.me/furo/">Furo theme</a>.</p>
|
||||
<p><strong>High-level details</strong>:</p>
|
||||
@ -217,7 +251,7 @@ with navigation available under “Autoref” in the sidebar.</p></li>
|
||||
directory, showing up under “Contents” in the sidebar.</p></li>
|
||||
</ul>
|
||||
<section id="detailed-directory-structure">
|
||||
<h2>Detailed directory structure<a class="headerlink" href="#detailed-directory-structure" title="Link to this heading">#</a></h2>
|
||||
<h2>Detailed directory structure<a class="headerlink" href="#detailed-directory-structure" title="Link to this heading">¶</a></h2>
|
||||
<p>All files are placed under <code class="docutils literal notranslate"><span class="pre">docs/sphinx</span></code>:</p>
|
||||
<ul class="simple">
|
||||
<li><p><code class="docutils literal notranslate"><span class="pre">_</span></code>-prefixed are Sphinx-managed directories</p>
|
||||
@ -248,7 +282,7 @@ sub-topic-2.rst
|
||||
top-level header. See [Markdown syntax][#markdown-syntax] for more details on the syntax.</p>
|
||||
</section>
|
||||
<section id="sphinx-autodoc">
|
||||
<h2>Sphinx autodoc<a class="headerlink" href="#sphinx-autodoc" title="Link to this heading">#</a></h2>
|
||||
<h2>Sphinx autodoc<a class="headerlink" href="#sphinx-autodoc" title="Link to this heading">¶</a></h2>
|
||||
<p>Sphinx’s <code class="docutils literal notranslate"><span class="pre">autodoc</span></code> extension allows automatic generation of documents according to
|
||||
(Python) subpackage structure and available docstrings. A few notes here:</p>
|
||||
<ul>
|
||||
@ -274,7 +308,7 @@ of subpackages if this flag isn’t provided.</p></li>
|
||||
</ul>
|
||||
</section>
|
||||
<section id="markdown-syntax">
|
||||
<h2>Markdown syntax<a class="headerlink" href="#markdown-syntax" title="Link to this heading">#</a></h2>
|
||||
<h2>Markdown syntax<a class="headerlink" href="#markdown-syntax" title="Link to this heading">¶</a></h2>
|
||||
<p>The <code class="docutils literal notranslate"><span class="pre">myst_parser</span></code> extension enables Markdown (or something close to it) to be used when
|
||||
writing documentation files. The Sphinx directives can be difficult to track, and
|
||||
they change slightly under the MyST Markdown syntax. The following are a few common
|
||||
@ -335,7 +369,7 @@ pages:</p>
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
Copyright © 2024, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
@ -377,7 +411,7 @@ pages:</p>
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="../../_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="../../_static/doctools.js?v=888ff710"></script>
|
||||
<script src="../../_static/doctools.js?v=9a2dae69"></script>
|
||||
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="../../_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
</body>
|
||||
|
||||
58
docs/_build/html/search.html
vendored
58
docs/_build/html/search.html
vendored
@ -4,7 +4,7 @@
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1"/>
|
||||
<meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="#" />
|
||||
|
||||
<!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 --><title>Search - co4 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
|
||||
<!-- Generated with Sphinx 7.3.7 and Furo 2024.01.29 --><title>Search - co3 documentation</title><link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a746c00c" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo.css?v=135e06be" />
|
||||
<link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?v=36a5483c" />
|
||||
|
||||
@ -120,7 +120,7 @@
|
||||
</label>
|
||||
</div>
|
||||
<div class="header-center">
|
||||
<a href="index.html"><div class="brand">co4 documentation</div></a>
|
||||
<a href="index.html"><div class="brand">co3 documentation</div></a>
|
||||
</div>
|
||||
<div class="header-right">
|
||||
<div class="theme-toggle-container theme-toggle-header">
|
||||
@ -143,7 +143,7 @@
|
||||
<div class="sidebar-sticky"><a class="sidebar-brand" href="index.html">
|
||||
|
||||
|
||||
<span class="sidebar-brand-text">co4 documentation</span>
|
||||
<span class="sidebar-brand-text">co3 documentation</span>
|
||||
|
||||
</a><form class="sidebar-search-container" method="get" action="#" role="search">
|
||||
<input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
|
||||
@ -153,18 +153,52 @@
|
||||
<div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
|
||||
<p class="caption" role="heading"><span class="caption-text">Autoref</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="_autoref/co4.html">co4 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co4 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.accessors.html">co4.accessors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.collectors.html">co4.collectors package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.composers.html">co4.composers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.databases.html">co4.databases package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co4.managers.html">co4.managers package</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="_autoref/co3.html">co3 package</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of co3 package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.accessors.html">co3.accessors package</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of co3.accessors package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.fts.html">co3.accessors.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.sql.html">co3.accessors.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.accessors.vss.html">co3.accessors.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.components.html">co3.components package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.databases.html">co3.databases package</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of co3.databases package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.fts.html">co3.databases.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.sql.html">co3.databases.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.databases.vss.html">co3.databases.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.engines.html">co3.engines package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.managers.html">co3.managers package</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of co3.managers package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.fts.html">co3.managers.fts module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.sql.html">co3.managers.sql module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.managers.vss.html">co3.managers.vss module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.mappers.html">co3.mappers package</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.schemas.html">co3.schemas package</a></li>
|
||||
<li class="toctree-l2 has-children"><a class="reference internal" href="_autoref/co3.util.html">co3.util package</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of co3.util package</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.db.html">co3.util.db module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.regex.html">co3.util.regex module</a></li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="_autoref/co3.util.types.html">co3.util.types module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.accessor.html">co3.accessor module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.co3.html">co3.co3 module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.collector.html">co3.collector module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.component.html">co3.component module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.database.html">co3.database module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.engine.html">co3.engine module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.indexer.html">co3.indexer module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.manager.html">co3.manager module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.mapper.html">co3.mapper module</a></li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="_autoref/co3.schema.html">co3.schema module</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
</ul>
|
||||
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
|
||||
<ul>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l1"><a class="reference internal" href="reference/test.html">Test</a></li>
|
||||
<li class="toctree-l1 has-children"><a class="reference internal" href="reference/documentation/index.html">Documentation</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Documentation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
|
||||
<li class="toctree-l2"><a class="reference internal" href="reference/documentation/sphinx.html">Sphinx</a></li>
|
||||
</ul>
|
||||
</li>
|
||||
@ -224,7 +258,7 @@
|
||||
<div class="bottom-of-page">
|
||||
<div class="left-details">
|
||||
<div class="copyright">
|
||||
Copyright © 2023, Sam Griesemer
|
||||
Copyright © 2024, Sam Griesemer
|
||||
</div>
|
||||
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||||
|
||||
@ -245,7 +279,7 @@
|
||||
</aside>
|
||||
</div>
|
||||
</div><script src="_static/documentation_options.js?v=5929fcd5"></script>
|
||||
<script src="_static/doctools.js?v=888ff710"></script>
|
||||
<script src="_static/doctools.js?v=9a2dae69"></script>
|
||||
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
||||
<script src="_static/scripts/furo.js?v=32e29ea5"></script>
|
||||
|
||||
|
||||
2
docs/_build/html/searchindex.js
vendored
2
docs/_build/html/searchindex.js
vendored
File diff suppressed because one or more lines are too long
9
docs/_templates/autosummary.md
vendored
Normal file
9
docs/_templates/autosummary.md
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
# {{ fullname | escape }}
|
||||
|
||||
```{automodule}
|
||||
{{ fullname }}
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:imported-members:
|
||||
```
|
||||
8
docs/_templates/autosummary/module.rst
vendored
Normal file
8
docs/_templates/autosummary/module.rst
vendored
Normal file
@ -0,0 +1,8 @@
|
||||
{{ fullname | escape | underline}}
|
||||
|
||||
.. automodule:: {{ fullname }}
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:imported-members:
|
||||
|
||||
@ -6,8 +6,8 @@
|
||||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
project = 'co4'
|
||||
copyright = '2023, Sam Griesemer'
|
||||
project = 'co3'
|
||||
copyright = '2024, Sam Griesemer'
|
||||
author = 'Sam Griesemer'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
@ -15,9 +15,12 @@ author = 'Sam Griesemer'
|
||||
|
||||
extensions = [
|
||||
"sphinx.ext.autodoc",
|
||||
"sphinx.ext.autosummary",
|
||||
"sphinx.ext.viewcode",
|
||||
"myst_parser",
|
||||
]
|
||||
autosummary_generate = True
|
||||
autosummary_imported_members = True
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
@ -1,13 +1,29 @@
|
||||
# `co4` package docs
|
||||
# `co3` package docs
|
||||
{ref}`genindex`
|
||||
{ref}`modindex`
|
||||
{ref}`search`
|
||||
|
||||
```{eval-rst}
|
||||
.. autosummary::
|
||||
:nosignatures:
|
||||
|
||||
co3.Accessor
|
||||
co3.Collector
|
||||
co3.CO3
|
||||
co3.Database
|
||||
co3.Indexer
|
||||
co3.Manager
|
||||
co3.Mapper
|
||||
co3.Component
|
||||
co3.Schema
|
||||
co3.Engine
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 3
|
||||
:caption: Autoref
|
||||
|
||||
_autoref/co4.rst
|
||||
_autoref/co3.rst
|
||||
```
|
||||
|
||||
```{toctree}
|
||||
@ -18,7 +34,6 @@ reference/documentation/index
|
||||
reference/site/index
|
||||
```
|
||||
|
||||
```{include} ../../README.md
|
||||
```{include} ../README.md
|
||||
```
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user