mirror of
https://github.com/simonw/sqlite-utils.git
synced 2026-09-27 04:14:30 +02:00
Switch docs theme to Furo, refs #435
This commit is contained in:
parent
841ad44bac
commit
397183debd
8 changed files with 15 additions and 31 deletions
|
|
@ -1,13 +1,3 @@
|
||||||
{%- extends "!layout.html" %}
|
|
||||||
|
|
||||||
{% block htmltitle %}
|
|
||||||
{{ super() }}
|
|
||||||
<script defer data-domain="sqlite-utils.datasette.io" src="https://plausible.io/js/plausible.js"></script>
|
|
||||||
{% endblock %}
|
|
||||||
|
|
||||||
{% block footer %}
|
|
||||||
{{ super() }}
|
|
||||||
<script>
|
|
||||||
jQuery(function ($) {
|
jQuery(function ($) {
|
||||||
// Show banner linking to /stable/ if this is a /latest/ page
|
// Show banner linking to /stable/ if this is a /latest/ page
|
||||||
if (!/\/latest\//.test(location.pathname)) {
|
if (!/\/latest\//.test(location.pathname)) {
|
||||||
|
|
@ -27,13 +17,7 @@ jQuery(function ($) {
|
||||||
</div>`
|
</div>`
|
||||||
);
|
);
|
||||||
warning.find("a").attr("href", stableUrl);
|
warning.find("a").attr("href", stableUrl);
|
||||||
var body = $("div.body");
|
$("article[role=main]").prepend(warning);
|
||||||
if (!body.length) {
|
|
||||||
body = $("div.document");
|
|
||||||
}
|
|
||||||
body.prepend(warning);
|
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
</script>
|
|
||||||
{% endblock %}
|
|
||||||
6
docs/_templates/base.html
vendored
Normal file
6
docs/_templates/base.html
vendored
Normal file
|
|
@ -0,0 +1,6 @@
|
||||||
|
{%- extends "!base.html" %}
|
||||||
|
|
||||||
|
{% block site_meta %}
|
||||||
|
{{ super() }}
|
||||||
|
<script defer data-domain="sqlite-utils.datasette.io" src="https://plausible.io/js/plausible.js"></script>
|
||||||
|
{% endblock %}
|
||||||
|
|
@ -7,6 +7,7 @@
|
||||||
This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
|
This page lists the ``--help`` for every ``sqlite-utils`` CLI sub-command.
|
||||||
|
|
||||||
.. contents:: :local:
|
.. contents:: :local:
|
||||||
|
:class: this-will-duplicate-information-and-it-is-still-useful-here
|
||||||
|
|
||||||
.. [[[cog
|
.. [[[cog
|
||||||
from sqlite_utils import cli
|
from sqlite_utils import cli
|
||||||
|
|
|
||||||
|
|
@ -9,6 +9,7 @@ The ``sqlite-utils`` command-line tool can be used to manipulate SQLite database
|
||||||
Once installed, the tool should be available as ``sqlite-utils``. It can also be run using ``python -m sqlite_utils``.
|
Once installed, the tool should be available as ``sqlite-utils``. It can also be run using ``python -m sqlite_utils``.
|
||||||
|
|
||||||
.. contents:: :local:
|
.. contents:: :local:
|
||||||
|
:class: this-will-duplicate-information-and-it-is-still-useful-here
|
||||||
|
|
||||||
.. _cli_query:
|
.. _cli_query:
|
||||||
|
|
||||||
|
|
|
||||||
16
docs/conf.py
16
docs/conf.py
|
|
@ -94,7 +94,8 @@ todo_include_todos = False
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
#
|
#
|
||||||
html_theme = "sphinx_rtd_theme"
|
html_theme = "furo"
|
||||||
|
html_title = "sqlite-utils"
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
|
|
@ -107,18 +108,7 @@ html_theme = "sphinx_rtd_theme"
|
||||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||||
html_static_path = ["_static"]
|
html_static_path = ["_static"]
|
||||||
|
|
||||||
# Custom sidebar templates, must be a dictionary that maps document names
|
html_js_files = ["js/custom.js"]
|
||||||
# to template names.
|
|
||||||
#
|
|
||||||
# This is required for the alabaster theme
|
|
||||||
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
|
|
||||||
html_sidebars = {
|
|
||||||
"**": [
|
|
||||||
"relations.html", # needs 'show_related': True theme option to display
|
|
||||||
"searchbox.html",
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
# -- Options for HTMLHelp output ------------------------------------------
|
# -- Options for HTMLHelp output ------------------------------------------
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@
|
||||||
=============================
|
=============================
|
||||||
|
|
||||||
.. contents:: :local:
|
.. contents:: :local:
|
||||||
|
:class: this-will-duplicate-information-and-it-is-still-useful-here
|
||||||
|
|
||||||
.. _python_api_getting_started:
|
.. _python_api_getting_started:
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -5,6 +5,7 @@
|
||||||
===============
|
===============
|
||||||
|
|
||||||
.. contents:: :local:
|
.. contents:: :local:
|
||||||
|
:class: this-will-duplicate-information-and-it-is-still-useful-here
|
||||||
|
|
||||||
.. _reference_db_database:
|
.. _reference_db_database:
|
||||||
|
|
||||||
|
|
|
||||||
2
setup.py
2
setup.py
|
|
@ -32,7 +32,7 @@ setup(
|
||||||
],
|
],
|
||||||
extras_require={
|
extras_require={
|
||||||
"test": ["pytest", "black", "hypothesis", "cogapp"],
|
"test": ["pytest", "black", "hypothesis", "cogapp"],
|
||||||
"docs": ["sphinx_rtd_theme", "sphinx-autobuild", "codespell"],
|
"docs": ["furo", "sphinx-autobuild", "codespell"],
|
||||||
"mypy": [
|
"mypy": [
|
||||||
"mypy",
|
"mypy",
|
||||||
"types-click",
|
"types-click",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue