Skip to content

Commit dda959d

Browse files
committed
Deploying to gh-pages from @ ae77e7c 🚀
1 parent 5a051b2 commit dda959d

File tree

4 files changed

+20
-9
lines changed

4 files changed

+20
-9
lines changed

main/contribution-guide.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -541,6 +541,7 @@ <h3>Supported Python Versions<a class="headerlink" href="#supported-python-versi
541541
At a minimum you will need Python 3.9 for code changes and 3.13 if you plan on doing documentation building / changes.</p>
542542
<p>You can use various tools to manage multiple Python versions on your system including:</p>
543543
<ul class="simple">
544+
<li><p>Using <a class="reference external" href="https://docs.astral.sh/uv/guides/install-python/">uv built-in</a> Python version management.</p></li>
544545
<li><p><a class="reference external" href="https://github.com/pyenv/pyenv">pyenv</a> and <a class="reference external" href="https://github.com/pyenv-win/pyenv-win">pyenv-win for Windows</a></p></li>
545546
<li><p><a class="reference external" href="https://mise.jdx.dev/">rtx / mise</a></p></li>
546547
<li><p><a class="reference external" href="https://asdf-vm.com/">asdf</a></p></li>
@@ -586,6 +587,16 @@ <h3>Setting up the environment<a class="headerlink" href="#setting-up-the-enviro
586587
</section>
587588
<section id="code-contributions">
588589
<h2>Code contributions<a class="headerlink" href="#code-contributions" title="Link to this heading"></a></h2>
590+
<div class="admonition important">
591+
<p class="admonition-title">Important</p>
592+
<ul class="simple">
593+
<li><p>Documentation PRs are always welcome; it’s often a very good entry point to get familiar with the project.</p></li>
594+
<li><p>Bug fixes and small improvements are also a good way to get started. There is no shortage of small things that can be improved.</p></li>
595+
<li><p>We’re all humans (hopefully) and may forget about your particular PR. If you feel your PR has stalled, feel free to gently nudge us.</p></li>
596+
<li><p>Large features or refactors may take time. Please be patient; we’re all volunteers and want to ensure the best possible outcome.</p></li>
597+
<li><p>Use LLMs intelligently. Most PRs automatically generated are not usable, and incur a higher than normal cost from reviewers and maintainers, as they still need to be thoroughly evaluated, even if they are ultimately not acceptable.</p></li>
598+
</ul>
599+
</div>
589600
<section id="workflow">
590601
<h3>Workflow<a class="headerlink" href="#workflow" title="Link to this heading"></a></h3>
591602
<ol class="arabic simple">

main/release-notes/whats-new-2.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,7 +1129,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Link to this heading">¶</a></
11291129
<div class="admonition">
11301130
<p class="admonition-title">Run it</p>
11311131
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
1132-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;7f655fa1-2389-4155-ab9c-17e924daa8c6&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
1132+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;f586522c-e53e-439d-83c7-798879b5a18e&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
11331133
</span></pre></div>
11341134
</div>
11351135
</div>
@@ -1246,7 +1246,7 @@ <h2>DTOs<a class="headerlink" href="#dtos" title="Link to this heading">¶</a></
12461246
<div class="admonition">
12471247
<p class="admonition-title">Run it</p>
12481248
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
1249-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;1a337975-8956-4d52-bbb0-d418f344d053&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
1249+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;fd0fd302-a2dc-4d89-bb4d-15e0cf1efb9f&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
12501250
</span></pre></div>
12511251
</div>
12521252
</div>

main/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

