Deployed 37052c5 with MkDocs version: 1.1

Author: pawamoy

changelog/index.html

@@ -371,6 +371,20 @@
 <label class="md-nav__title" for="__toc">Table of contents</label>
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item">
+<a class="md-nav__link" href="#v021-2020-04-07">
+    v0.2.1 - 2020-04-07
+  </a>
+<nav class="md-nav">
+<ul class="md-nav__list">
+<li class="md-nav__item">
+<a class="md-nav__link" href="#bug-fixes">
+    Bug Fixes
+  </a>
+</li>
+</ul>
+</nav>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#v020-2020-03-27">
     v0.2.0 - 2020-03-27
   </a>
@@ -451,6 +465,20 @@
 <label class="md-nav__title" for="__toc">Table of contents</label>
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item">
+<a class="md-nav__link" href="#v021-2020-04-07">
+    v0.2.1 - 2020-04-07
+  </a>
+<nav class="md-nav">
+<ul class="md-nav__list">
+<li class="md-nav__item">
+<a class="md-nav__link" href="#bug-fixes">
+    Bug Fixes
+  </a>
+</li>
+</ul>
+</nav>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#v020-2020-03-27">
     v0.2.0 - 2020-03-27
   </a>
@@ -523,6 +551,13 @@ <h1 id="changelog">Changelog</h1>
 <p>All notable changes to this project will be documented in this file.</p>
 <p>The format is based on <a href="http://keepachangelog.com/en/1.0.0/">Keep a Changelog</a>
 and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
+<h2 id="v021-2020-04-07"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/v0.2.1">v0.2.1</a> - 2020-04-07</h2>
+<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.2.0...v0.2.1">Compare with v0.2.0</a></small></p>
+<h3 id="bug-fixes">Bug Fixes</h3>
+<ul>
+<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>
+<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>
+</ul>
 <h2 id="v020-2020-03-27"><a href="https://github.com/pawamoy/py-tkdocs/releases/tag/v0.2.0">v0.2.0</a> - 2020-03-27</h2>
 <p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.1.2...V0.2.0">Compare with v0.1.2</a></small></p>
 <h3 id="added">Added</h3>

developers/test_suite/__init__/index.html

@@ -37,9 +37,6 @@
 <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
 <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-<a class="md-skip" href="#tests.__init__" tabindex="0">
-        Skip to content
-      </a>
 <header class="md-header" data-md-component="header">
 <nav class="md-header-nav md-grid">
 <div class="md-flex">
@@ -239,37 +236,9 @@
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item md-nav__item--active">
 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
-<label class="md-nav__link md-nav__link--active" for="__toc">
-        __init__.py
-      </label>
 <a class="md-nav__link md-nav__link--active" href="./" title="__init__.py">
       __init__.py
     </a>
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__">
-    tests.__init__
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.FIXTURES_DIR">
-    FIXTURES_DIR
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.TESTS_DIR">
-    TESTS_DIR
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.TMP_DIR">
-    TMP_DIR
-  </a>
-</li>
-</ul>
-</nav>
 </li>
 <li class="md-nav__item">
 <a class="md-nav__link" href="../conftest/" title="conftest.py">
@@ -403,77 +372,10 @@
 </div>
 </div>
 </div>
-<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-<div class="md-sidebar__scrollwrap">
-<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__">
-    tests.__init__
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.FIXTURES_DIR">
-    FIXTURES_DIR
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.TESTS_DIR">
-    TESTS_DIR
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.__init__.TMP_DIR">
-    TMP_DIR
-  </a>
-</li>
-</ul>
-</nav>
-</div>
-</div>
-</div>
 <div class="md-content">
 <article class="md-content__inner md-typeset">
 <a class="md-icon md-content__icon" href="https://github.com/pawamoy/pytkdocs/edit/master/docs/developers/test_suite/__init__.md" title="Edit this page"></a>
 <h1>__init__.py</h1>
