olog/co3
1
0
Fork 0
Code Issues 3 Pull Requests Packages Projects Releases Wiki Activity

update docs config (separate modules and autosummary)

Browse Source
This commit is contained in:
Sam G.
2024-04-19 03:55:59 -07:00
parent 2335001a80
commit 2c72ce80e5
51 changed files with 1580 additions and 2491 deletions
Download Patch File Download Diff File Expand all files Collapse all files

68
docs/_build/html/reference/documentation/sphinx.html vendored
View File

@@ -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 &#169; 2023, Sam Griesemer
Copyright &#169; 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>