Skip to content

Commit ea101b0

Browse files
committed
chore: Update documentation
1 parent c767239 commit ea101b0

13 files changed

Lines changed: 195 additions & 73 deletions

File tree

404.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020

2121
<link rel="icon" href="/griffe2md/assets/images/favicon.png">
22-
<meta name="generator" content="zensical-0.0.23">
22+
<meta name="generator" content="zensical-0.0.24">
2323

2424

2525

@@ -30,7 +30,7 @@
3030

3131

3232

33-
<link rel="stylesheet" href="/griffe2md/assets/stylesheets/modern/main.1e989742.min.css">
33+
<link rel="stylesheet" href="/griffe2md/assets/stylesheets/modern/main.28978c9b.min.css">
3434

3535

3636

@@ -842,7 +842,7 @@ <h1>404 - Not found</h1>
842842
<script id="__config" type="application/json">{"annotate":null,"base":"/griffe2md","features":["announce.dismiss","content.action.edit","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.tabs.sticky","navigation.top","search.highlight","toc.follow"],"search":"/griffe2md/assets/javascripts/workers/search.e2d2d235.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":null}</script>
843843

844844

845-
<script src="/griffe2md/assets/javascripts/bundle.5fcf0de6.min.js"></script>
845+
<script src="/griffe2md/assets/javascripts/bundle.16f8adc2.min.js"></script>
846846

847847
<script src="/griffe2md/js/feedback.js"></script>
848848

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

assets/stylesheets/modern/main.1e989742.min.css

Lines changed: 0 additions & 1 deletion
This file was deleted.

assets/stylesheets/modern/main.28978c9b.min.css

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

changelog/index.html

Lines changed: 113 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626

2727
<link rel="icon" href="../assets/images/favicon.png">
28-
<meta name="generator" content="zensical-0.0.23">
28+
<meta name="generator" content="zensical-0.0.24">
2929

3030

3131

@@ -36,7 +36,7 @@
3636

3737

3838

39-
<link rel="stylesheet" href="../assets/stylesheets/modern/main.1e989742.min.css">
39+
<link rel="stylesheet" href="../assets/stylesheets/modern/main.28978c9b.min.css">
4040

4141

4242

@@ -505,6 +505,45 @@
505505
</label>
506506
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
507507

508+
<li class="md-nav__item">
509+
<a href="#140-2026-03-06" class="md-nav__link">
510+
<span class="md-ellipsis">
511+
512+
1.4.0 - 2026-03-06
513+
514+
</span>
515+
</a>
516+
517+
<nav class="md-nav" aria-label="1.4.0 - 2026-03-06">
518+
<ul class="md-nav__list">
519+
520+
<li class="md-nav__item">
521+
<a href="#features" class="md-nav__link">
522+
<span class="md-ellipsis">
523+
524+
Features
525+
526+
</span>
527+
</a>
528+
529+
</li>
530+
531+
<li class="md-nav__item">
532+
<a href="#code-refactoring" class="md-nav__link">
533+
<span class="md-ellipsis">
534+
535+
Code Refactoring
536+
537+
</span>
538+
</a>
539+
540+
</li>
541+
542+
</ul>
543+
</nav>
544+
545+
</li>
546+
508547
<li class="md-nav__item">
509548
<a href="#134-2026-02-20" class="md-nav__link">
510549
<span class="md-ellipsis">
@@ -630,7 +669,7 @@
630669
<ul class="md-nav__list">
631670

632671
<li class="md-nav__item">
633-
<a href="#features" class="md-nav__link">
672+
<a href="#features_1" class="md-nav__link">
634673
<span class="md-ellipsis">
635674

636675
Features
@@ -837,7 +876,7 @@
837876
<ul class="md-nav__list">
838877

839878
<li class="md-nav__item">
840-
<a href="#features_1" class="md-nav__link">
879+
<a href="#features_2" class="md-nav__link">
841880
<span class="md-ellipsis">
842881

843882
Features
@@ -848,7 +887,7 @@
848887
</li>
849888

850889
<li class="md-nav__item">
851-
<a href="#code-refactoring" class="md-nav__link">
890+
<a href="#code-refactoring_1" class="md-nav__link">
852891
<span class="md-ellipsis">
853892

854893
Code Refactoring
@@ -887,7 +926,7 @@
887926
</li>
888927

