Deployed 50cd7e6 with MkDocs version: 1.1.2

Author: pawamoy

changelog/index.html

@@ -481,6 +481,26 @@
     </label>
     <ul class="md-nav__list" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#090-2020-09-28" class="md-nav__link">
+    0.9.0 - 2020-09-28
+  </a>
+  
+    <nav class="md-nav" aria-label="0.9.0 - 2020-09-28">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    Features
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#080-2020-09-25" class="md-nav__link">
     0.8.0 - 2020-09-25
@@ -490,7 +510,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
+  <a href="#features_1" class="md-nav__link">
     Features
   </a>
 
@@ -517,7 +537,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features_2" class="md-nav__link">
     Features
   </a>
 
@@ -537,7 +557,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features_2" class="md-nav__link">
+  <a href="#features_3" class="md-nav__link">
     Features
   </a>
 
@@ -611,7 +631,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_3" class="md-nav__link">
+  <a href="#features_4" class="md-nav__link">
     Features
   </a>
 
@@ -645,7 +665,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_4" class="md-nav__link">
+  <a href="#features_5" class="md-nav__link">
     Features
   </a>
 
@@ -672,7 +692,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_5" class="md-nav__link">
+  <a href="#features_6" class="md-nav__link">
     Features
   </a>
 
@@ -832,6 +852,26 @@
     </label>
     <ul class="md-nav__list" data-md-scrollfix>
 
+        <li class="md-nav__item">
+  <a href="#090-2020-09-28" class="md-nav__link">
+    0.9.0 - 2020-09-28
+  </a>
+  
+    <nav class="md-nav" aria-label="0.9.0 - 2020-09-28">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#features" class="md-nav__link">
+    Features
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
+</li>
+      
         <li class="md-nav__item">
   <a href="#080-2020-09-25" class="md-nav__link">
     0.8.0 - 2020-09-25
@@ -841,7 +881,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features" class="md-nav__link">
+  <a href="#features_1" class="md-nav__link">
     Features
   </a>
 
@@ -868,7 +908,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_1" class="md-nav__link">
+  <a href="#features_2" class="md-nav__link">
     Features
   </a>
 
@@ -888,7 +928,7 @@
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#features_2" class="md-nav__link">
+  <a href="#features_3" class="md-nav__link">
     Features
   </a>
 
@@ -962,7 +1002,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_3" class="md-nav__link">
+  <a href="#features_4" class="md-nav__link">
     Features
   </a>
 
@@ -996,7 +1036,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_4" class="md-nav__link">
+  <a href="#features_5" class="md-nav__link">
     Features
   </a>
 
@@ -1023,7 +1063,7 @@
 </li>
 
           <li class="md-nav__item">
-  <a href="#features_5" class="md-nav__link">
+  <a href="#features_6" class="md-nav__link">
     Features
   </a>
 
@@ -1167,9 +1207,17 @@ <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Perma
 and this project adheres to <a href="http://semver.org/spec/v2.0.0.html">Semantic Versioning</a>.</p>
 <!-- insertion marker -->
 
+<h2 id="090-2020-09-28"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.9.0">0.9.0</a> - 2020-09-28<a class="headerlink" href="#090-2020-09-28" title="Permanent link">¤</a></h2>
+<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.8.0...0.9.0">Compare with 0.8.0</a></small></p>
+<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
+<ul>
+<li>Add <code>new_path_syntax</code> option (<a href="https://github.com/pawamoy/pytkdocs/commit/a0b677c9bbe62f344dfda05b50d729c4d8e7c36a">a0b677c</a> by Timothée Mazzucotelli).
+  See: <a href="https://pawamoy.github.io/pytkdocs/#details-on-new_path_syntax">"Details on <code>new_path_syntax</code>"</a> in the documentation.
+  Issue <a href="https://github.com/pawamoy/pytkdocs/issues/66">#66</a>.</li>
+</ul>
 <h2 id="080-2020-09-25"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.8.0">0.8.0</a> - 2020-09-25<a class="headerlink" href="#080-2020-09-25" title="Permanent link">¤</a></h2>
 <p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.7.0...0.8.0">Compare with 0.7.0</a></small></p>