-<div class="doc doc-object doc-module">
-<h6 class="hidden-toc" href="#tests.__init__" id="tests.__init__" style="visibility: hidden; width: 0; height: 0;">
-</h6>
-<div class="doc doc-contents first">
-<p>In this module we simply define some path constants.</p>
-<div class="doc doc-children">
-<div class="doc doc-object doc-attribute">
-<h2 class="doc doc-heading" id="tests.__init__.FIXTURES_DIR">
-<code class="highlight">
-FIXTURES_DIR: <span class="n">Path</span> </code>
-</h2>
-<div class="doc doc-contents">
-<p>The tests/fixtures directory path object.</p>
-</div>
-</div>
-<div class="doc doc-object doc-attribute">
-<h2 class="doc doc-heading" id="tests.__init__.TESTS_DIR">
-<code class="highlight">
-TESTS_DIR: <span class="n">Path</span> </code>
-</h2>
-<div class="doc doc-contents">
-<p>The tests directory path object.</p>
-</div>
-</div>
-<div class="doc doc-object doc-attribute">
-<h2 class="doc doc-heading" id="tests.__init__.TMP_DIR">
-<code class="highlight">
-TMP_DIR: <span class="n">Path</span> </code>
-</h2>
-<div class="doc doc-contents">
-<p>The tests/tmp directory path object.</p>
-</div>
-</div>
-</div>
-</div>
-</div>
 </article>
 </div>
 </div>

developers/test_suite/conftest/index.html

@@ -37,9 +37,6 @@
 <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
 <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-<a class="md-skip" href="#tests.conftest" tabindex="0">
-        Skip to content
-      </a>
 <header class="md-header" data-md-component="header">
 <nav class="md-header-nav md-grid">
 <div class="md-flex">
@@ -244,27 +241,9 @@
 </li>
 <li class="md-nav__item md-nav__item--active">
 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
-<label class="md-nav__link md-nav__link--active" for="__toc">
-        conftest.py
-      </label>
 <a class="md-nav__link md-nav__link--active" href="./" title="conftest.py">
       conftest.py
     </a>
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.conftest">
-    tests.conftest
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.conftest.pytest_itemcollected">
-    pytest_itemcollected()
-  </a>
-</li>
-</ul>
-</nav>
 </li>
 <li class="md-nav__item md-nav__item--nested">
 <input class="md-toggle md-nav__toggle" data-md-toggle="nav-4-1-3" id="nav-4-1-3" type="checkbox"/>
@@ -393,93 +372,10 @@
 </div>
 </div>
 </div>
-<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-<div class="md-sidebar__scrollwrap">
-<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.conftest">
-    tests.conftest
-  </a>
-</li>
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.conftest.pytest_itemcollected">
-    pytest_itemcollected()
-  </a>
-</li>
-</ul>
-</nav>
-</div>
-</div>
-</div>
 <div class="md-content">
 <article class="md-content__inner md-typeset">
 <a class="md-icon md-content__icon" href="https://github.com/pawamoy/pytkdocs/edit/master/docs/developers/test_suite/conftest.md" title="Edit this page"></a>
 <h1>conftest.py</h1>
-<div class="doc doc-object doc-module">
-<h6 class="hidden-toc" href="#tests.conftest" id="tests.conftest" style="visibility: hidden; width: 0; height: 0;">
-</h6>
-<div class="doc doc-contents first">
-<p>Configuration for pytest.</p>
-<div class="doc doc-children">
-<div class="doc doc-object doc-function">
-<h2 class="doc doc-heading" id="tests.conftest.pytest_itemcollected">
-<code class="highlight language-python">
-pytest_itemcollected<span class="p">(</span><span class="n">item</span><span class="p">)</span> </code>
-</h2>
-<div class="doc doc-contents">
-<p>Make tests names more readable in the tests output.</p>
-<details class="quote">
-<summary>Source code in <code>tests/conftest.py</code></summary>
-<table class="highlighttable">
-<tr>
-<td class="linenos">
-<div class="linenodiv">
-<pre><span></span> 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-13
-14
-15
-16
-17</pre>
-</div>
-</td>
-<td class="code">
-<div class="highlight">
-<pre><span></span><code><span class="k">def</span> <span class="nf">pytest_itemcollected</span><span class="p">(</span><span class="n">item</span><span class="p">):</span>
-    <span class="sd">"""Make tests names more readable in the tests output."""</span>
-    <span class="n">item</span><span class="o">.</span><span class="n">_nodeid</span> <span class="o">=</span> <span class="p">(</span>
-        <span class="n">item</span><span class="o">.</span><span class="n">_nodeid</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">".py"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"tests/"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"test_"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"_"</span><span class="p">,</span> <span class="s2">" "</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"Test"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"Class"</span><span class="p">,</span> <span class="s2">" class"</span><span class="p">)</span>
-        <span class="o">.</span><span class="n">lower</span><span class="p">()</span>
-    <span class="p">)</span>
-    <span class="n">doc</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">obj</span><span class="o">.</span><span class="vm">__doc__</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">obj</span><span class="o">.</span><span class="vm">__doc__</span> <span class="k">else</span> <span class="s2">""</span>
-    <span class="k">if</span> <span class="n">doc</span><span class="p">:</span>
-        <span class="n">item</span><span class="o">.</span><span class="n">_nodeid</span> <span class="o">=</span> <span class="n">item</span><span class="o">.</span><span class="n">_nodeid</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"::"</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> <span class="o">+</span> <span class="s2">"::"</span> <span class="o">+</span> <span class="n">doc</span>
-</code></pre>
-</div>
-</td>
-</tr>
-</table>
-</details>
-</div>
-</div>
-</div>
-</div>
-</div>
 </article>
 </div>
 </div>

