summaryrefslogtreecommitdiffstats
path: root/doc/_themes/sphinx13
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--doc/_themes/sphinx13/layout.html89
-rw-r--r--doc/_themes/sphinx13/static/sphinx13.css345
2 files changed, 402 insertions, 32 deletions
diff --git a/doc/_themes/sphinx13/layout.html b/doc/_themes/sphinx13/layout.html
index aae163a..a260da9 100644
--- a/doc/_themes/sphinx13/layout.html
+++ b/doc/_themes/sphinx13/layout.html
@@ -9,16 +9,24 @@
{% endblock %}
{% block header %}
+{{ svgs() }}
<div class="pageheader">
- <a href="{{ pathto(root_doc)|e }}">
- <img src="{{ pathto('_static/sphinx-logo.svg', resource=True) }}" alt="logo" />
- </a>
- <h1>Sphinx</h1>
+ <div class="brand">
+ <a href="{{ pathto(root_doc)|e }}">
+ <img src="{{ pathto('_static/sphinx-logo.svg', resource=True) }}" alt="logo" />
+ </a>
+ <h1>Sphinx</h1>
+ </div>
+ <div class="icons">
+ <a href="https://github.com/sphinx-doc/sphinx" title="{{ _('Source Code') }}" target="_blank">
+ <svg><use href="#github"></use></svg>
+ </a>
+ </div>
</div>
{% endblock %}
{%- block relbar1 %}
-<div class="related" role="navigation" aria-label="related navigation">
+<div class="related" role="navigation" aria-label="Related">
<h3>{{ _('Navigation') }}</h3>
<ul>
<li><a href="{{ pathto(root_doc)|e }}">Documentation</a> &raquo;</li>
@@ -32,20 +40,22 @@
{%- block content %}
<div class="document">
- <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
+ <div class="sphinxsidebar" role="navigation" aria-label="Main">
{%- include "searchfield.html" %}
- <div class="sphinxsidebar-navigation__contents">
- <h3>{{ _('On this page') }}</h3>
- {{ toc }}
- </div>
+ {%- if display_toc %}
+ <div class="sphinxsidebar-navigation__contents">
+ <h3>{{ _('On this page') }}</h3>
+ {{ toc }}
+ </div>
+ {%- endif %}
<div class="sphinxsidebar-navigation__pages">
- <h3>{{ _('Site navigation') }}</h3>
{{ toctree(includehidden=True, maxdepth=3, titles_only=True) }}
</div>
</div>
{%- block document %}
<div class="body" role="main">
{% block body %}{% endblock %}
+ {{ prev_next() }}
</div>
{%- endblock %}
</div>
@@ -59,3 +69,60 @@
{% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
</div>
{%- endblock %}
+
+{% macro prev_next() %}
+ <div class="related-pages" role="navigation" aria-label="Related">
+ {% if prev -%}
+ <a class="prev-page" href="{{ prev.link }}">
+ <svg><use href="#svg-arrow-right"></use></svg>
+ <div class="page-info">
+ <div class="context">
+ <span>{{ _("Previous") }}</span>
+ </div>
+ {% if prev.link == pathto(root_doc) %}
+ <div class="title">{{ _("Home") }}</div>
+ {% else %}
+ <div class="title">{{ prev.title }}</div>
+ {% endif %}
+ </div>
+ </a>
+ {%- else %}
+ <div></div>
+ {%- endif %}
+ {% if next -%}
+ <a class="next-page" href="{{ next.link }}">
+ <div class="page-info">
+ <div class="context">
+ <span>{{ _("Next") }}</span>
+ </div>
+ <div class="title">{{ next.title }}</div>
+ </div>
+ <svg><use href="#svg-arrow-right"></use></svg>
+ </a>
+ {%- endif %}
+ </div>
+{% endmacro %}
+
+{% macro svgs() %}
+<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
+ <symbol id="github" viewBox="0 0 16 16">
+ <title>GitHub</title>
+ <svg
+ stroke="currentColor"
+ fill="currentColor"
+ stroke-width="0"
+ viewBox="0 0 16 16"
+ >
+ <path
+ fill-rule="evenodd"
+ d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"
+ ></path>
+ </svg>
+ <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>
+</svg>
+{% endmacro %}
diff --git a/doc/_themes/sphinx13/static/sphinx13.css b/doc/_themes/sphinx13/static/sphinx13.css
index 3234a37..b0d0322 100644
--- a/doc/_themes/sphinx13/static/sphinx13.css
+++ b/doc/_themes/sphinx13/static/sphinx13.css
@@ -6,38 +6,89 @@
--colour-sphinx-blue: #0A507A;
--colour-text: #333;
--colour-links-light: #057;
+ --admonition-radius: 3px;
+
+ /* colours for admonition titles */
+ --color-admonition-bg: hsl(0, 0%, 90%);
+ --color-admonition-fg: hsl(0, 0%, 50%);
+ --colour-warning-bg: hsl(28.5, 74%, 90%);
+ --colour-warning-fg: hsl(28.5, 74%, 50%);
+ --colour-note-bg: hsl(219.5, 84%, 90%);
+ --colour-note-fg: hsl(219.5, 84%, 50%);
+ --colour-success-bg: hsl(150, 36.7%, 90%);
+ --colour-success-fg: hsl(150, 36.7%, 50%);
+ --colour-error-bg: hsl(0, 37%, 90%);
+ --colour-error-fg: hsl(0, 37%, 50%);
+ --colour-todo-bg: hsl(266.8, 100%, 90%);
+ --colour-todo-fg: hsl(266.8, 100%, 50%);
+
+ /* icons used for admonition titles */
+ --icon-pencil: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg>');
+ --icon-abstract: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 5h16v2H4V5m0 4h16v2H4V9m0 4h16v2H4v-2m0 4h10v2H4v-2z"/></svg>');
+ --icon-info: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 9h-2V7h2m0 10h-2v-6h2m-1-9A10 10 0 002 12a10 10 0 0010 10 10 10 0 0010-10A10 10 0 0012 2z"/></svg>');
+ --icon-flame: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17.55 11.2c-.23-.3-.5-.56-.76-.82-.65-.6-1.4-1.03-2.03-1.66C13.3 7.26 13 4.85 13.91 3c-.91.23-1.75.75-2.45 1.32-2.54 2.08-3.54 5.75-2.34 8.9.04.1.08.2.08.33 0 .22-.15.42-.35.5-.22.1-.46.04-.64-.12a.83.83 0 01-.15-.17c-1.1-1.43-1.28-3.48-.53-5.12C5.89 10 5 12.3 5.14 14.47c.04.5.1 1 .27 1.5.14.6.4 1.2.72 1.73 1.04 1.73 2.87 2.97 4.84 3.22 2.1.27 4.35-.12 5.96-1.6 1.8-1.66 2.45-4.32 1.5-6.6l-.13-.26c-.2-.46-.47-.87-.8-1.25l.05-.01m-3.1 6.3c-.28.24-.73.5-1.08.6-1.1.4-2.2-.16-2.87-.82 1.19-.28 1.89-1.16 2.09-2.05.17-.8-.14-1.46-.27-2.23-.12-.74-.1-1.37.18-2.06.17.38.37.76.6 1.06.76 1 1.95 1.44 2.2 2.8.04.14.06.28.06.43.03.82-.32 1.72-.92 2.27h.01z"/></svg>');
+ --icon-question: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.07 11.25l-.9.92C13.45 12.89 13 13.5 13 15h-2v-.5c0-1.11.45-2.11 1.17-2.83l1.24-1.26c.37-.36.59-.86.59-1.41a2 2 0 00-2-2 2 2 0 00-2 2H8a4 4 0 014-4 4 4 0 014 4 3.2 3.2 0 01-.93 2.25M13 19h-2v-2h2M12 2A10 10 0 002 12a10 10 0 0010 10 10 10 0 0010-10c0-5.53-4.5-10-10-10z"/></svg>');
+ --icon-warning: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 14h-2v-4h2m0 8h-2v-2h2M1 21h22L12 2 1 21z"/></svg>');
+ --icon-failure: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2c5.53 0 10 4.47 10 10s-4.47 10-10 10S2 17.53 2 12 6.47 2 12 2m3.59 5L12 10.59 8.41 7 7 8.41 10.59 12 7 15.59 8.41 17 12 13.41 15.59 17 17 15.59 13.41 12 17 8.41 15.59 7z"/></svg>');
+ --icon-spark: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M11.5 20l4.86-9.73H13V4l-5 9.73h3.5V20M12 2c2.75 0 5.1 1 7.05 2.95C21 6.9 22 9.25 22 12s-1 5.1-2.95 7.05C17.1 21 14.75 22 12 22s-5.1-1-7.05-2.95C3 17.1 2 14.75 2 12s1-5.1 2.95-7.05C6.9 3 9.25 2 12 2z"/></svg>');
}
body {
font-family: var(--fonts-sans-serif);
margin: 0 auto;
- color: var(--colour-text);
+ color: var(var(--colour-text));
}
.pageheader {
+ position: sticky;
+ top: 0;
+ z-index: 99;
+ height: 3rem;
display: flex;
column-gap: 1em;
align-items: center;
+ justify-content: space-between;
width: 100%;
background-color: var(--colour-sphinx-blue);
padding: 10px 20px;
+ box-sizing: border-box;
+}
+
+.pageheader .brand {
+ display: flex;
+ align-items: baseline;
+ column-gap: 1em;
+ color: white;
+ text-decoration: none;
}
-.pageheader a {
- width: 5%;
+.pageheader .brand a {
+ width: 2em;
}
-.pageheader img {
+.pageheader .brand img {
filter: invert(1) drop-shadow(1px 1px 2px black);
}
-.pageheader h1{
+.pageheader .brand h1 {
color: white;
margin: 0;
- font-weight: 600;
- font-size: 3.5rem;
+ font-weight: 400;
+ font-size: 2em;
line-height: 1;
- font-variant: small-caps;
+}
+
+.pageheader .icons a {
+ color: white;
+}
+
+.pageheader .icons a:hover {
+ color: rgba(255, 255, 255, 0.8);
+}
+
+.pageheader .icons svg {
+ height: 1.6em;
+ width: 1.6em;
}
div.document {
@@ -54,6 +105,9 @@ div.body {
}
div.related {
+ position: sticky;
+ top: 3rem;
+ z-index: 99;
display: flex;
color: white;
background-color: var(--colour-sphinx-blue);
@@ -81,20 +135,31 @@ div.sphinxsidebarwrapper {
div.sphinxsidebar {
position: sticky;
- top: 0;
+ top: 4.6rem;
align-self: flex-start;
- height: 100vh;
+ height: calc(100vh - 4.6rem);
width: 250px;
+ min-width: 150px;
overflow-y: auto;
overflow-wrap: break-word;
margin: 0;
- padding-right: 15px;
- padding-top: 0.5em;
+ padding: 0.5em 15px 0.5em 10px;
font-size: 1em;
}
+/* horizontal line between sidebar components */
+div.sphinxsidebar div:not(:first-child) {
+ border-top: 1px solid var(--colour-sphinx-blue);
+}
+
+/* overwrite color from basic theme */
+div.sphinxsidebar input {
+ border: 1px solid var(--colour-sphinx-blue);
+}
+
div.sphinxsidebar h3 {
- font-size: 1.5em;
+ font-size: 1.2em;
+ font-weight: 300;
margin-top: 0;
margin-bottom: 0.5em;
padding-top: 0.5em;
@@ -169,8 +234,14 @@ div.footer a {
/* -- body styles ----------------------------------------------------------- */
+.body :target {
+ /* ensure targets are not obscured by top-bar when they are navigated to */
+ scroll-margin-top: 6.5rem;
+}
+
p {
margin: 0.8em 0 0.5em 0;
+ line-height: 1.5;
}
a {
@@ -186,7 +257,7 @@ h1 {
margin: 10px 0 0 0;
font-size: 2.4em;
color: var(--colour-sphinx-blue);
- font-weight: 300;
+ font-weight: 400;
}
h1 span.pre {
@@ -198,7 +269,7 @@ h1 span.pre {
h2 {
margin: 1em 0 0.2em 0;
font-size: 1.5em;
- font-weight: 300;
+ font-weight: 400;
padding: 0;
color: #174967;
}
@@ -206,7 +277,7 @@ h2 {
h3 {
margin: 1em 0 -0.3em 0;
font-size: 1.3em;
- font-weight: 300;
+ font-weight: 400;
}
div.body h1 a, div.body h2 a, div.body h3 a, div.body h4 a, div.body h5 a, div.body h6 a {
@@ -311,6 +382,10 @@ aside.topic {
background-color: #f8f8f8;
}
+p.topic-title {
+ margin-top: 0;
+}
+
table {
border-collapse: collapse;
margin: 0 -0.5em 0 -0.5em;
@@ -324,7 +399,7 @@ div.admonition, div.warning {
font-size: 0.9em;
margin: 1em 0 1em 0;
border: 1px solid #86989B;
- border-radius: 2px;
+ border-radius: var(--admonition-radius);
background-color: #f7f7f7;
padding: 1rem;
}
@@ -338,13 +413,120 @@ div.admonition > pre, div.warning > pre {
margin: 0.4em 1em 0.4em 1em;
}
-div.admonition > p.admonition-title,
+div.admonition > p.admonition-title {
+ position: relative;
+ font-weight: 500;
+ background-color: var(--color-admonition-bg);
+ margin: -1rem -1rem 0.8rem -1rem;
+ padding: 0.3rem 1rem 0.3rem 2rem;
+ border-radius: var(--admonition-radius) var(--admonition-radius) 0 0;
+}
+
+div.attention > p.admonition-title,
+div.danger > p.admonition-title,
+div.error > p.admonition-title {
+ background-color: var(--colour-error-bg);
+}
+
+div.important > p.admonition-title,
+div.caution > p.admonition-title,
div.warning > p.admonition-title {
- font-weight: bold;
+ background-color: var(--colour-warning-bg);
}
+div.note > p.admonition-title {
+ background-color: var(--colour-note-bg);
+}
+
+div.hint > p.admonition-title,
+div.tip > p.admonition-title,
+div.seealso > p.admonition-title {
+ background-color: var(--colour-success-bg);
+}
+
+div.admonition-todo > p.admonition-title {
+ background-color: var(--colour-todo-bg);
+}
+
+p.admonition-title::before {
+ content: "";
+ height: 1rem;
+ left: .5rem;
+ top: .5rem;
+ position: absolute;
+ width: 1rem;
+ background-color: #5f5f5f;
+}
+
+div.admonition > p.admonition-title::before {
+ background-color: var(--color-admonition-fg);
+ -webkit-mask-image: var(--icon-abstract);
+ mask-image: var(--icon-abstract);
+}
+div.attention > p.admonition-title::before {
+ background-color: var(--colour-error-fg);
+ -webkit-mask-image: var(--icon-warning);
+ mask-image: var(--icon-warning);
+}
+div.caution > p.admonition-title::before {
+ background-color: var(--colour-warning-fg);
+ -webkit-mask-image: var(--icon-spark);
+ mask-image: var(--icon-spark);
+}
+div.danger > p.admonition-title::before {
+ background-color: var(--colour-error-fg);
+ -webkit-mask-image: var(--icon-spark);
+ mask-image: var(--icon-spark);
+}
+div.error > p.admonition-title::before {
+ background-color: var(--colour-error-fg);
+ -webkit-mask-image: var(--icon-failure);
+ mask-image: var(--icon-failure);
+}
+div.hint > p.admonition-title::before {
+ background-color: var(--colour-success-fg);
+ -webkit-mask-image: var(--icon-question);
+ mask-image: var(--icon-question);
+}
+div.important > p.admonition-title::before {
+ background-color: var(--colour-warning-fg);
+ -webkit-mask-image: var(--icon-flame);
+ mask-image: var(--icon-flame);
+}
+div.note > p.admonition-title::before {
+ background-color: var(--colour-note-fg);
+ -webkit-mask-image: var(--icon-pencil);
+ mask-image: var(--icon-pencil);
+}
+div.seealso > p.admonition-title::before {
+ background-color: var(--colour-success-fg);
+ -webkit-mask-image: var(--icon-info);
+ mask-image: var(--icon-info);
+}
+div.tip > p.admonition-title::before {
+ background-color: var(--colour-success-fg);
+ -webkit-mask-image: var(--icon-info);
+ mask-image: var(--icon-info);
+}
+div.admonition-todo > p.admonition-title::before {
+ background-color: var(--colour-todo-fg);
+ -webkit-mask-image: var(--icon-pencil);
+ mask-image: var(--icon-pencil);
+}
+div.warning > p.admonition-title::before {
+ background-color: var(--colour-warning-fg);
+ -webkit-mask-image: var(--icon-warning);
+ mask-image: var(--icon-warning);
+}
+div.caution,
+div.important,
div.warning {
- border: 1px solid #940000;
+ border-color: var(--colour-warning-fg);
+}
+div.attention,
+div.danger,
+div.error {
+ border-color: var(--colour-error-fg);
}
div.admonition > ul,
@@ -373,11 +555,132 @@ div.viewcode-block:target {
/* media queries */
/* Reduce padding & margins for smaller screens */
-@media (max-width: 750px) {
+@media (max-width: 768px) {
.sphinxsidebar {
display: none;
}
div.body {
border-left: none;
+ padding-left: 0.5em;
+ padding-right: 0.5em;
}
}
+
+/* Next/previous content footer */
+.related-pages {
+ display: flex;
+ flex-direction: row;
+ justify-content: space-between;
+ margin-top: 2rem;
+ font-size: smaller;
+}
+.related-pages .next-page {
+ text-align: right;
+}
+.related-pages a.prev-page,
+.related-pages a.next-page {
+ flex: 1 1 0%;
+ display: flex;
+ align-items: center;
+ border-radius: .25rem;
+ padding: .25rem;
+ text-decoration: none;
+}
+.related-pages a.prev-page {
+ justify-content: flex-start;
+ padding-left: 0;
+}
+.related-pages a.next-page {
+ justify-content: flex-end;
+ padding-right: 0;
+}
+.related-pages a:hover {
+ background-color: #f8f8f8;
+}
+.related-pages a .context {
+ font-size: small;
+ color: #5f5f5f;
+}
+.related-pages svg {
+ height: .75rem;
+ width: .75rem;
+ margin: 0 .5rem;
+ flex-shrink: 0;
+}
+.related-pages .prev-page svg {
+ transform: rotate(180deg);
+}
+
+/* ReadtheDocs docs selector */
+/* see https://docs.readthedocs.io/en/stable/flyout-menu.html */
+.rst-versions.rst-badge {
+ background-color: #f7f7f7;
+ border: 1px solid var(--colour-sphinx-blue);
+ border-radius: var(--admonition-radius);
+ color: var(--colour-sphinx-blue);
+}
+.rst-versions .rst-current-version {
+ background-color: #f7f7f7;
+ border-radius: var(--admonition-radius);
+ color: var(--colour-sphinx-blue);
+}
+.rst-versions .rst-current-version .fa {
+ color: var(--colour-sphinx-blue);
+}
+.rst-versions .rst-other-versions {
+ border-radius: 0 0 var(--admonition-radius) var(--admonition-radius);
+ border-top: 1px solid var(--colour-sphinx-blue);
+ background-color: #f7f7f7;
+ color: var(--colour-text);
+}
+.rst-versions .rst-other-versions dd a {
+ color: var(--colour-sphinx-blue);
+}
+
+
+/* Landing page */
+.sphinx-tagline * {
+ hyphens: none !important;
+ font-style: italic !important;
+}
+/* By default align the sphinx-features one per-row and center them,
+then for larger screens align them two per-row. */
+.sphinx-features {
+ display: flex;
+ flex-wrap: wrap;
+ gap: 10px;
+ justify-content: center;
+}
+.sphinx-feature {
+ flex: 1 1 100%;
+ margin: 0 !important;
+ background-color: white !important;
+}
+.sphinx-feature p {
+ hyphens: none !important;
+}
+div.sphinx-feature > p.admonition-title {
+ background-color: #f7f7f7 !important;
+ padding-left: 1rem;
+ font-weight: bold;
+}
+div.sphinx-feature > p.admonition-title::before {
+ display: none;
+}
+@media (min-width: 768px) {
+ .sphinx-feature {
+ flex: 0 0 auto;
+ box-sizing: border-box;
+ width: 48%;
+ }
+}
+.sphinx-users {
+ text-align: center;
+ font-weight: 500;
+}
+.sphinx-users-logos {
+ display: flex;
+ flex-wrap: wrap;
+ justify-content: center;
+ gap: 10px;
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-14 17:25:09 +0000