main/usage/dto/1-abstract-dto.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ <h2>Using DTO Factories<a class="headerlink" href="#using-dto-factories" title="
582582
<div class="admonition">
583583
<p class="admonition-title">Run it</p>
584584
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
585-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;cbb4d037-e0dd-4821-8b4d-ef78234cb5e3&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
585+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;dfab293c-44a2-49cd-a56a-0893ecf104f6&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
586586
</span></pre></div>
587587
</div>
588588
</div>
@@ -644,7 +644,7 @@ <h2>Using DTO Factories<a class="headerlink" href="#using-dto-factories" title="
644644
<div class="admonition">
645645
<p class="admonition-title">Run it</p>
646646
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
647-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;baad8baa-ae90-44c8-a566-832ae4c06bdb&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
647+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;9014fbeb-ccd4-43cf-84d3-7e0ef1432189&quot;</span>,<span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
648648
</span></pre></div>
649649
</div>
650650
</div>
@@ -790,7 +790,7 @@ <h2>Renaming fields<a class="headerlink" href="#renaming-fields" title="Link to
790790
<div class="admonition">
791791
<p class="admonition-title">Run it</p>
792792
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
793-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;22715341-37c6-46c9-b802-f8d7e51308c9&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
793+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;created_at&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;8b7f8ea3-388a-4cba-a244-85941c053806&quot;</span>,<span class="s2">&quot;userName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
794794
</span></pre></div>
795795
</div>
796796
</div>
@@ -835,7 +835,7 @@ <h2>Renaming fields<a class="headerlink" href="#renaming-fields" title="Link to
835835
<div class="admonition">
836836
<p class="admonition-title">Run it</p>
837837
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span>,<span class="s2">&quot;password&quot;</span>:<span class="s2">&quot;xyz&quot;</span>,<span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;2023-04-24T00:00:00Z&quot;</span><span class="o">}</span>
838-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;7e693a8f-9559-4cad-947a-93535c1928bc&quot;</span>,<span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
838+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;createdAt&quot;</span>:<span class="s2">&quot;0001-01-01T00:00:00&quot;</span>,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;c1494d86-7901-457f-8cd9-b736c2fe30ce&quot;</span>,<span class="s2">&quot;firstName&quot;</span>:<span class="s2">&quot;Litestar User&quot;</span><span class="o">}</span>
839839
</span></pre></div>
840840
</div>
841841
</div>
@@ -1046,7 +1046,7 @@ <h2>DTO Data<a class="headerlink" href="#dto-data" title="Link to this heading">
10461046
<div class="admonition">
10471047
<p class="admonition-title">Run it</p>
10481048
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;email&quot;</span>:<span class="w"> </span><span class="s2">&quot;peter@example.com&quot;</span>,<span class="w"> </span><span class="s2">&quot;age&quot;</span>:41<span class="o">}</span>
1049-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;email&quot;</span>:<span class="s2">&quot;peter@example.com&quot;</span>,<span class="s2">&quot;age&quot;</span>:41,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;5df7d3d5-cef8-429f-aac6-d5d4a7015acb&quot;</span><span class="o">}</span>
1049+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;email&quot;</span>:<span class="s2">&quot;peter@example.com&quot;</span>,<span class="s2">&quot;age&quot;</span>:41,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;73d36192-7973-46bb-af0e-04de12aaca88&quot;</span><span class="o">}</span>
10501050
</span></pre></div>
10511051
</div>
10521052
</div>
@@ -1092,7 +1092,7 @@ <h2>DTO Data<a class="headerlink" href="#dto-data" title="Link to this heading">
10921092
<div class="admonition">
10931093
<p class="admonition-title">Run it</p>
10941094
<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span data-line="1">&gt;<span class="w"> </span>curl<span class="w"> </span>http://127.0.0.1:8000/users<span class="w"> </span>-H<span class="w"> </span>Content-Type:<span class="w"> </span>application/json<span class="w"> </span>-d<span class="w"> </span><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="w"> </span><span class="s2">&quot;email&quot;</span>:<span class="w"> </span><span class="s2">&quot;peter@example.com&quot;</span>,<span class="w"> </span><span class="s2">&quot;age&quot;</span>:41<span class="o">}</span>
1095-
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;email&quot;</span>:<span class="s2">&quot;peter@example.com&quot;</span>,<span class="s2">&quot;age&quot;</span>:41,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;ab655d51-f04a-4913-9aac-2183fa55d852&quot;</span><span class="o">}</span>
1095+
</span><span data-line="2"><span class="o">{</span><span class="s2">&quot;name&quot;</span>:<span class="s2">&quot;Peter&quot;</span>,<span class="s2">&quot;email&quot;</span>:<span class="s2">&quot;peter@example.com&quot;</span>,<span class="s2">&quot;age&quot;</span>:41,<span class="s2">&quot;id&quot;</span>:<span class="s2">&quot;bedeb6bb-fb55-4f2e-9d51-1d810d5d3dd5&quot;</span><span class="o">}</span>
10961096
</span></pre></div>
10971097
</div>
10981098
</div>

0 commit comments

Comments
 (0)