Skip to content

Commit f0d67fc

Browse files
pawamoypawamoy
committed
Deployed 1371e40 with MkDocs version: 1.1.2
1 parent a6083be commit f0d67fc

6 files changed

Lines changed: 102 additions & 46 deletions

File tree

‎changelog/index.html‎

Lines changed: 73 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -481,6 +481,26 @@
481481
</label>
482482
<ul class="md-nav__list" data-md-scrollfix>
483483

484+
<li class="md-nav__item">
485+
<a href="#0101-2021-01-03" class="md-nav__link">
486+
0.10.1 - 2021-01-03
487+
</a>
488+
489+
<nav class="md-nav" aria-label="0.10.1 - 2021-01-03">
490+
<ul class="md-nav__list">
491+
492+
<li class="md-nav__item">
493+
<a href="#bug-fixes" class="md-nav__link">
494+
Bug Fixes
495+
</a>
496+
497+
</li>
498+
499+
</ul>
500+
</nav>
501+
502+
</li>
503+
484504
<li class="md-nav__item">
485505
<a href="#0100-2020-12-06" class="md-nav__link">
486506
0.10.0 - 2020-12-06
@@ -490,7 +510,7 @@
490510
<ul class="md-nav__list">
491511

492512
<li class="md-nav__item">
493-
<a href="#bug-fixes" class="md-nav__link">
513+
<a href="#bug-fixes_1" class="md-nav__link">
494514
Bug Fixes
495515
</a>
496516

@@ -557,7 +577,7 @@
557577
<ul class="md-nav__list">
558578

559579
<li class="md-nav__item">
560-
<a href="#bug-fixes_1" class="md-nav__link">
580+
<a href="#bug-fixes_2" class="md-nav__link">
561581
Bug Fixes
562582
</a>
563583

@@ -604,7 +624,7 @@
604624
<ul class="md-nav__list">
605625

606626
<li class="md-nav__item">
607-
<a href="#bug-fixes_2" class="md-nav__link">
627+
<a href="#bug-fixes_3" class="md-nav__link">
608628
Bug Fixes
609629
</a>
610630

@@ -624,7 +644,7 @@
624644
<ul class="md-nav__list">
625645

626646
<li class="md-nav__item">
627-
<a href="#bug-fixes_3" class="md-nav__link">
647+
<a href="#bug-fixes_4" class="md-nav__link">
628648
Bug Fixes
629649
</a>
630650

@@ -644,7 +664,7 @@
644664
<ul class="md-nav__list">
645665

646666
<li class="md-nav__item">
647-
<a href="#bug-fixes_4" class="md-nav__link">
667+
<a href="#bug-fixes_5" class="md-nav__link">
648668
Bug Fixes
649669
</a>
650670

@@ -678,7 +698,7 @@
678698
<ul class="md-nav__list">
679699

680700
<li class="md-nav__item">
681-
<a href="#bug-fixes_5" class="md-nav__link">
701+
<a href="#bug-fixes_6" class="md-nav__link">
682702
Bug Fixes
683703
</a>
684704

@@ -712,7 +732,7 @@
712732
<ul class="md-nav__list">
713733

714734
<li class="md-nav__item">
715-
<a href="#bug-fixes_6" class="md-nav__link">
735+
<a href="#bug-fixes_7" class="md-nav__link">
716736
Bug Fixes
717737
</a>
718738

@@ -739,7 +759,7 @@
739759
<ul class="md-nav__list">
740760

741761
<li class="md-nav__item">
742-
<a href="#bug-fixes_7" class="md-nav__link">
762+
<a href="#bug-fixes_8" class="md-nav__link">
743763
Bug Fixes
744764
</a>
745765

@@ -879,6 +899,26 @@
879899
</label>
880900
<ul class="md-nav__list" data-md-scrollfix>
881901

902+
<li class="md-nav__item">
903+
<a href="#0101-2021-01-03" class="md-nav__link">
904+
0.10.1 - 2021-01-03
905+
</a>
906+
907+
<nav class="md-nav" aria-label="0.10.1 - 2021-01-03">
908+
<ul class="md-nav__list">
909+
910+
<li class="md-nav__item">
911+
<a href="#bug-fixes" class="md-nav__link">
912+
Bug Fixes
913+
</a>
914+
915+
</li>
916+
917+
</ul>
918+
</nav>
919+
920+
</li>
921+
882922
<li class="md-nav__item">
883923
<a href="#0100-2020-12-06" class="md-nav__link">
884924
0.10.0 - 2020-12-06
@@ -888,7 +928,7 @@
888928
<ul class="md-nav__list">
889929

