Skip to content

Update documentation to add missing references to the new database config option #289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sepsol wants to merge 4 commits into
base: typescript
Choose a base branch
from
Open

Update documentation to add missing references to the new database config option #289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f1f61dd
Updated the `sql-lint -h` output to include newer options
sepsol Jun 3, 2025
79f4fca
Added the one-liner description of the `--database` command line option
sepsol Jun 3, 2025
4e12a23
Added a note from `configuration.md` to `introduction.md` about the d…
sepsol Jun 3, 2025
264da60
Built the html pages to include the latest updates form the markdown …
sepsol Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added ...ild/doctrees/.venv/lib/python3.12/site-packages/alabaster-1.0.0.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added docs/_build/doctrees/.venv/lib/python3.12/site-packages/idna-3.10.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...ild/doctrees/.venv/lib/python3.12/site-packages/imagesize-1.4.1.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...v/lib/python3.12/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...ctrees/.venv/lib/python3.12/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...nv/lib/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/base.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...v/lib/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/class.doctree
View file
Open in desktop
Binary file not shown.
Binary file added .../lib/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/module.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...d/doctrees/.venv/lib64/python3.12/site-packages/alabaster-1.0.0.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added .../_build/doctrees/.venv/lib64/python3.12/site-packages/idna-3.10.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...d/doctrees/.venv/lib64/python3.12/site-packages/imagesize-1.4.1.dist-info/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...lib64/python3.12/site-packages/roman_numerals_py-3.1.0.dist-info/licenses/LICENCE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...rees/.venv/lib64/python3.12/site-packages/sphinx-8.2.3.dist-info/licenses/LICENSE.doctree
View file
Open in desktop
Binary file not shown.
Binary file added .../lib64/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/base.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...lib64/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/class.doctree
View file
Open in desktop
Binary file not shown.
Binary file added ...ib64/python3.12/site-packages/sphinx/ext/autosummary/templates/autosummary/module.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/checks.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/configuration.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/development.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/installation.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/introduction.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/files/troubleshooting.doctree
View file
Open in desktop
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
4 changes: 2 additions & 2 deletions docs/_build/html/.buildinfo
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: ae2bda56fd4fd969466967466009a4c8
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f72423dbf8a4c6c97474fc08f06fadf0
tags: 645f666f9bcd5a90fca523b33c5a78b7
4 changes: 4 additions & 0 deletions docs/_build/html/.buildinfo.bak
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +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: ae2bda56fd4fd969466967466009a4c8
tags: 645f666f9bcd5a90fca523b33c5a78b7
135 changes: 135 additions & 0 deletions docs/_build/html/.venv/lib/python3.12/site-packages/alabaster-1.0.0.dist-info/LICENSE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,135 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../../../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &mdash; sql-lint 0.0.11 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../../_static/css/theme.css?v=e59714d7" />


<script src="../../../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../../../_static/documentation_options.js?v=0c446633"></script>
<script src="../../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../../../../index.html" class="icon icon-home">
sql-lint
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/checks.html">Checks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/development.html">Development</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../../index.html">sql-lint</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/.venv/lib/python3.12/site-packages/alabaster-1.0.0.dist-info/LICENSE.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<p>Copyright (c) 2020 Jeff Forcier.</p>
<p>Based on original work copyright (c) 2011 Kenneth Reitz and copyright (c) 2010
Armin Ronacher.</p>
<p>Some rights reserved.</p>
<p>Redistribution and use in source and binary forms of the theme, with or
without modification, are permitted provided that the following conditions
are met:</p>
<ul class="simple">
<li><p>Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.</p></li>
<li><p>Redistributions in binary form must reproduce the above
copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided
with the distribution.</p></li>
<li><p>The names of the contributors may not be used to endorse or
promote products derived from this software without specific
prior written permission.</p></li>
</ul>
<p>THIS THEME IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS &quot;AS IS&quot;
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS THEME, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.</p>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2020, Joe Reynolds.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
133 changes: 133 additions & 0 deletions docs/_build/html/.venv/lib/python3.12/site-packages/idna-3.10.dist-info/LICENSE.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@


<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../../../../">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>&lt;no title&gt; &mdash; sql-lint 0.0.11 documentation</title>
<link rel="stylesheet" type="text/css" href="../../../../../_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="../../../../../_static/css/theme.css?v=e59714d7" />


<script src="../../../../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../../../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../../../../_static/documentation_options.js?v=0c446633"></script>
<script src="../../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../../../../genindex.html" />
<link rel="search" title="Search" href="../../../../../search.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../../../../../index.html" class="icon icon-home">
sql-lint
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../../../../search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/introduction.html">Introduction</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/installation.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/configuration.html">Configuration</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/checks.html">Checks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/troubleshooting.html">Troubleshooting</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../../../files/development.html">Development</a></li>
</ul>

</div>
</div>
</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../../../../../index.html">sql-lint</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../../../../../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">&lt;no title&gt;</li>
<li class="wy-breadcrumbs-aside">
<a href="../../../../../_sources/.venv/lib/python3.12/site-packages/idna-3.10.dist-info/LICENSE.md.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<p>BSD 3-Clause License</p>
<p>Copyright (c) 2013-2024, Kim Davies and contributors.
All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:</p>
<ol class="simple">
<li><p>Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.</p></li>
<li><p>Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.</p></li>
<li><p>Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.</p></li>
</ol>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
&quot;AS IS&quot; AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</p>


</div>
</div>
<footer>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2020, Joe Reynolds.</p>
</div>

Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.


</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Loading