889928
<li class="md-nav__item">
890-
<a href="#features_2" class="md-nav__link">
929+
<a href="#features_3" class="md-nav__link">
891930
<span class="md-ellipsis">
892931

893932
Features
@@ -954,7 +993,7 @@
954993
</li>
955994

956995
<li class="md-nav__item">
957-
<a href="#code-refactoring_1" class="md-nav__link">
996+
<a href="#code-refactoring_2" class="md-nav__link">
958997
<span class="md-ellipsis">
959998

960999
Code Refactoring
@@ -993,7 +1032,7 @@
9931032
</li>
9941033

9951034
<li class="md-nav__item">
996-
<a href="#features_3" class="md-nav__link">
1035+
<a href="#features_4" class="md-nav__link">
9971036
<span class="md-ellipsis">
9981037

9991038
Features
@@ -1015,7 +1054,7 @@
10151054
</li>
10161055

10171056
<li class="md-nav__item">
1018-
<a href="#code-refactoring_2" class="md-nav__link">
1057+
<a href="#code-refactoring_3" class="md-nav__link">
10191058
<span class="md-ellipsis">
10201059

10211060
Code Refactoring
@@ -1304,6 +1343,45 @@
13041343
</label>
13051344
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
13061345

1346+
<li class="md-nav__item">
1347+
<a href="#140-2026-03-06" class="md-nav__link">
1348+
<span class="md-ellipsis">
1349+
1350+
1.4.0 - 2026-03-06
1351+
1352+
</span>
1353+
</a>
1354+
1355+
<nav class="md-nav" aria-label="1.4.0 - 2026-03-06">
1356+
<ul class="md-nav__list">
1357+
1358+
<li class="md-nav__item">
1359+
<a href="#features" class="md-nav__link">
1360+
<span class="md-ellipsis">
1361+
1362+
Features
1363+
1364+
</span>
1365+
</a>
1366+
1367+
</li>
1368+
1369+
<li class="md-nav__item">
1370+
<a href="#code-refactoring" class="md-nav__link">
1371+
<span class="md-ellipsis">
1372+
1373+
Code Refactoring
1374+
1375+
</span>
1376+
</a>
1377+
1378+
</li>
1379+
1380+
</ul>
1381+
</nav>
1382+
1383+
</li>
1384+
13071385
<li class="md-nav__item">
13081386
<a href="#134-2026-02-20" class="md-nav__link">
13091387
<span class="md-ellipsis">
@@ -1429,7 +1507,7 @@
14291507
<ul class="md-nav__list">
14301508

14311509
<li class="md-nav__item">
1432-
<a href="#features" class="md-nav__link">
1510+
<a href="#features_1" class="md-nav__link">
14331511
<span class="md-ellipsis">
14341512

14351513
Features
@@ -1636,7 +1714,7 @@
16361714
<ul class="md-nav__list">
16371715

16381716
<li class="md-nav__item">
1639-
<a href="#features_1" class="md-nav__link">
1717+
<a href="#features_2" class="md-nav__link">
16401718
<span class="md-ellipsis">
16411719

16421720
Features
@@ -1647,7 +1725,7 @@
16471725
</li>
16481726

16491727
<li class="md-nav__item">
1650-
<a href="#code-refactoring" class="md-nav__link">
1728+
<a href="#code-refactoring_1" class="md-nav__link">
16511729
<span class="md-ellipsis">
16521730

16531731
Code Refactoring
@@ -1686,7 +1764,7 @@
16861764
</li>
16871765

16881766
<li class="md-nav__item">
1689-
<a href="#features_2" class="md-nav__link">
1767+
<a href="#features_3" class="md-nav__link">
16901768
<span class="md-ellipsis">
16911769

16921770
Features
@@ -1753,7 +1831,7 @@
17531831
</li>
17541832

17551833
<li class="md-nav__item">
1756-
<a href="#code-refactoring_1" class="md-nav__link">
1834+
<a href="#code-refactoring_2" class="md-nav__link">
17571835
<span class="md-ellipsis">
17581836

17591837
Code Refactoring
@@ -1792,7 +1870,7 @@
17921870
</li>
17931871

17941872
<li class="md-nav__item">
1795-
<a href="#features_3" class="md-nav__link">
1873+
<a href="#features_4" class="md-nav__link">
17961874
<span class="md-ellipsis">
17971875

17981876
Features
@@ -1814,7 +1892,7 @@
18141892
</li>
18151893

