Got some docs in

palewire · Oct 30, 2023 · 53bf376 · 53bf376
1 parent 874d97b
commit 53bf376
Show file tree

Hide file tree

Showing 6 changed files with 469 additions and 34 deletions.
diff --git a/.flake8 b/.flake8
@@ -1,2 +1,2 @@
 [flake8]
-extend-ignore = E203,E501
+extend-ignore = E203,E501,D104
diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css
@@ -0,0 +1,313 @@
+@import url('https://fonts.googleapis.com/css2?family=Libre+Franklin:ital,wght@0,400;0,700;0,800;1,400;1,800&display=swap');
+@import url('https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;700&display=swap');
+
+div.document {
+    margin-top: 0 !important;
+}
+
+div.body {
+    min-width: 0 !important;
+}
+
+div.body p, div.body li {
+    line-height: 1.45;
+}
+
+div.body li {
+    margin-bottom: 4px;
+}
+
+div.topic {
+    margin: 0;
+    padding: 8px 12px;
+}
+
+p.topic-title {
+    margin: 0;
+}
+
+div.topic ul {
+    margin-top: 6px;
+}
+@media screen and (max-width: 870px) {
+    ul {
+        margin: 10px 0 10px 20px;
+    }
+}
+
+div.sphinxsidebar h1.logo,
+div.sphinxsidebar h3 {
+  font-family: 'Libre Franklin', "Helvetica", "Liberation Sans", Arial, sans-serif;
+}
+
+div.sphinxsidebarwrapper h1 {
+    line-height: 1.25;
+}
+
+div.sphinxsidebarwrapper h1.logo {
+  font-size: 1.85em;
+  font-weight: 800;
+}
+
+div.sphinxsidebarwrapper h1 a,
+div.sphinxsidebarwrapper h1 a:visited {
+    color: black;
+}
+
+@media (min-width: 875px) {
+    div.sphinxsidebar {
+        margin-top: 85px;
+    }
+}
+
+@media screen and (max-width: 875px) {
+  div.sphinxsidebar {
+    width: auto;
+    padding: 10px 20px;
+    margin: 50px 0 0 0;
+  }
+}
+
+div.admonition {
+    padding: 15px;
+}
+
+div.warning {
+  background-color: #EEE;
+  border: 1px solid #CCC;
+}
+
+div.admonition p.admonition-title {
+  font-family: 'Libre Franklin', "Helvetica", "Liberation Sans", Arial, sans-serif;
+  margin: 0;
+}
+
+div.related nav {
+    padding-right: 10px;
+}
+
+body {
+  font-family: 'Libre Franklin', "Helvetica", "Liberation Sans", Arial, sans-serif;
+  font-size: 20px;
+  line-height: 1.45;
+  text-align: left;
+}
+@media screen and (max-width: 875px) {
+    body {
+        margin: 0;
+        padding: 0;
+    }
+    div.body > .section,
+    div.body > section {
+        padding: 0 20px;
+    }
+}
+
+@media (max-width: 550px) {
+    body {
+        font-size: 0.85em;
+    }
+}
+
+div.body h1, div.body h2, div.body h3, div.body h4, div.body h5, div.body h6 {
+  font-family: 'Libre Franklin', "Helvetica", "Liberation Sans", Arial, sans-serif;
+  font-weight: 700;
+}
+
+div.body h1 {
+  font-weight: 800;
+  font-size: 220%;
+  line-height: 1.2;
+}
+
+pre, tt, code {
+  background: none;
+  font-family: 'IBM Plex Mono', 'Droid Sans Mono', monospace;
+}
+
+pre {
+  padding: 7px;
+}
+
+.cell_output {
+  overflow: auto;
+}
+
+.toctree-wrapper p.caption {
+  font-weight: 700;
+}
+
+.toggle-details {
+  display: none;
+}
+
+.row {
+    width: 100%;
+    max-width: 660px;
+    margin: 0 auto;
+    overflow: hidden;
+}
+.row .fivecol {
+    width: 43%;
+    float: right;
+    min-height: 1px;
+}
+.row .sevencol {
+    width: 37%;
+    float: left;
+    min-height: 1px;
+}
+@media (max-width: 550px) {
+    .row .fivecol, .row .sevencol {
+        padding: 0 20px;
+    }
+}
+
+/* The header */
+nav {
+    display: block;
+    margin-top: 0.75em;
+    margin-bottom: 0.5em;
+    font-size: 1em;
+    line-height: 1.7em;
+}
+nav .shingle {
+    font-size: 1.7em;
+    font-weight: bold;
+    text-align: left;
+    padding-left: 0.15em;
+}
+nav .shingle a {
+    text-decoration: none;
+    font-weight: bold;
+    color: #000;
+}
+nav .shingle a:hover {
+    color: #686868;
+}
+@media (max-width: 550px) {
+    nav .shingle {
+        float: left;
+        margin-bottom: 5px;
+        padding-left: 0;
+   }
+}
+nav .links {
+    text-align: right;
+}
+nav .links ul {
+    float: right;
+    list-style-type: none;
+    margin: 4px 0 0 0;
+}
+nav .links li {
+    float: left;
+    list-style-position: inside;
+    margin-left: 0.5em;
+    font-size: 0.9em;
+    font-weight: 300;
+    margin-bottom: 0;
+}
+@media (max-width: 550px) {
+    nav .links li {
+       font-size: .825em;
+    }
+}
+nav .links li a {
+    text-decoration: none;
+}
+nav .links li a:hover {
+    text-decoration: underline;
+}
+.last {
+    margin-right: 0;
+}
+
+.topbar {
+    border-bottom: solid 10px #e5e5e5;
+    margin-bottom: 20px;
+    width: 100%;
+}
+
+a:link,
+div.sphinxsidebar a,
+div.sphinxsidebar a:link {
+  text-decoration: none;
+  color: #686868;
+  border-bottom: none;
+}
+a:visited,
+div.sphinxsidebar a:visited {
+  text-decoration: none;
+  color: #686868;
+  border-bottom: none;
+}
+a:hover,
+div.sphinxsidebar a:hover {
+  text-decoration: underline;
+  border-bottom: none;
+}
+a:active,
+div.sphinxsidebar a:active {
+  text-decoration: underline;
+  color: #000;
+  border-bottom: none;
+}
+a.reference,
+a.internal {
+ border-bottom: 0;
+}
+a.reference:hover,
+a.internal:hover {
+ border-bottom: 0;
+}
+h1.logo a {
+  color: black;
+}
+
+h2+p {
+    margin-top: 5px;
+}
+
+table.align-default {
+    margin-left: 0 !important;
+    margin-right: 0 !important;
+}
+
+.latest-parent {
+    display: flex;
+    flex-wrap: wrap;
+    justify-content: flex-start;
+}
+
+.latest-child {
+    width: 212px;
+    margin: 0 8px 8px 0;
+}
+
+.latest-child p {
+    margin-top: 0;
+}
+
+@media (max-width: 550px) {
+  .latest-child {
+    width: 190px;
+  }
+}
+
+.table-container {
+    overflow-x: auto;
+}
+
+#api-reference dd {
+    margin-left: 0;
+}
+
+#api-reference dl.field-list > dt {
+    font-weight: 400 !important;
+    padding-left: 0;
+}
+
+#api-reference p.rubric {
+    font-weight: 400 !important;
+}
diff --git a/docs/_templates/nav.html b/docs/_templates/nav.html
@@ -0,0 +1,48 @@
+<nav>
+    <div class="row">
+        <div class="sevencol">
+            <div class="shingle">
+                <a href="https://palewi.re/">
+                    <div rel="rnews:copyrightedBy rnews:hasSource rnews:providedBy">
+                        <div about="http://palewi.re/" typeof="rnews:Organization">
+                            <div property="rnews:name">palewire</div>
+                        </div>
+                    </div>
+                </a>
+            </div>
+        </div>
+        <div class="fivecol last links">
+            <ul>
+                <li>
+                    <a href="http://palewi.re/posts/" title="Posts">
+                        Posts
+                    </a>
+                </li>
+                <li>
+                    <a href="http://palewi.re/work/" title="Work">
+                        Work
+                    </a>
+                </li>
+                <li>
+                    <a href="http://palewi.re/talks/" title="Talks">
+                        Talks
+                    </a>
+                </li>
+                <li>
+                    <a href="http://palewi.re/docs/" title="Docs">
+                        Docs
+                    </a>
+                </li>
+                <li>
+                    <a href="http://palewi.re/who-is-ben-welsh/" title="Who is Ben Welsh?">
+                        About
+                    </a>
+                </li>
+            </ul>
+        </div>
+    </div>
+</nav>
+<div class="row topbar">
+    <div class="twelvecol last"></div>
+</div>
+<link rel="me" href="https://mastodon.social/@palewire">