developers/test_suite/fixtures/inheriting_enum_Enum/index.html

@@ -37,9 +37,6 @@
 <input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/>
 <input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/>
 <label class="md-overlay" data-md-component="overlay" for="__drawer"></label>
-<a class="md-skip" href="#tests.fixtures.inheriting_enum_Enum" tabindex="0">
-        Skip to content
-      </a>
 <header class="md-header" data-md-component="header">
 <nav class="md-header-nav md-grid">
 <div class="md-flex">
@@ -259,22 +256,9 @@
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item md-nav__item--active">
 <input class="md-toggle md-nav__toggle" data-md-toggle="toc" id="__toc" type="checkbox"/>
-<label class="md-nav__link md-nav__link--active" for="__toc">
-        inheriting_enum_Enum.py
-      </label>
 <a class="md-nav__link md-nav__link--active" href="./" title="inheriting_enum_Enum.py">
       inheriting_enum_Enum.py
     </a>
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.fixtures.inheriting_enum_Enum">
-    tests.fixtures.inheriting_enum_Enum
-  </a>
-</li>
-</ul>
-</nav>
 </li>
 <li class="md-nav__item">
 <a class="md-nav__link" href="../inheriting_typing_NamedTuple/" title="inheriting_typing_NamedTuple.py">
@@ -388,46 +372,10 @@
 </div>
 </div>
 </div>
-<div class="md-sidebar md-sidebar--secondary" data-md-component="toc">
-<div class="md-sidebar__scrollwrap">
-<div class="md-sidebar__inner">
-<nav class="md-nav md-nav--secondary">
-<label class="md-nav__title" for="__toc">Table of contents</label>
-<ul class="md-nav__list" data-md-scrollfix="">
-<li class="md-nav__item">
-<a class="md-nav__link" href="#tests.fixtures.inheriting_enum_Enum">
-    tests.fixtures.inheriting_enum_Enum
-  </a>
-</li>
-</ul>
-</nav>
-</div>
-</div>
-</div>
 <div class="md-content">
 <article class="md-content__inner md-typeset">
 <a class="md-icon md-content__icon" href="https://github.com/pawamoy/pytkdocs/edit/master/docs/developers/test_suite/fixtures/inheriting_enum_Enum.md" title="Edit this page"></a>
 <h1>inheriting_enum_Enum.py</h1>
-<div class="doc doc-object doc-module">
-<h6 class="hidden-toc" href="#tests.fixtures.inheriting_enum_Enum" id="tests.fixtures.inheriting_enum_Enum" style="visibility: hidden; width: 0; height: 0;">
-</h6>
-<div class="doc doc-contents first">
-<p>While recursing on a class inheriting from <code>enum.Enum</code>, the class' <code>__dict__</code> returns private items
-whose values are the <code>object</code> builtin for example.</p>
-<p>The <code>object</code> builtin is a class, so <code>pytkdocs</code> is trying to recurse on it,
-and tries to get its file path by first getting its module.</p>
-<p>The <code>object</code> class' module is <code>builtins</code>, which does not have a <code>__file__</code> attribute,
-so trying to access it generates an <code>AttributeError</code> error.</p>
-<p>Instead of failing, we simply catch the error and set <code>file_path = ""</code>.</p>
-<p>References:</p>
-<ul>
-<li>Test case: <a href="https://pawamoy.github.io/pytkdocs/developers/test_suite/test_loader/#tests.test_loader.test_inheriting_enum_Enum">tests.test_loader.test_inheriting_enum_Enum</a>.</li>
-<li>Issue reported on commit <a href="https://github.com/pawamoy/mkdocstrings/commit/5053f8142913f01358481e4801e5222d88482c35">5053f81</a>.</li>
-<li>Fixed by commit <a href="https://github.com/pawamoy/pytkdocs/commit/48df6bc9cf878f3ce281fac6ccaf8fe1d4e89c84">48df6bc</a>.</li>
-<li>See other "inheriting" test cases.</li>
-</ul>
-</div>
-</div>
 </article>
 </div>
 </div>