890930
<li class="md-nav__item">
891-
<a href="#bug-fixes" class="md-nav__link">
931+
<a href="#bug-fixes_1" class="md-nav__link">
892932
Bug Fixes
893933
</a>
894934

@@ -955,7 +995,7 @@
955995
<ul class="md-nav__list">
956996

957997
<li class="md-nav__item">
958-
<a href="#bug-fixes_1" class="md-nav__link">
998+
<a href="#bug-fixes_2" class="md-nav__link">
959999
Bug Fixes
9601000
</a>
9611001

@@ -1002,7 +1042,7 @@
10021042
<ul class="md-nav__list">
10031043

10041044
<li class="md-nav__item">
1005-
<a href="#bug-fixes_2" class="md-nav__link">
1045+
<a href="#bug-fixes_3" class="md-nav__link">
10061046
Bug Fixes
10071047
</a>
10081048

@@ -1022,7 +1062,7 @@
10221062
<ul class="md-nav__list">
10231063

10241064
<li class="md-nav__item">
1025-
<a href="#bug-fixes_3" class="md-nav__link">
1065+
<a href="#bug-fixes_4" class="md-nav__link">
10261066
Bug Fixes
10271067
</a>
10281068

@@ -1042,7 +1082,7 @@
10421082
<ul class="md-nav__list">
10431083

10441084
<li class="md-nav__item">
1045-
<a href="#bug-fixes_4" class="md-nav__link">
1085+
<a href="#bug-fixes_5" class="md-nav__link">
10461086
Bug Fixes
10471087
</a>
10481088

@@ -1076,7 +1116,7 @@
10761116
<ul class="md-nav__list">
10771117

10781118
<li class="md-nav__item">
1079-
<a href="#bug-fixes_5" class="md-nav__link">
1119+
<a href="#bug-fixes_6" class="md-nav__link">
10801120
Bug Fixes
10811121
</a>
10821122

@@ -1110,7 +1150,7 @@
11101150
<ul class="md-nav__list">
11111151

11121152
<li class="md-nav__item">
1113-
<a href="#bug-fixes_6" class="md-nav__link">
1153+
<a href="#bug-fixes_7" class="md-nav__link">
11141154
Bug Fixes
11151155
</a>
11161156

@@ -1137,7 +1177,7 @@
11371177
<ul class="md-nav__list">
11381178

11391179
<li class="md-nav__item">
1140-
<a href="#bug-fixes_7" class="md-nav__link">
1180+
<a href="#bug-fixes_8" class="md-nav__link">
11411181
Bug Fixes
11421182
</a>
11431183