-<h3 id="features">Features<a class="headerlink" href="#features" title="Permanent link">¤</a></h3>
+<h3 id="features_1">Features<a class="headerlink" href="#features_1" title="Permanent link">¤</a></h3>
 <ul>
 <li>Add async property for coroutine functions (<a href="https://github.com/pawamoy/pytkdocs/commit/a013c07f73fce72f73e1267de97d041036106ab5">a013c07</a> by Arthur Pastel). Issue <a href="https://github.com/pawamoy/mkdocstrings/issues/151">pawamoy/mkdocstrings#151</a>, PR <a href="https://github.com/pawamoy/pytkdocs/pull/65">#65</a></li>
 </ul>
@@ -1181,13 +1229,13 @@ <h3 id="bug-fixes">Bug Fixes<a class="headerlink" href="#bug-fixes" title="Perma
 <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>
 <li>Use <code>inspect.cleandoc</code> for stripping docstrings whitespace (<a href="https://github.com/pawamoy/pytkdocs/commit/8009940c43a551a86ca91e0f81b234933d47bd6e">8009940</a> by Jared Khan). Issue <a href="https://github.com/pawamoy/pytkdocs/issues/54">#54</a>, PR <a href="https://github.com/pawamoy/pytkdocs/issues/55">#55</a></li>
 </ul>
-<h3 id="features_1">Features<a class="headerlink" href="#features_1" title="Permanent link">¤</a></h3>
+<h3 id="features_2">Features<a class="headerlink" href="#features_2" title="Permanent link">¤</a></h3>
 <ul>
 <li>Add support for Marshmallow models (<a href="https://github.com/pawamoy/pytkdocs/commit/c250466e219edf24d2f85b7337b5670e6f27a724">c250466</a> by Stu Fisher). References: <a href="https://github.com/pawamoy/pytkdocs/issues/51">#51</a></li>
 </ul>
 <h2 id="060-2020-06-14"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/0.6.0">0.6.0</a> - 2020-06-14<a class="headerlink" href="#060-2020-06-14" title="Permanent link">¤</a></h2>
 <p><small><a href="https://github.com/pawamoy/pytkdocs/compare/0.5.2...0.6.0">Compare with 0.5.2</a></small></p>
-<h3 id="features_2">Features<a class="headerlink" href="#features_2" title="Permanent link">¤</a></h3>
+<h3 id="features_3">Features<a class="headerlink" href="#features_3" title="Permanent link">¤</a></h3>
 <ul>
 <li>Support attributes sections for Google-style docstrings (<a href="https://github.com/pawamoy/pytkdocs/commit/02c0042f9d4d8ab799550418d8474d1a6669feec">02c0042</a> by Timothée Mazzucotelli).</li>
 </ul>
@@ -1217,7 +1265,7 @@ <h3 id="code-refactoring">Code Refactoring<a class="headerlink" href="#code-refa
 <li>Refactor parsers (<a href="https://github.com/pawamoy/pytkdocs/commit/3caefba1dcbd85a0bc2d05948073677c751aa1f3">3caefba</a> by Timothée Mazzucotelli).</li>
 <li>Don't serialize empty error lists in the result (<a href="https://github.com/pawamoy/pytkdocs/commit/7bec6c4aca9d3087bb5fb4e34b2801a58839dd3a">7bec6c4</a> by Timothée Mazzucotelli).</li>
 </ul>
