Deployed 1f89024 with MkDocs version: 1.1.2

Author: pawamoy

changelog/index.html

@@ -263,6 +263,20 @@
     </label>
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item">
+<a class="md-nav__link" href="#v060-2020-06-14">
+    v0.6.0 - 2020-06-14
+  </a>
+<nav aria-label="v0.6.0 - 2020-06-14" class="md-nav">
+<ul class="md-nav__list">
+<li class="md-nav__item">
+<a class="md-nav__link" href="#features">
+    Features
+  </a>
+</li>
+</ul>
+</nav>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#v052-2020-06-11">
     v0.5.2 - 2020-06-11
   </a>
@@ -307,7 +321,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features">
+<a class="md-nav__link" href="#features_1">
     Features
   </a>
 </li>
@@ -331,7 +345,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features_1">
+<a class="md-nav__link" href="#features_2">
     Features
   </a>
 </li>
@@ -350,7 +364,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features_2">
+<a class="md-nav__link" href="#features_3">
     Features
   </a>
 </li>
@@ -457,6 +471,20 @@
     </label>
 <ul class="md-nav__list" data-md-scrollfix="">
 <li class="md-nav__item">
+<a class="md-nav__link" href="#v060-2020-06-14">
+    v0.6.0 - 2020-06-14
+  </a>
+<nav aria-label="v0.6.0 - 2020-06-14" class="md-nav">
+<ul class="md-nav__list">
+<li class="md-nav__item">
+<a class="md-nav__link" href="#features">
+    Features
+  </a>
+</li>
+</ul>
+</nav>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#v052-2020-06-11">
     v0.5.2 - 2020-06-11
   </a>
@@ -501,7 +529,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features">
+<a class="md-nav__link" href="#features_1">
     Features
   </a>
 </li>
@@ -525,7 +553,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features_1">
+<a class="md-nav__link" href="#features_2">
     Features
   </a>
 </li>
@@ -544,7 +572,7 @@
   </a>
 </li>
 <li class="md-nav__item">
-<a class="md-nav__link" href="#features_2">
+<a class="md-nav__link" href="#features_3">
     Features
   </a>
 </li>
@@ -641,6 +669,12 @@ <h1 id="changelog">Changelog<a class="headerlink" href="#changelog" title="Perma
 <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>
 <!-- insertion marker -->
+<h2 id="v060-2020-06-14"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/v0.6.0">v0.6.0</a> - 2020-06-14<a class="headerlink" href="#v060-2020-06-14" title="Permanent link">¤</a></h2>
+<p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.5.2...v0.6.0">Compare with v0.5.2</a></small></p>
+<h3 id="features">Features<a class="headerlink" href="#features" 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>
 <h2 id="v052-2020-06-11"><a href="https://github.com/pawamoy/pytkdocs/releases/tag/v0.5.2">v0.5.2</a> - 2020-06-11<a class="headerlink" href="#v052-2020-06-11" title="Permanent link">¤</a></h2>
 <p><small><a href="https://github.com/pawamoy/pytkdocs/compare/v0.5.1...v0.5.2">Compare with v0.5.1</a></small></p>
 <h3 id="bug-fixes">Bug Fixes<a class="headerlink" href="#bug-fixes" title="Permanent link">¤</a></h3>
@@ -667,7 +701,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">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>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>
@@ -689,7 +723,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_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 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>
@@ -699,7 +733,7 @@ <h3 id="bug-fixes_4">Bug Fixes<a class="headerlink" href="#bug-fixes_4" 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_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 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

@@ -146,6 +146,11 @@
   </a>
 </li>
 <li class="md-nav__item">
+<a class="md-nav__link" href="#command-line">
+    Command-line
+  </a>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#configuration">
     Configuration
   </a>
@@ -322,6 +327,11 @@
   </a>
 </li>
 <li class="md-nav__item">
+<a class="md-nav__link" href="#command-line">
+    Command-line
+  </a>
+</li>
+<li class="md-nav__item">
 <a class="md-nav__link" href="#configuration">
     Configuration
   </a>