18161894
<li class="md-nav__item">
1817-
<a href="#code-refactoring_2" class="md-nav__link">
1895+
<a href="#code-refactoring_3" class="md-nav__link">
18181896
<span class="md-ellipsis">
18191897

18201898
Code Refactoring
@@ -1913,6 +1991,17 @@ <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Perma
19131991
<p>The format is based on <a href="http://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>
19141992
and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
19151993
<!-- insertion marker -->
1994+
<h2 id="140-2026-03-06"><a href="https://github.com/mkdocstrings/griffe2md/releases/tag/1.4.0">1.4.0</a> - 2026-03-06<a class="headerlink" href="#140-2026-03-06" title="Permanent link">¤</a></h2>
1995+
<p><small><a href="https://github.com/mkdocstrings/griffe2md/compare/1.3.4...1.4.0">Compare with 1.3.4</a></small></p>
1996+
<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
1997+
<ul>
1998+
<li>Improve spacing in templates directly (<a href="https://github.com/mkdocstrings/griffe2md/commit/58e7126435573b18b040a2f22c71d29d99126c38">58e7126</a> by Timothée Mazzucotelli). <a href="https://github.com/mkdocstrings/griffe2md/issues/19">Issue-19</a></li>
1999+
</ul>
2000+
<h3 id="code-refactoring">Code Refactoring<a class="headerlink" href="#code-refactoring" title="Permanent link">¤</a></h3>
2001+
<ul>
2002+
<li>Don't format code with mdformat by default (<a href="https://github.com/mkdocstrings/griffe2md/commit/6b8928f00119c4b149e597690fe03f2e053ce077">6b8928f</a> by Timothée Mazzucotelli). <a href="https://github.com/mkdocstrings/griffe2md/issues/19">Issue-19</a></li>
2003+
<li>Mark configuration typed dict as non-total (<a href="https://github.com/mkdocstrings/griffe2md/commit/3636cab3bd6546482b11393b29c2cb8445dd7a7f">3636cab</a> by Timothée Mazzucotelli).</li>
2004+
</ul>
19162005
<h2 id="134-2026-02-20"><a href="https://github.com/mkdocstrings/griffe2md/releases/tag/1.3.4">1.3.4</a> - 2026-02-20<a class="headerlink" href="#134-2026-02-20" title="Permanent link">¤</a></h2>
19172006
<p><small><a href="https://github.com/mkdocstrings/griffe2md/compare/1.3.3...1.3.4">Compare with 1.3.3</a></small></p>
19182007
<h3 id="build">Build<a class="headerlink" href="#build" title="Permanent link">¤</a></h3>
@@ -1940,7 +2029,7 @@ <h3 id="bug-fixes_2">Bug Fixes<a class="headerlink" href="#bug-fixes_2" title="P
19402029
</ul>
19412030
<h2 id="130-2025-11-20"><a href="https://github.com/mkdocstrings/griffe2md/releases/tag/1.3.0">1.3.0</a> - 2025-11-20<a class="headerlink" href="#130-2025-11-20" title="Permanent link">¤</a></h2>
19422031
<p><small><a href="https://github.com/mkdocstrings/griffe2md/compare/1.2.6...1.3.0">Compare with 1.2.6</a></small></p>
1943-
<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
2032+
<h3 id="features_1">Features<a class="headerlink" href="#features_1" title="Permanent link">¤</a></h3>
19442033
<ul>
19452034
<li>Add parameter to prevent formatting Markdown with mdformat (<a href="https://github.com/mkdocstrings/griffe2md/commit/8cfd626ee995d4764d876d5300ad5486a4ab09e2">8cfd626</a> by Timothée Mazzucotelli). <a href="https://github.com/mkdocstrings/griffe2md/issues/18">Issue-18</a></li>
19462035
</ul>
@@ -1988,11 +2077,11 @@ <h3 id="build_2">Build<a class="headerlink" href="#build_2" title="Permanent lin
19882077
</ul>
19892078
<h2 id="120-2025-08-19"><a href="https://github.com/mkdocstrings/griffe2md/releases/tag/1.2.0">1.2.0</a> - 2025-08-19<a class="headerlink" href="#120-2025-08-19" title="Permanent link">¤</a></h2>
19902079
<p><small><a href="https://github.com/mkdocstrings/griffe2md/compare/1.1.0...1.2.0">Compare with 1.1.0</a></small></p>
1991-
<h3 id="features_1">Features<a class="headerlink" href="#features_1" title="Permanent link">¤</a></h3>
2080+
<h3 id="features_2">Features<a class="headerlink" href="#features_2" title="Permanent link">¤</a></h3>
19922081
<ul>
19932082
<li>Read config from config file or pyproject.toml (<a href="https://github.com/mkdocstrings/griffe2md/commit/c29e4834746859315b0ecc0633b091f80fc1c479">c29e483</a> by Rafal Krupinski). <a href="https://github.com/mkdocstrings/griffe2md/discussions/8">Issue-8</a>, <a href="https://github.com/mkdocstrings/griffe2md/pull/10">PR-10</a></li>
19942083
</ul>
1995-
<h3 id="code-refactoring">Code Refactoring<a class="headerlink" href="#code-refactoring" title="Permanent link">¤</a></h3>
2084+
<h3 id="code-refactoring_1">Code Refactoring<a class="headerlink" href="#code-refactoring_1" title="Permanent link">¤</a></h3>
19962085
<ul>
19972086
<li>Move modules under internal folder, re-expose API from top-level (<a href="https://github.com/mkdocstrings/griffe2md/commit/151a6efe1567bea4d334f4980af03b9bee3b277c">151a6ef</a> by Timothée Mazzucotelli).</li>
19982087
</ul>
@@ -2002,7 +2091,7 @@ <h3 id="build_3">Build<a class="headerlink" href="#build_3" title="Permanent lin
20022091
<ul>
20032092
<li>Drop support for Python 3.8 (<a href="https://github.com/mkdocstrings/griffe2md/commit/823936beb2bdf8eaf9e6724a16079c71aaf11d42">823936b</a> by Timothée Mazzucotelli).</li>
20042093
</ul>
2005-
<h3 id="features_2">Features<a class="headerlink" href="#features_2" title="Permanent link">¤</a></h3>
2094+
<h3 id="features_3">Features<a class="headerlink" href="#features_3" title="Permanent link">¤</a></h3>
20062095
<ul>
20072096
<li>Allow passing partial configuration to relevant functions (<a href="https://github.com/mkdocstrings/griffe2md/commit/4f7682ec0952b93b2d08b6513075e2bee13f37c6">4f7682e</a> by Timothée Mazzucotelli).</li>
20082097
</ul>
@@ -2018,7 +2107,7 @@ <h3 id="build_4">Build<a class="headerlink" href="#build_4" title="Permanent lin
20182107
<ul>
20192108
<li>Depend on Griffe 0.49 (<a href="https://github.com/mkdocstrings/griffe2md/commit/e7fef8732f2ffb52706967b9fa828261aedf9380">e7fef87</a> by Timothée Mazzucotelli).</li>
20202109
</ul>
2021-
<h3 id="code-refactoring_1">Code Refactoring<a class="headerlink" href="#code-refactoring_1" title="Permanent link">¤</a></h3>
2110+
<h3 id="code-refactoring_2">Code Refactoring<a class="headerlink" href="#code-refactoring_2" title="Permanent link">¤</a></h3>
20222111
<ul>
20232112
<li>Update code for Griffe 0.49 (<a href="https://github.com/mkdocstrings/griffe2md/commit/b321b3980e5ee2524c8f2db95c19ba897ad658b9">b321b39</a> by Timothée Mazzucotelli).</li>
20242113
</ul>
@@ -2028,7 +2117,7 @@ <h3 id="dependencies">Dependencies<a class="headerlink" href="#dependencies" tit
20282117
<ul>
20292118
<li>Bump required Griffe version to 0.36 (<a href="https://github.com/mkdocstrings/griffe2md/commit/7fd172e92160154d0ecae8a94264bd5d31553510">7fd172e</a> by Timothée Mazzucotelli).</li>
20302119
</ul>
2031-
<h3 id="features_3">Features<a class="headerlink" href="#features_3" title="Permanent link">¤</a></h3>
2120+
<h3 id="features_4">Features<a class="headerlink" href="#features_4" title="Permanent link">¤</a></h3>
20322121
<ul>
20332122
<li>Resolve external aliases pointing to objects in corresponding private packages (<code>ast.AST</code> -&gt; <code>_ast.AST</code>) (<a href="https://github.com/mkdocstrings/griffe2md/commit/5630fdf20606534c49eea1d2a31f6cc7f5945d60">5630fdf</a> by Timothée Mazzucotelli).</li>
20342123
<li>Support latest Griffe, add auto-summaries and cross-references (<a href="https://github.com/mkdocstrings/griffe2md/commit/e744fac35a2dc13126fada91c35f50158c43938f">e744fac</a> by Timothée Mazzucotelli).</li>
@@ -2042,7 +2131,7 @@ <h3 id="bug-fixes_9">Bug Fixes<a class="headerlink" href="#bug-fixes_9" title="P
20422131
<li>Don't import stuff from mkdocstrings (<a href="https://github.com/mkdocstrings/griffe2md/commit/1108a3f3eb324009a23d9598ba67053bcb93ec90">1108a3f</a> by Timothée Mazzucotelli).</li>
20432132
<li>Add missing jinja2 dependency (<a href="https://github.com/mkdocstrings/griffe2md/commit/4b9067ba2df89a3470f2cab9ddad673191efac47">4b9067b</a> by Timothée Mazzucotelli).</li>
20442133
</ul>
2045-
<h3 id="code-refactoring_2">Code Refactoring<a class="headerlink" href="#code-refactoring_2" title="Permanent link">¤</a></h3>
2134+
<h3 id="code-refactoring_3">Code Refactoring<a class="headerlink" href="#code-refactoring_3" title="Permanent link">¤</a></h3>
20462135
<ul>
20472136
<li>Never use full path in separate signatures (<a href="https://github.com/mkdocstrings/griffe2md/commit/ddfeac4b169acb86fdf128c233fe9c324d94d919">ddfeac4</a> by Timothée Mazzucotelli).</li>
20482137
<li>Use <code>html_links</code> option, stop using Textual click links (<a href="https://github.com/mkdocstrings/griffe2md/commit/f916d90c844e6e41304db4ca62418cc345af2a74">f916d90</a> by Timothée Mazzucotelli).</li>
@@ -2327,7 +2416,7 @@ <h2 id="__comments">Feedback</h2>
23272416
<script id="__config" type="application/json">{"annotate":null,"base":"..","features":["announce.dismiss","content.action.edit","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.tabs.sticky","navigation.top","search.highlight","toc.follow"],"search":"../assets/javascripts/workers/search.e2d2d235.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":null}</script>
23282417