-<h3 id="features_3">Features<a class="headerlink" href="#features_3" title="Permanent link">¤</a></h3>
+<h3 id="features_4">Features<a class="headerlink" href="#features_4" title="Permanent link">¤</a></h3>
 <ul>
 <li>Accept docstring options in JSON input (<a href="https://github.com/pawamoy/pytkdocs/commit/400af0bccb4297c3e872910d13c0b44ca3ce1339">400af0b</a> by Timothée Mazzucotelli).</li>
 <li>Retrieve dataclass fields docstrings (<a href="https://github.com/pawamoy/pytkdocs/commit/09eb224c3c961bdd82640221b888cbe52b9a489e">09eb224</a> by Timothée Mazzucotelli). References: <a href="https://github.com/pawamoy/pytkdocs/issues/31">#31</a></li>
@@ -1239,7 +1287,7 @@ <h3 id="code-refactoring_1">Code Refactoring<a class="headerlink" href="#code-re
 <ul>
 <li>Layout a docstring parser base (<a href="https://github.com/pawamoy/pytkdocs/commit/d427bccbfd619f65ae2d12559fcd6f1f1649d036">d427bcc</a> by Timothée Mazzucotelli).</li>
 </ul>
-<h3 id="features_4">Features<a class="headerlink" href="#features_4" title="Permanent link">¤</a></h3>
+<h3 id="features_5">Features<a class="headerlink" href="#features_5" title="Permanent link">¤</a></h3>
 <ul>
 <li>Add dataclass and pydantic support (<a href="https://github.com/pawamoy/pytkdocs/commit/a172ad88ee3b1735ee4ad0c91f3274c359e1e82e">a172ad8</a> by Shyam Dwaraknath). References: <a href="https://github.com/pawamoy/pytkdocs/issues/9">#9</a>, <a href="https://github.com/pawamoy/pytkdocs/issues/27">#27</a></li>
 </ul>
@@ -1249,7 +1297,7 @@ <h3 id="bug-fixes_5">Bug Fixes<a class="headerlink" href="#bug-fixes_5" title="P
 <ul>
 <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>
 </ul>
-<h3 id="features_5">Features<a class="headerlink" href="#features_5" title="Permanent link">¤</a></h3>
+<h3 id="features_6">Features<a class="headerlink" href="#features_6" title="Permanent link">¤</a></h3>
 <ul>
 <li>Support different indentations and complex markup in docstrings sections (<a href="https://github.com/pawamoy/pytkdocs/commit/2f53082dbd2bcb72423d4aff0cb3bf4319476be7">2f53082</a> by Timothée Mazzucotelli). Related issues/PRs: <a href="https://github.com/pawamoy/pytkdocs/issues/17">#17</a></li>
 </ul>

index.html

@@ -256,6 +256,19 @@
     Configuration
   </a>
 
+    <nav class="md-nav" aria-label="Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#details-on-new_path_syntax" class="md-nav__link">
+    Details on new_path_syntax
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -591,6 +604,19 @@
     Configuration
   </a>
 
+    <nav class="md-nav" aria-label="Configuration">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#details-on-new_path_syntax" class="md-nav__link">
+    Details on new_path_syntax
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
 
     </ul>