@@ -375,15 +385,105 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">
 <div class="highlight"><pre><span></span><code><span class="p">{</span>
   <span class="nt">"objects"</span><span class="p">:</span> <span class="p">[</span>
     <span class="p">{</span>
-      <span class="nt">"path"</span><span class="p">:</span> <span class="s2">"my_module.my_class"</span><span class="p">,</span>
+      <span class="nt">"path"</span><span class="p">:</span> <span class="s2">"pytkdocs"</span><span class="p">,</span>
       <span class="nt">"members"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+      <span class="nt">"inherited_members"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
       <span class="nt">"filters"</span><span class="p">:</span> <span class="p">[</span>
         <span class="s2">"!^_[^_]"</span>
-      <span class="p">]</span>
+      <span class="p">],</span>
+      <span class="nt">"docstring_style"</span><span class="p">:</span> <span class="s2">"google"</span><span class="p">,</span>
+      <span class="nt">"docstring_options"</span><span class="p">:</span> <span class="p">{</span>
+        <span class="nt">"replace_admonitions"</span><span class="p">:</span> <span class="kc">true</span>
+      <span class="p">}</span>
     <span class="p">}</span>
   <span class="p">]</span>
 <span class="p">}</span>
 </code></pre></div>
+<p>Output format:</p>
+<div class="highlight"><pre><span></span><code><span class="p">{</span>
+  <span class="nt">"loading_errors"</span><span class="p">:</span> <span class="p">[</span>
+    <span class="s2">"string (message)"</span>
+  <span class="p">],</span>
+  <span class="nt">"parsing_errors"</span><span class="p">:</span> <span class="p">{</span>
+    <span class="nt">"string (object)"</span><span class="p">:</span> <span class="p">[</span>
+      <span class="s2">"string (message)"</span>
+    <span class="p">]</span>
+  <span class="p">},</span>
+  <span class="nt">"objects"</span><span class="p">:</span> <span class="p">[</span>
+    <span class="p">{</span>
+      <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"pytkdocs"</span><span class="p">,</span>
+      <span class="nt">"path"</span><span class="p">:</span> <span class="s2">"pytkdocs"</span><span class="p">,</span>
+      <span class="nt">"category"</span><span class="p">:</span> <span class="s2">"module"</span><span class="p">,</span>
+      <span class="nt">"file_path"</span><span class="p">:</span> <span class="s2">"/media/data/dev/pawamoy/pytkdocs/src/pytkdocs/__init__.py"</span><span class="p">,</span>
+      <span class="nt">"relative_file_path"</span><span class="p">:</span> <span class="s2">"pytkdocs/__init__.py"</span><span class="p">,</span>
+      <span class="nt">"properties"</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s2">"special"</span>
+      <span class="p">],</span>
+      <span class="nt">"parent_path"</span><span class="p">:</span> <span class="s2">"pytkdocs"</span><span class="p">,</span>
+      <span class="nt">"has_contents"</span><span class="p">:</span> <span class="kc">true</span><span class="p">,</span>
+      <span class="nt">"docstring"</span><span class="p">:</span> <span class="s2">"pytkdocs package.\n\nLoad Python objects documentation."</span><span class="p">,</span>
+      <span class="nt">"docstring_sections"</span><span class="p">:</span> <span class="p">[</span>
+        <span class="p">{</span>
+          <span class="nt">"type"</span><span class="p">:</span> <span class="s2">"markdown"</span><span class="p">,</span>
+          <span class="nt">"value"</span><span class="p">:</span> <span class="s2">"pytkdocs package.\n\nLoad Python objects documentation."</span>
+        <span class="p">}</span>
+      <span class="p">],</span>
+      <span class="nt">"source"</span><span class="p">:</span> <span class="p">{</span>
+        <span class="nt">"code"</span><span class="p">:</span> <span class="s2">"\"\"\"\npytkdocs package.\n\nLoad Python objects documentation.\n\"\"\"\n\nfrom typing import List\n\n__all__: List[str] = []\n"</span><span class="p">,</span>
+        <span class="nt">"line_start"</span><span class="p">:</span> <span class="mi">1</span>
+      <span class="p">},</span>
+      <span class="nt">"children"</span><span class="p">:</span> <span class="p">{</span>
+        <span class="nt">"pytkdocs.__all__"</span><span class="p">:</span> <span class="p">{</span>
+          <span class="nt">"name"</span><span class="p">:</span> <span class="s2">"__all__"</span><span class="p">,</span>
+          <span class="nt">"path"</span><span class="p">:</span> <span class="s2">"pytkdocs.__all__"</span><span class="p">,</span>
+          <span class="nt">"category"</span><span class="p">:</span> <span class="s2">"attribute"</span><span class="p">,</span>
+          <span class="nt">"file_path"</span><span class="p">:</span> <span class="s2">"/media/data/dev/pawamoy/pytkdocs/src/pytkdocs/__init__.py"</span><span class="p">,</span>
+          <span class="nt">"relative_file_path"</span><span class="p">:</span> <span class="s2">"pytkdocs/__init__.py"</span><span class="p">,</span>
+          <span class="nt">"properties"</span><span class="p">:</span> <span class="p">[</span>
+            <span class="s2">"special"</span>
+          <span class="p">],</span>
+          <span class="nt">"parent_path"</span><span class="p">:</span> <span class="s2">"pytkdocs"</span><span class="p">,</span>
+          <span class="nt">"has_contents"</span><span class="p">:</span> <span class="kc">false</span><span class="p">,</span>
+          <span class="nt">"docstring"</span><span class="p">:</span> <span class="kc">null</span><span class="p">,</span>
+          <span class="nt">"docstring_sections"</span><span class="p">:</span> <span class="p">[],</span>
+          <span class="nt">"source"</span><span class="p">:</span> <span class="p">{},</span>
+          <span class="nt">"children"</span><span class="p">:</span> <span class="p">{},</span>
+          <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">[],</span>
+          <span class="nt">"methods"</span><span class="p">:</span> <span class="p">[],</span>
+          <span class="nt">"functions"</span><span class="p">:</span> <span class="p">[],</span>
+          <span class="nt">"modules"</span><span class="p">:</span> <span class="p">[],</span>
+          <span class="nt">"classes"</span><span class="p">:</span> <span class="p">[]</span>
+        <span class="p">}</span>
+      <span class="p">},</span>
+      <span class="nt">"attributes"</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s2">"pytkdocs.__all__"</span>
+      <span class="p">],</span>
+      <span class="nt">"methods"</span><span class="p">:</span> <span class="p">[],</span>
+      <span class="nt">"functions"</span><span class="p">:</span> <span class="p">[],</span>
+      <span class="nt">"modules"</span><span class="p">:</span> <span class="p">[</span>
+        <span class="s2">"pytkdocs.__main__"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.cli"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.loader"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.objects"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.parsers"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.properties"</span><span class="p">,</span>
+        <span class="s2">"pytkdocs.serializer"</span>
+      <span class="p">],</span>
+      <span class="nt">"classes"</span><span class="p">:</span> <span class="p">[]</span>
+    <span class="p">}</span>
+  <span class="p">]</span>
+<span class="p">}</span>
+</code></pre></div>
+<h2 id="command-line">Command-line<a class="headerlink" href="#command-line" title="Permanent link">¤</a></h2>
+<p>Running <code>pytkdocs</code> without argument will read the whole standard input,
+and output the result once.</p>
+<p>Running <code>pytkdocs --line-by-line</code> will enter an infinite loop,
+where at each iteration one line is read on the standard input,
+and the result is written back on one line.
+This allows other programs to use <code>pytkdocs</code> in a subprocess,
+feeding it single lines of JSON, and reading back single lines of JSON as well.
+This mode was actually implemented specifically for
+<a href="https://github.com/pawamoy/mkdocstrings">mkdocstrings</a>.</p>
 <h2 id="configuration">Configuration<a class="headerlink" href="#configuration" title="Permanent link">¤</a></h2>
 <p>The configuration options available are:</p>
 <ul>
@@ -406,6 +506,20 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
   If <code>True</code>, select every members that passes filters. If <code>False</code>, select nothing.
   If it's a list of names, select only those members, and apply filters on their children only.</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>
+<p><code>docstring_options</code>: options to pass to the docstring parser.</p>
+<ul>
+<li><code>google</code> accepts a <code>replace_admonitions</code> boolean option (default: true). When enabled, this option will
+  replace titles of an indented block by their Markdown admonition equivalent:
+  <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>
 </article>
 </div>