Skip to content

Commit 92f7984

Browse files
committed
chore: Update documentation
1 parent 12e34bd commit 92f7984

File tree

4 files changed

+9
-5
lines changed

4 files changed

+9
-5
lines changed

contributing/index.html

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -976,13 +976,14 @@ <h2 id="environment-setup">Environment setup<a class="headerlink" href="#environ
976976
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>griffe-inherited-docstrings
977977
make<span class="w"> </span>setup
978978
</code></pre></div>
979-
<blockquote>
980-
<p>NOTE: If it fails for some reason, you'll need to install <a href="https://github.com/astral-sh/uv">uv</a> manually.</p>
979+
<div class="admonition note">
980+
<p class="admonition-title">Note</p>
981+
<p>If it fails for some reason, you'll need to install <a href="https://github.com/astral-sh/uv">uv</a> manually.</p>
981982
<p>You can install it with:</p>
982983
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span>-LsSf<span class="w"> </span>https://astral.sh/uv/install.sh<span class="w"> </span><span class="p">|</span><span class="w"> </span>sh
983984
</code></pre></div>
984985
<p>Now you can try running <code>make setup</code> again, or simply <code>uv sync</code>.</p>
985-
</blockquote>
986+
</div>
986987
<p>You now have the dependencies installed.</p>
987988
<p>Run <code>make help</code> to see all the available actions!</p>
988989
<h2 id="tasks">Tasks<a class="headerlink" href="#tasks" title="Permanent link">¤</a></h2>

index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -935,8 +935,11 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">
935935
</tr>
936936
</tbody>
937937
</table>
938-
<p>WARNING: <strong>Limitation</strong>
938+
<div class="admonition warning">
939+
<p class="admonition-title">Limitation</p>
940+
<p>
939941
This extension runs once on whole packages. There is no way to toggle merging or simple inheritance for specifc objects.</p>
942+
</div>
940943
<h2 id="sponsors">Sponsors<a class="headerlink" href="#sponsors" title="Permanent link">¤</a></h2>
941944
<!-- sponsors-start -->
942945
<!-- sponsors-end -->

objects.inv

-176 Bytes
Binary file not shown.

search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)