@@ -1260,9 +1300,18 @@ <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Perma
12601300
<p>The format is based on <a href="http://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>
12611301
and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
12621302
<!-- insertion marker -->
1303+
<h2 id="0101-2021-01-03"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.10.1">0.10.1</a> - 2021-01-03<a class="headerlink" href="#0101-2021-01-03" title="Permanent link">¤</a></h2>
1304+
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.10.0...0.10.1">Compare with 0.10.0</a></small></p>
1305+
<h3 id="bug-fixes">Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permanent link">¤</a></h3>
1306+
<ul>
1307+
<li>Warn when examples section is empty (<a href="https://github.com/pawamoy/pytkdocs/commit/e1d2dfc3a9bff690c9061892268fd480e83c6f91">e1d2dfc</a> by Timothée Mazzucotelli). <a href="https://github.com/pawamoy/pytkdocs/issues/194">Issue #194</a></li>
1308+
<li>Allow newer version of dataclasses backport (<a href="https://github.com/pawamoy/pytkdocs/commit/4392f2e4669c76bf2acf74b6124f74b7734b638b">4392f2e</a> by Patrick Lannigan).</li>
1309+
<li>Ignore errors parsing c-extension modules (<a href="https://github.com/pawamoy/pytkdocs/commit/19300544cb31f6ad6be5828d041022d7bf917668">1930054</a> by Wang Yuzhi).</li>
1310+
<li>Fix attribute parser for Python 3.9 (<a href="https://github.com/pawamoy/pytkdocs/commit/ae80e988edf362ce99a880063639e4cd74bc44bb">ae80e98</a> by Timothée Mazzucotelli). <a href="https://github.com/pawamoy/pytkdocs/issues/73">Issue #73</a> and <a href="https://github.com/pawamoy/pytkdocs/issues/75">#75</a></li>
1311+
</ul>
12631312
<h2 id="0100-2020-12-06"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.10.0">0.10.0</a> - 2020-12-06<a class="headerlink" href="#0100-2020-12-06" title="Permanent link">¤</a></h2>
12641313
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.9.0...0.10.0">Compare with 0.9.0</a></small></p>
1265-
<h3 id="bug-fixes">Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permanent link">¤</a></h3>
1314+
<h3 id="bug-fixes_1">Bug Fixes<a class="headerlink" href="#bug-fixes_1" title="Permanent link">¤</a></h3>
12661315
<ul>
12671316
<li>Avoid recursion if a class has a reference to itself (<a href="https://github.com/pawamoy/pytkdocs/commit/c92a7911ea9f6321614bb692960f5252f79f6320">c92a791</a> by Matthew Wardrop).</li>
12681317
</ul>
@@ -1286,7 +1335,7 @@ <h3 id="features_2">Features<a class="headerlink" href="#features_2" title="Perm
12861335
</ul>
12871336
<h2 id="070-2020-07-24"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.7.0">0.7.0</a> - 2020-07-24<a class="headerlink" href="#070-2020-07-24" title="Permanent link">¤</a></h2>
12881337
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.6.0...0.7.0">Compare with 0.6.0</a></small></p>
1289-
<h3 id="bug-fixes_1">Bug Fixes<a class="headerlink" href="#bug-fixes_1" title="Permanent link">¤</a></h3>
1338+
<h3 id="bug-fixes_2">Bug Fixes<a class="headerlink" href="#bug-fixes_2" title="Permanent link">¤</a></h3>
12901339
<ul>
12911340
<li>Fix code detecting dataclass fields (<a href="https://github.com/pawamoy/pytkdocs/commit/4c4a18b881865c3182eef77a95ef1a6b1f1a5b6d">4c4a18b</a> by Timothée Mazzucotelli).</li>
12921341
<li>Prevent crash in case of empty dataclasses (<a href="https://github.com/pawamoy/pytkdocs/commit/835c066ac47cdb1203dc3feb9dfc3f96df7109e0">835c066</a> by Jared Khan). PR <a href="https://github.com/pawamoy/pytkdocs/issues/56">#56</a></li>
@@ -1304,19 +1353,19 @@ <h3 id="features_4">Features<a class="headerlink" href="#features_4" title="Perm
13041353
</ul>
13051354
<h2 id="052-2020-06-11"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.5.2">0.5.2</a> - 2020-06-11<a class="headerlink" href="#052-2020-06-11" title="Permanent link">¤</a></h2>
13061355
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.5.1...0.5.2">Compare with 0.5.1</a></small></p>
1307-
<h3 id="bug-fixes_2">Bug Fixes<a class="headerlink" href="#bug-fixes_2" title="Permanent link">¤</a></h3>
1356+
<h3 id="bug-fixes_3">Bug Fixes<a class="headerlink" href="#bug-fixes_3" title="Permanent link">¤</a></h3>
13081357
<ul>
13091358
<li>Ignore exceptions when trying to unwrap (<a href="https://github.com/pawamoy/pytkdocs/commit/02ba8762716c416499bdd4d4834c5de35bca23cb">02ba876</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/45">#45</a></li>
13101359
</ul>
13111360
<h2 id="051-2020-06-09"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.5.1">0.5.1</a> - 2020-06-09<a class="headerlink" href="#051-2020-06-09" title="Permanent link">¤</a></h2>
13121361
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.5.0...0.5.1">Compare with 0.5.0</a></small></p>
1313-
<h3 id="bug-fixes_3">Bug Fixes<a class="headerlink" href="#bug-fixes_3" title="Permanent link">¤</a></h3>
1362+
<h3 id="bug-fixes_4">Bug Fixes<a class="headerlink" href="#bug-fixes_4" title="Permanent link">¤</a></h3>
13141363
<ul>
13151364
<li>Fix parsing tuple unpacking assignment (<a href="https://github.com/pawamoy/pytkdocs/commit/6535fe813b6c4b756d1d481f097208c52470da6a">6535fe8</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/43">#43</a></li>
13161365
</ul>
13171366
<h2 id="050-2020-06-08"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.5.0">0.5.0</a> - 2020-06-08<a class="headerlink" href="#050-2020-06-08" title="Permanent link">¤</a></h2>
13181367
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.4.0...0.5.0">Compare with 0.4.0</a></small></p>
1319-
<h3 id="bug-fixes_4">Bug Fixes<a class="headerlink" href="#bug-fixes_4" title="Permanent link">¤</a></h3>
1368+
<h3 id="bug-fixes_5">Bug Fixes<a class="headerlink" href="#bug-fixes_5" title="Permanent link">¤</a></h3>
13201369
<ul>
13211370
<li>Fix getting documentation for wrapped objects (<a href="https://github.com/pawamoy/pytkdocs/commit/09f38a501edde2963af50130c11ff38107d14367">09f38a5</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/32">#32</a></li>
13221371
<li>Dedent attributes docstrings (<a href="https://github.com/pawamoy/pytkdocs/commit/1a6809ce4358707b6b144a331955974e8891c475">1a6809c</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/42">#42</a></li>
@@ -1338,7 +1387,7 @@ <h3 id="features_5">Features<a class="headerlink" href="#features_5" title="Perm
13381387
</ul>
13391388
<h2 id="040-2020-05-17"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.4.0">0.4.0</a> - 2020-05-17<a class="headerlink" href="#040-2020-05-17" title="Permanent link">¤</a></h2>
13401389
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.3.0...0.4.0">Compare with 0.3.0</a></small></p>
1341-
<h3 id="bug-fixes_5">Bug Fixes<a class="headerlink" href="#bug-fixes_5" title="Permanent link">¤</a></h3>
1390+
<h3 id="bug-fixes_6">Bug Fixes<a class="headerlink" href="#bug-fixes_6" title="Permanent link">¤</a></h3>
13421391
<ul>
13431392
<li>Never attempt to parse a null docstring (<a href="https://github.com/pawamoy/pytkdocs/commit/aa926686c9f3b9922968387ec68e3a1caeee08a7">aa92668</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/37">#37</a></li>
13441393
<li>Restore stdout before printing a traceback (<a href="https://github.com/pawamoy/pytkdocs/commit/20c21e9fa8e5a08e113cbbec2da1af240eb6ce16">20c21e9</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/36">#36</a></li>
@@ -1356,7 +1405,7 @@ <h3 id="features_6">Features<a class="headerlink" href="#features_6" title="Perm
13561405
</ul>
13571406
<h2 id="030-2020-04-10"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.3.0">0.3.0</a> - 2020-04-10<a class="headerlink" href="#030-2020-04-10" title="Permanent link">¤</a></h2>
13581407
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.2.1...0.3.0">Compare with 0.2.1</a></small></p>
1359-
<h3 id="bug-fixes_6">Bug Fixes<a class="headerlink" href="#bug-fixes_6" title="Permanent link">¤</a></h3>
1408+
<h3 id="bug-fixes_7">Bug Fixes<a class="headerlink" href="#bug-fixes_7" title="Permanent link">¤</a></h3>
13601409
<ul>
13611410
<li>Fix parsing of <code>*args</code> and <code>**kwargs</code> (<a href="https://github.com/pawamoy/pytkdocs/commit/b81c93eef2435f2ed1d70b4d7c3946caa564c59e">b81c93e</a> by adrienhenry). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/20">#20</a>, <a href="https://github.com/pawamoy/pytkdocs/issues/21">#21</a></li>
13621411
</ul>
@@ -1366,7 +1415,7 @@ <h3 id="features_7">Features<a class="headerlink" href="#features_7" title="Perm
13661415
</ul>
13671416
<h2 id="021-2020-04-07"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.2.1">0.2.1</a> - 2020-04-07<a class="headerlink" href="#021-2020-04-07" title="Permanent link">¤</a></h2>
13681417
<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.2.0...0.2.1">Compare with 0.2.0</a></small></p>
1369-
<h3 id="bug-fixes_7">Bug Fixes<a class="headerlink" href="#bug-fixes_7" title="Permanent link">¤</a></h3>
1418+
<h3 id="bug-fixes_8">Bug Fixes<a class="headerlink" href="#bug-fixes_8" title="Permanent link">¤</a></h3>
13701419
<ul>
13711420
<li>Fix forward refs replacement for python &gt; 3.6 (<a href="https://github.com/pawamoy/pytkdocs/commit/6a90aca346209fe2a4e3eec6bfb45f353bce679f">6a90aca</a> by Timothée Mazzucotelli).</li>
13721421
<li>Handle exception parsing error (<a href="https://github.com/pawamoy/pytkdocs/commit/d6561f86362e7a9d8c45471f1d6eb5deffd5e0c8">d6561f8</a> by Timothée Mazzucotelli). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/16">#16</a></li>

‎reference/loader/index.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1740,8 +1740,11 @@ <h3 class="doc doc-heading" id="pytkdocs.loader.Loader.get_class_documentation">
17401740
<span class="n">merge</span><span class="p">(</span><span class="n">attributes_data</span><span class="p">,</span> <span class="n">get_class_attributes</span><span class="p">(</span><span class="n">parent_class</span><span class="p">))</span>
17411741
<span class="n">context</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"attributes"</span><span class="p">:</span> <span class="n">attributes_data</span><span class="p">}</span>
17421742
<span class="k">if</span> <span class="s2">"__init__"</span> <span class="ow">in</span> <span class="n">class_</span><span class="o">.</span><span class="vm">__dict__</span><span class="p">:</span>
1743-
<span class="n">attributes_data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">get_instance_attributes</span><span class="p">(</span><span class="n">class_</span><span class="o">.</span><span class="fm">__init__</span><span class="p">))</span>
1744-
<span class="n">context</span><span class="p">[</span><span class="s2">"signature"</span><span class="p">]</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">class_</span><span class="o">.</span><span class="fm">__init__</span><span class="p">)</span>
1743+
<span class="k">try</span><span class="p">:</span>
1744+
<span class="n">attributes_data</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">get_instance_attributes</span><span class="p">(</span><span class="n">class_</span><span class="o">.</span><span class="fm">__init__</span><span class="p">))</span>
1745+
<span class="n">context</span><span class="p">[</span><span class="s2">"signature"</span><span class="p">]</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">signature</span><span class="p">(</span><span class="n">class_</span><span class="o">.</span><span class="fm">__init__</span><span class="p">)</span>
1746+
<span class="k">except</span> <span class="p">(</span><span class="ne">TypeError</span><span class="p">,</span> <span class="ne">ValueError</span><span class="p">):</span>
1747+
<span class="k">pass</span>
17451748
<span class="n">root_object</span><span class="o">.</span><span class="n">parse_docstring</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">docstring_parser</span><span class="p">,</span> <span class="n">attributes</span><span class="o">=</span><span class="n">attributes_data</span><span class="p">)</span>
17461749

17471750
<span class="k">if</span> <span class="n">select_members</span> <span class="ow">is</span> <span class="kc">False</span><span class="p">:</span>
@@ -2240,7 +2243,7 @@ <h3 class="doc doc-heading" id="pytkdocs.loader.Loader.get_module_documentation"
22402243
<span class="k">except</span> <span class="ne">OSError</span> <span class="k">as</span> <span class="n">error</span><span class="p">:</span>
22412244
<span class="k">try</span><span class="p">:</span>
22422245
<span class="n">code</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">node</span><span class="o">.</span><span class="n">file_path</span><span class="p">)</span><span class="o">.</span><span class="n">read_text</span><span class="p">()</span>
2243-
<span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span>
2246+
<span class="k">except</span> <span class="p">(</span><span class="ne">OSError</span><span class="p">,</span> <span class="ne">UnicodeDecodeError</span><span class="p">):</span>
22442247
<span class="bp">self</span><span class="o">.</span><span class="n">errors</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Couldn't read source for '</span><span class="si">{</span><span class="n">path</span><span class="si">}</span><span class="s2">': </span><span class="si">{</span><span class="n">error</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
22452248
<span class="n">source</span> <span class="o">=</span> <span class="kc">None</span>
22462249
<span class="k">else</span><span class="p">:</span>

0 commit comments

Comments
 (0)