23292418

2330-
<script src="../assets/javascripts/bundle.5fcf0de6.min.js"></script>
2419+
<script src="../assets/javascripts/bundle.16f8adc2.min.js"></script>
23312420

23322421
<script src="../js/feedback.js"></script>
23332422

code_of_conduct/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525

2626

2727
<link rel="icon" href="../assets/images/favicon.png">
28-
<meta name="generator" content="zensical-0.0.23">
28+
<meta name="generator" content="zensical-0.0.24">
2929

3030

3131

@@ -36,7 +36,7 @@
3636

3737

3838

39-
<link rel="stylesheet" href="../assets/stylesheets/modern/main.1e989742.min.css">
39+
<link rel="stylesheet" href="../assets/stylesheets/modern/main.28978c9b.min.css">
4040

4141

4242

@@ -1439,7 +1439,7 @@ <h2 id="__comments">Feedback</h2>
14391439
<script id="__config" type="application/json">{"annotate":null,"base":"..","features":["announce.dismiss","content.action.edit","content.action.view","content.code.annotate","content.code.copy","content.code.select","content.footnote.tooltips","content.tabs.link","content.tooltips","navigation.footer","navigation.indexes","navigation.instant","navigation.instant.prefetch","navigation.path","navigation.sections","navigation.tabs","navigation.tabs.sticky","navigation.top","search.highlight","toc.follow"],"search":"../assets/javascripts/workers/search.e2d2d235.min.js","tags":null,"translations":{"clipboard.copied":"Copied to clipboard","clipboard.copy":"Copy to clipboard","search.result.more.one":"1 more on this page","search.result.more.other":"# more on this page","search.result.none":"No matching documents","search.result.one":"1 matching document","search.result.other":"# matching documents","search.result.placeholder":"Type to start searching","search.result.term.missing":"Missing","select.version":"Select version"},"version":null}</script>
14401440

14411441

1442-
<script src="../assets/javascripts/bundle.5fcf0de6.min.js"></script>
1442+
<script src="../assets/javascripts/bundle.16f8adc2.min.js"></script>
14431443

14441444
<script src="../js/feedback.js"></script>
14451445

0 commit comments

Comments
 (0)