@@ -655,6 +681,7 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">
   <span class="nt">&quot;objects&quot;</span><span class="p">:</span> <span class="p">[</span>
     <span class="p">{</span>
       <span class="nt">&quot;path&quot;</span><span class="p">:</span> <span class="s2">&quot;pytkdocs&quot;</span><span class="p">,</span>
+      <span class="nt">&quot;new_path_syntax&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
       <span class="nt">&quot;members&quot;</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
       <span class="nt">&quot;inherited_members&quot;</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
       <span class="nt">&quot;filters&quot;</span><span class="p">:</span> <span class="p">[</span>
@@ -759,6 +786,10 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
 <p>The configuration options available are:</p>
 <ul>
 <li>
+<p><code>new_path_syntax</code>: when set to true, this option forces the use of the new object path syntax,
+  which uses a colon (<code>:</code>) to delimit modules from other objects.</p>
+</li>
+<li>
 <p><code>filters</code>: filters are regular expressions that allow to select or un-select objects based on their name.
   They are applied recursively (on every child of every object).
   If the expression starts with an exclamation mark,
@@ -778,6 +809,9 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
   If it's a list of names, select only those members, and apply filters on their children only.</p>
 </li>
 <li>
+<p><code>inherited_members</code>: true or false (default). When enabled, inherited members will be selected as well.</p>
+</li>
+<li>
 <p><code>docstring_style</code>: the docstring style to use when parsing the docstring. Only one parser available: <code>google</code>.</p>
 </li>
 <li>
@@ -788,10 +822,44 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
   <code>AdmonitionType: Title</code> will become <code>!!! admonitiontype "Title"</code>.</li>
 </ul>
 </li>
-<li>
-<p><code>inherited_members</code>: true or false (default). When enabled, inherited members will be selected as well.</p>
-</li>
 </ul>
+<h3 id="details-on-new_path_syntax">Details on <code>new_path_syntax</code><a class="headerlink" href="#details-on-new_path_syntax" title="Permanent link">¤</a></h3>
+<p>Example:</p>
+<table>
+  <tr>
+      <td>New syntax</td>
+      <td><code>package.module:Class.attribute</code></td>
+  </tr>
+  <tr>
+      <td>Old syntax</td>
+      <td><code>package.module.Class.attribute</code></td>
+  </tr>
+</table>
+
+<ul>
+<li>If there is a colon is an object's path, <code>pytkdocs</code> splits the path accordingly,
+  regardless of the value of <code>new_path_syntax</code>.</li>
+<li>If there isn't a colon, and <code>new_path_syntax</code> is false, <code>pytkdocs</code> uses the
+  old importing behavior.</li>
+<li>If there isn't a colon, and <code>new_path_syntax</code> is true, <code>pytkdocs</code> uses the new
+  importing behavior and therefore considers that the path points to a module.</li>
+</ul>
+<div class="admonition warning">
+<p class="admonition-title">The <code>new_path_syntax</code> option is temporary.</p>
+<p>It exists only to ease the transition to the new path syntax.</p>
+<p>Here is an idea of its life time:</p>
+<ul>
+<li><strong>version 0.9:</strong> the default value for <code>new_path_syntax</code> is false.
+  A pending deprecation warning is emmitted to tell users to switch to the new path syntax.</li>
+<li><strong>once version 0.10 is published:</strong> <a href="https://github.com/pawamoy/mkdocstrings"><code>mkdocstrings</code></a>
+  will log an MkDocs warning, making the builds fail
+  when <code>new_path_syntax</code> is false and strict mode is enabled.</li>
+<li><strong>version 0.11:</strong> the default value for <code>new_path_syntax</code> becomes true,
+  and the warning becomes a deprecation warning.</li>
+<li><strong>version 0.13:</strong> the <code>new_path_syntax</code> option is removed.</li>
+</ul>
+<p>Please update your paths to use the new colon syntax as soon as possible.</p>
+</div>
 
 
 

reference/cli/index.html

@@ -376,7 +376,7 @@ <h2 class="doc doc-heading" id="pytkdocs.cli.discarded_stdout">
 <p>Discard standard output.</p>
 <div class="admonition yields">
 <p class="admonition-title">Yields</p>
-<p>Nothing: we only yield to act as a context manager.</p>
+<p>Nothing: We only yield to act as a context manager.</p>
 </div>
 <details class="quote">
 <summary>Source code in <code>pytkdocs/cli.py</code></summary>
@@ -387,7 +387,7 @@ <h2 class="doc doc-heading" id="pytkdocs.cli.discarded_stdout">
 <span class="sd">    Discard standard output.</span>
 
 <span class="sd">    Yields:</span>
-<span class="sd">        Nothing: we only yield to act as a context manager.</span>
+<span class="sd">        Nothing: We only yield to act as a context manager.</span>
 <span class="sd">    """</span>
     <span class="c1"># Discard things printed at import time to avoid corrupting our JSON output</span>
     <span class="c1"># See https://github.com/pawamoy/pytkdocs/issues/24</span>