Skip to content

Commit d79710f

Browse files
Built site for gh-pages
1 parent f58d7fc commit d79710f

19 files changed

+467
-263
lines changed

.nojekyll

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
c5dcb548
1+
3285a8c8

docs/architecture.html

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
33

44
<meta charset="utf-8">
5-
<meta name="generator" content="quarto-1.7.31">
5+
<meta name="generator" content="quarto-1.8.25">
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

@@ -32,14 +32,15 @@
3232
<meta name="quarto:offset" content="../">
3333
<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
3434
<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
35+
<script src="../site_libs/quarto-html/axe/axe-check.js" type="module"></script>
3536
<script src="../site_libs/quarto-html/popper.min.js"></script>
3637
<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
3738
<script src="../site_libs/quarto-html/anchor.min.js"></script>
3839
<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
39-
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-e1a5c8363afafaef2c763b6775fbf3ca.css" rel="stylesheet" id="quarto-text-highlighting-styles">
40+
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-7b89279ff1a6dce999919e0e67d4d9ec.css" rel="stylesheet" id="quarto-text-highlighting-styles">
4041
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
4142
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
42-
<link href="../site_libs/bootstrap/bootstrap-dde8d7229bfee0f8bb5efd37f0f9ae1e.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
43+
<link href="../site_libs/bootstrap/bootstrap-0b37c64f34216b628666a8dac638b53b.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
4344
<script id="quarto-search-options" type="application/json">{
4445
"location": "navbar",
4546
"copy-button": false,
@@ -79,6 +80,8 @@
7980
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
8081
<div class="navbar-container container-fluid">
8182
<div class="navbar-brand-container mx-auto">
83+
<a href="../index.html" class="navbar-brand navbar-brand-logo">
84+
</a>
8285
<a class="navbar-brand" href="../index.html">
8386
<span class="navbar-title">FastAPI Webapp Template</span>
8487
</a>
@@ -233,13 +236,14 @@ <h2 class="anchored" data-anchor-id="data-flow">Data flow</h2>
233236
e.clearSelection();
234237
}
235238
const getTextToCopy = function(trigger) {
236-
const codeEl = trigger.previousElementSibling.cloneNode(true);
237-
for (const childEl of codeEl.children) {
238-
if (isCodeAnnotation(childEl)) {
239-
childEl.remove();
240-
}
239+
const outerScaffold = trigger.parentElement.cloneNode(true);
240+
const codeEl = outerScaffold.querySelector('code');
241+
for (const childEl of codeEl.children) {
242+
if (isCodeAnnotation(childEl)) {
243+
childEl.remove();
241244
}
242-
return codeEl.innerText;
245+
}
246+
return codeEl.innerText;
243247
}
244248
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
245249
text: getTextToCopy

docs/authentication.html

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
33

44
<meta charset="utf-8">
5-
<meta name="generator" content="quarto-1.7.31">
5+
<meta name="generator" content="quarto-1.8.25">
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

@@ -32,14 +32,15 @@
3232
<meta name="quarto:offset" content="../">
3333
<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
3434
<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
35+
<script src="../site_libs/quarto-html/axe/axe-check.js" type="module"></script>
3536
<script src="../site_libs/quarto-html/popper.min.js"></script>
3637
<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
3738
<script src="../site_libs/quarto-html/anchor.min.js"></script>
3839
<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
39-
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-e1a5c8363afafaef2c763b6775fbf3ca.css" rel="stylesheet" id="quarto-text-highlighting-styles">
40+
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-7b89279ff1a6dce999919e0e67d4d9ec.css" rel="stylesheet" id="quarto-text-highlighting-styles">
4041
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
4142
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
42-
<link href="../site_libs/bootstrap/bootstrap-dde8d7229bfee0f8bb5efd37f0f9ae1e.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
43+
<link href="../site_libs/bootstrap/bootstrap-0b37c64f34216b628666a8dac638b53b.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
4344
<script id="quarto-search-options" type="application/json">{
4445
"location": "navbar",
4546
"copy-button": false,
@@ -79,6 +80,8 @@
7980
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
8081
<div class="navbar-container container-fluid">
8182
<div class="navbar-brand-container mx-auto">
83+
<a href="../index.html" class="navbar-brand navbar-brand-logo">
84+
</a>
8285
<a class="navbar-brand" href="../index.html">
8386
<span class="navbar-title">FastAPI Webapp Template</span>
8487
</a>
@@ -276,13 +279,14 @@ <h2 class="anchored" data-anchor-id="password-reset-flow">Password reset flow</h
276279
e.clearSelection();
277280
}
278281
const getTextToCopy = function(trigger) {
279-
const codeEl = trigger.previousElementSibling.cloneNode(true);
280-
for (const childEl of codeEl.children) {
281-
if (isCodeAnnotation(childEl)) {
282-
childEl.remove();
283-
}
282+
const outerScaffold = trigger.parentElement.cloneNode(true);
283+
const codeEl = outerScaffold.querySelector('code');
284+
for (const childEl of codeEl.children) {
285+
if (isCodeAnnotation(childEl)) {
286+
childEl.remove();
284287
}
285-
return codeEl.innerText;
288+
}
289+
return codeEl.innerText;
286290
}
287291
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
288292
text: getTextToCopy

docs/contributing.html

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
33

44
<meta charset="utf-8">
5-
<meta name="generator" content="quarto-1.7.31">
5+
<meta name="generator" content="quarto-1.8.25">
66

77
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
88

@@ -67,14 +67,15 @@
6767
<meta name="quarto:offset" content="../">
6868
<script src="../site_libs/quarto-html/quarto.js" type="module"></script>
6969
<script src="../site_libs/quarto-html/tabsets/tabsets.js" type="module"></script>
70+
<script src="../site_libs/quarto-html/axe/axe-check.js" type="module"></script>
7071
<script src="../site_libs/quarto-html/popper.min.js"></script>
7172
<script src="../site_libs/quarto-html/tippy.umd.min.js"></script>
7273
<script src="../site_libs/quarto-html/anchor.min.js"></script>
7374
<link href="../site_libs/quarto-html/tippy.css" rel="stylesheet">
74-
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-e1a5c8363afafaef2c763b6775fbf3ca.css" rel="stylesheet" id="quarto-text-highlighting-styles">
75+
<link href="../site_libs/quarto-html/quarto-syntax-highlighting-7b89279ff1a6dce999919e0e67d4d9ec.css" rel="stylesheet" id="quarto-text-highlighting-styles">
7576
<script src="../site_libs/bootstrap/bootstrap.min.js"></script>
7677
<link href="../site_libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
77-
<link href="../site_libs/bootstrap/bootstrap-dde8d7229bfee0f8bb5efd37f0f9ae1e.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
78+
<link href="../site_libs/bootstrap/bootstrap-0b37c64f34216b628666a8dac638b53b.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
7879
<script id="quarto-search-options" type="application/json">{
7980
"location": "navbar",
8081
"copy-button": false,
@@ -114,6 +115,8 @@
114115
<nav class="navbar navbar-expand-lg " data-bs-theme="dark">
115116
<div class="navbar-container container-fluid">
116117
<div class="navbar-brand-container mx-auto">
118+
<a href="../index.html" class="navbar-brand navbar-brand-logo">
119+
</a>
117120
<a class="navbar-brand" href="../index.html">
118121
<span class="navbar-title">FastAPI Webapp Template</span>
119122
</a>
@@ -259,12 +262,12 @@ <h3 class="anchored" data-anchor-id="contributing-code">Contributing code</h3>
259262
<h3 class="anchored" data-anchor-id="rendering-the-documentation">Rendering the documentation</h3>
260263
<p>The README and documentation website are rendered with <a href="https://quarto.org/docs/">Quarto</a>. If you make changes to the <code>.qmd</code> files in the root folder and the <code>docs</code> folder, you will need to re-render the docs with Quarto.</p>
261264
<p>Quarto expects environment variables to be set in a file called <code>_environment</code>, so before running Quarto render commands, you should copy your <code>.env</code> file to <code>_environment</code>.</p>
262-
<div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># To copy the .env file to _environment</span></span>
265+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb1"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="co"># To copy the .env file to _environment</span></span>
263266
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true" tabindex="-1"></a><span class="fu">cp</span> .env _environment</span>
264267
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true" tabindex="-1"></a><span class="co"># To render the documentation website</span></span>
265268
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto render</span>
266269
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true" tabindex="-1"></a><span class="co"># To render the README</span></span>
267-
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto render index.qmd <span class="at">--output-dir</span> . <span class="at">--output</span> README.md <span class="at">--to</span> gfm</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
270+
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto render index.qmd <span class="at">--output-dir</span> . <span class="at">--output</span> README.md <span class="at">--to</span> gfm</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
268271
<p>Due to a quirk of Quarto, an unnecessary <code>index.html</code> file is created in the root folder when the README is rendered. This file can be safely deleted.</p>
269272
<p>Note that even if your pull request is merged, your changes will not be reflected on the live website until a maintainer republishes the docs.</p>
270273
</section>
@@ -286,7 +289,7 @@ <h3 class="anchored" data-anchor-id="git-flow">Git flow</h3>
286289
<section id="publishing-the-documentation" class="level3">
287290
<h3 class="anchored" data-anchor-id="publishing-the-documentation">Publishing the documentation</h3>
288291
<p>To publish the documentation to GitHub Pages, run the following command:</p>
289-
<div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto publish gh-pages</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
292+
<div class="code-copy-outer-scaffold"><div class="sourceCode" id="cb2"><pre class="sourceCode bash code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run quarto publish gh-pages</span></code></pre></div><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></div>
290293

291294

292295
</section>
@@ -344,13 +347,14 @@ <h3 class="anchored" data-anchor-id="publishing-the-documentation">Publishing th
344347
e.clearSelection();
345348
}
346349
const getTextToCopy = function(trigger) {
347-
const codeEl = trigger.previousElementSibling.cloneNode(true);
348-
for (const childEl of codeEl.children) {
349-
if (isCodeAnnotation(childEl)) {
350-
childEl.remove();
351-
}
350+
const outerScaffold = trigger.parentElement.cloneNode(true);
351+
const codeEl = outerScaffold.querySelector('code');
352+
for (const childEl of codeEl.children) {
353+
if (isCodeAnnotation(childEl)) {
354+
childEl.remove();
352355
}
353-
return codeEl.innerText;
356+
}
357+
return codeEl.innerText;
354358
}
355359
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
356360
text: getTextToCopy

0 commit comments

Comments
 (0)