Deployed fc15a45 with MkDocs version: 1.1.2

Author: pawamoy

changelog/index.html

@@ -622,35 +622,32 @@ <h2 id="environment-setup">Environment setup<a class="headerlink" href="#environ
 <div class="highlight"><pre><span></span><code><span class="nb">cd</span> pytkdocs
 make setup
 </code></pre></div>
-
 <div class="admonition note">
 <p class="admonition-title">Note</p>
 <p>If it fails for some reason,
-you'll need to install these tools manually:
-<a href="https://github.com/python-poetry/poetry">Poetry</a> and
-<a href="https://github.com/pyinvoke/invoke">Invoke</a>.</p>
-<p>You can install them with:</p>
+you'll need to install
+<a href="https://github.com/python-poetry/poetry">Poetry</a>
+manually.</p>
+<p>You can install it with:</p>
 <div class="highlight"><pre><span></span><code>python3 -m pip install --user pipx
 pipx install poetry
-pipx install invoke
 </code></pre></div>
-
 <p>Now you can try running <code>make setup</code> again,
 or simply <code>poetry install</code>.</p>
 </div>
 <p>You now have the dependencies installed.</p>
 <p>You can run the application with <code>poetry run pytkdocs [ARGS...]</code>.</p>
 <p>Run <code>make help</code> to see all the available actions!</p>
 <h2 id="tasks">Tasks<a class="headerlink" href="#tasks" title="Permanent link">¤</a></h2>
-<p>This project uses <a href="https://github.com/pyinvoke/invoke">Invoke</a> to run tasks.
-A Makefile is also provided. The Makefile will try to run the task
+<p>This project uses <a href="https://github.com/pawamoy/duty">Duty</a> to run tasks.
+A Makefile is also provided. The Makefile will try to run certain tasks
 on multiple Python versions. If for some reason you don't want to run the task
 on multiple Python versions, you can do one of the following:</p>
 <ol>
 <li><code>export PYTHON_VERSIONS=</code>: this will run the task
    with only the current Python version</li>
-<li>run the task directly with <code>poetry run invoke TASK</code>,
-   or <code>invoke TASK</code> if the environment was already activated
+<li>run the task directly with <code>poetry run duty TASK</code>,
+   or <code>duty TASK</code> if the environment was already activated
    through <code>poetry shell</code></li>
 </ol>
 <p>The Makefile detects if the Poetry environment is activated,
@@ -685,7 +682,6 @@ <h2 id="commit-message-convention">Commit message convention<a class="headerlink
 
 [Body]
 </code></pre></div>
-
 <p>Scope and body are optional. Type can be:</p>
 <ul>
 <li><code>build</code>: About packaging, building wheels, etc.</li>
@@ -706,22 +702,18 @@ <h2 id="commit-message-convention">Commit message convention<a class="headerlink
 References: #10, #11.
 Fixes #15.
 </code></pre></div>
-
 <h2 id="pull-requests-guidelines">Pull requests guidelines<a class="headerlink" href="#pull-requests-guidelines" title="Permanent link">¤</a></h2>
 <p>Link to any related issue in the Pull Request message.</p>
 <p>During review, we recommend using fixups:</p>
 <div class="highlight"><pre><span></span><code><span class="c1"># SHA is the SHA of the commit you want to fix</span>
 git commit --fixup<span class="o">=</span>SHA
 </code></pre></div>
-
 <p>Once all the changes are approved, you can squash your commits:</p>
 <div class="highlight"><pre><span></span><code>git rebase -i --autosquash master
 </code></pre></div>
-
 <p>And force-push:</p>
 <div class="highlight"><pre><span></span><code>git push -f
 </code></pre></div>
-
 <p>If this seems all too complicated, you can push or force-push each new commit,
 and we will squash them ourselves if needed, before merging.</p>
 

contributing/index.html

@@ -583,8 +583,8 @@ <h1 id="credits">Credits<a class="headerlink" href="#credits" title="Permanent l
 <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#direct-dependencies" title="Permanent link">¤</a></h3>
 <p><a href="https://github.com/myint/autoflake"><code>autoflake</code></a> |
 <a href="https://github.com/psf/black"><code>black</code></a> |
-<a href="https://github.com/nedbat/coveragepy"><code>coverage</code></a> |
-<a href="https://github.com/pawamoy/failprint"><code>failprint</code></a> |
+<a href="https://github.com/ericvsmith/dataclasses"><code>dataclasses</code></a> |
+<a href="https://github.com/pawamoy/duty"><code>duty</code></a> |
 <a href="https://github.com/peterjc/flake8-black"><code>flake8-black</code></a> |
 <a href="https://github.com/gforcada/flake8-builtins"><code>flake8-builtins</code></a> |
 <a href="https://pypi.org/project/flake8-pytest-style"><code>flake8-pytest-style</code></a> |
@@ -593,10 +593,10 @@ <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#dir
 <a href="None"><code>flakehell</code></a> |
 <a href="https://github.com/pawamoy/git-changelog"><code>git-changelog</code></a> |
 <a href="https://github.com/encode/httpx"><code>httpx</code></a> |
-<a href="http://docs.pyinvoke.org"><code>invoke</code></a> |
 <a href="https://ipython.org"><code>ipython</code></a> |
 <a href="https://github.com/timothycrosley/isort"><code>isort</code></a> |
 <a href="https://github.com/mattrobenolt/jinja2-cli"><code>jinja2-cli</code></a> |
+<a href="https://github.com/cmacmackin/markdown-include/"><code>markdown-include</code></a> |
 <a href="https://github.com/marshmallow-code/marshmallow"><code>marshmallow</code></a> |
 <a href="https://www.mkdocs.org"><code>mkdocs</code></a> |
 <a href="https://squidfunk.github.io/mkdocs-material/"><code>mkdocs-material</code></a> |
@@ -609,8 +609,8 @@ <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#dir
 <a href="http://pivotfinland.com/pytest-sugar/"><code>pytest-sugar</code></a> |
 <a href="https://github.com/pytest-dev/pytest-xdist"><code>pytest-xdist</code></a> |
 <a href="https://github.com/uiri/toml"><code>toml</code></a> |
-<a href="https://wemake-python-stylegui.de"><code>wemake-python-styleguide</code></a> |
-<a href="https://github.com/GrahamDumpleton/wrapt"><code>wrapt</code></a></p>
+<a href="https://github.com/python/typing/blob/master/typing_extensions/README.rst"><code>typing-extensions</code></a> |
+<a href="https://wemake-python-stylegui.de"><code>wemake-python-styleguide</code></a></p>
 <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="#indirect-dependencies" title="Permanent link">¤</a></h3>
 <p><a href="https://github.com/gvalkov/python-ansimarkup"><code>ansimarkup</code></a> |
 <a href="https://github.com/pytest-dev/apipkg"><code>apipkg</code></a> |
@@ -628,13 +628,14 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
 <a href="https://palletsprojects.com/p/click/"><code>click</code></a> |
 <a href="https://github.com/tartley/colorama"><code>colorama</code></a> |
 <a href="http://github.com/MagicStack/contextvars"><code>contextvars</code></a> |
+<a href="https://github.com/nedbat/coveragepy"><code>coverage</code></a> |
 <a href="None"><code>darglint</code></a> |
-<a href="https://github.com/ericvsmith/dataclasses"><code>dataclasses</code></a> |
 <a href="https://github.com/micheles/decorator"><code>decorator</code></a> |
 <a href="http://docutils.sourceforge.net/"><code>docutils</code></a> |
 <a href="https://github.com/takluyver/entrypoints"><code>entrypoints</code></a> |
 <a href="https://github.com/myint/eradicate"><code>eradicate</code></a> |
 <a href="https://execnet.readthedocs.io/en/latest/"><code>execnet</code></a> |
+<a href="https://github.com/pawamoy/failprint"><code>failprint</code></a> |
 <a href="https://gitlab.com/pycqa/flake8"><code>flake8</code></a> |
 <a href="https://github.com/tylerwince/flake8-bandit"><code>flake8-bandit</code></a> |
 <a href="https://github.com/sobolevn/flake8-broken-line"><code>flake8-broken-line</code></a> |
@@ -657,7 +658,7 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
 <a href="https://github.com/encode/httpcore"><code>httpcore</code></a> |
 <a href="https://github.com/kjd/idna"><code>idna</code></a> |
 <a href="https://github.com/MagicStack/immutables"><code>immutables</code></a> |
-<a href="http://importlib-metadata.readthedocs.io/"><code>importlib-metadata</code></a> |
+<a href="https://github.com/python/importlib_metadata"><code>importlib-metadata</code></a> |
 <a href="http://github.com/RonnyPfannschmidt/iniconfig"><code>iniconfig</code></a> |
 <a href="http://ipython.org"><code>ipython-genutils</code></a> |
 <a href="https://github.com/davidhalter/jedi"><code>jedi</code></a> |
@@ -670,7 +671,6 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
 <a href="https://palletsprojects.com/p/markupsafe/"><code>MarkupSafe</code></a> |
 <a href="https://github.com/pycqa/mccabe"><code>mccabe</code></a> |
 <a href="https://github.com/facelessuser/mkdocs-material-extensions"><code>mkdocs-material-extensions</code></a> |
-<a href="https://github.com/more-itertools/more-itertools"><code>more-itertools</code></a> |
 <a href="https://github.com/python/mypy_extensions"><code>mypy-extensions</code></a> |
 <a href="http://nltk.org/"><code>nltk</code></a> |
 <a href="https://github.com/pypa/packaging"><code>packaging</code></a> |
@@ -708,9 +708,9 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
 <a href="https://github.com/tqdm/tqdm"><code>tqdm</code></a> |
 <a href="http://ipython.org"><code>traitlets</code></a> |
 <a href="https://github.com/python/typed_ast"><code>typed-ast</code></a> |
-<a href="https://github.com/python/typing/blob/master/typing_extensions/README.rst"><code>typing-extensions</code></a> |
 <a href="https://urllib3.readthedocs.io/"><code>urllib3</code></a> |
 <a href="https://github.com/jquast/wcwidth"><code>wcwidth</code></a> |
+<a href="https://github.com/GrahamDumpleton/wrapt"><code>wrapt</code></a> |
 <a href="https://github.com/jaraco/zipp"><code>zipp</code></a></p>
 <p><strong><a href="http://pawamoy.github.io/credits/">More credits from the author</a></strong></p>
 

credits/index.html

@@ -1,33 +1,33 @@
+/* Indentation. */
 div.doc-contents:not(.first) {
   padding-left: 25px;
   border-left: 4px solid rgba(230, 230, 230);
   margin-bottom: 80px;
 }
 
+/* Don't capitalize names. */
 h5.doc-heading {
   text-transform: none !important;
 }
 
-h6.hidden-toc {
-  margin: 0 !important;
-  position: relative;
-  top: -70px;
-}
-
-h6.hidden-toc::before {
+/* Don't use vertical space on hidden ToC entries. */
+.hidden-toc::before {
   margin-top: 0 !important;
   padding-top: 0 !important;
 }
 
-h6.hidden-toc a.headerlink {
+/* Don't show permalink of hidden ToC entries. */
+.hidden-toc a.headerlink {
   display: none;
 }
 
+/* Avoid breaking parameters name, etc. in table cells. */
 td code {
   word-break: normal !important;
 }
 
+/* For pieces of Markdown rendered in table cells. */
 td p {
   margin-top: 0 !important;
   margin-bottom: 0 !important;
-}
+}

css/mkdocstrings.css

@@ -642,7 +642,9 @@
                 <h1 id="pytkdocs">pytkdocs<a class="headerlink" href="#pytkdocs" title="Permanent link">¤</a></h1>
 <p><a href="https://github.com/pawamoy/pytkdocs/actions?query=workflow%3Aci"><img alt="ci" src="https://github.com/pawamoy/pytkdocs/workflows/ci/badge.svg" /></a>
 <a href="https://pawamoy.github.io/pytkdocs/"><img alt="documentation" src="https://img.shields.io/badge/docs-mkdocs%20material-blue.svg?style=flat" /></a>
-<a href="https://pypi.org/project/pytkdocs/"><img alt="pypi version" src="https://img.shields.io/pypi/v/pytkdocs.svg" /></a></p>
+<a href="https://pypi.org/project/pytkdocs/"><img alt="pypi version" src="https://img.shields.io/pypi/v/pytkdocs.svg" /></a>
+<a href="https://anaconda.org/conda-forge/pytkdocs"><img alt="conda version" src="https://img.shields.io/conda/vn/conda-forge/pytkdocs" /></a>
+<a href="https://gitter.im/pytkdocs/community"><img alt="gitter" src="https://badges.gitter.im/join%20chat.svg" /></a></p>
 <p>Load Python objects documentation.</p>
 <h2 id="requirements">Requirements<a class="headerlink" href="#requirements" title="Permanent link">¤</a></h2>
 <p><code>pytkdocs</code> requires Python 3.6 or above.</p>
@@ -674,6 +676,9 @@ <h2 id="installation">Installation<a class="headerlink" href="#installation" tit
 
 pipx install --python python3.6 pytkdocs
 </code></pre></div></p>
+<p>With <code>conda</code>:
+<div class="highlight"><pre><span></span><code><span class="n">conda</span> <span class="n">install</span> <span class="o">-</span><span class="n">c</span> <span class="n">conda</span><span class="o">-</span><span class="n">forge</span> <span class="n">pytkdocs</span>
+</code></pre></div></p>
 <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">¤</a></h2>
 <p><code>pytkdocs</code> accepts JSON on standard input and writes JSON on standard output.</p>
 <p>Input format:</p>
@@ -695,7 +700,6 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">
   <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">&quot;loading_errors&quot;</span><span class="p">:</span> <span class="p">[</span>
@@ -771,7 +775,6 @@ <h2 id="usage">Usage<a class="headerlink" href="#usage" title="Permanent link">
   <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>
@@ -812,17 +815,19 @@ <h2 id="configuration">Configuration<a class="headerlink" href="#configuration"
 <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>
+<p><code>docstring_style</code>: the docstring style to use when parsing the docstring. <code>google</code> and <code>restructured-text</code><sup>1</sup>.</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>
+<li><code>restructured-text</code> does not accept any options.</li>
 </ul>
 </li>
 </ul>
+<p><sup>1</sup>: reStructured Text parsing is in active development and is not feature complete yet.</p>
 <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>

index.html

@@ -556,7 +556,7 @@
                   <h1>__init__.py</h1>
 
                 <div class="doc doc-object doc-module">
-<h2 class="hidden-toc" href="#pytkdocs.__init__" id="pytkdocs.__init__" style="visibility: hidden; width: 0; height: 0;">
+<h2 class="hidden-toc" href="#pytkdocs.__init__" id="pytkdocs.__init__" style="visibility: hidden; position: absolute;">
         <a class="headerlink" href="#pytkdocs.__init__" title="Permanent link">¤</a></h2>
 <div class="doc doc-contents first">
 <p>pytkdocs package.</p>

reference/__init__/index.html

@@ -556,7 +556,7 @@
                   <h1>__main__.py</h1>
 
                 <div class="doc doc-object doc-module">
-<h2 class="hidden-toc" href="#pytkdocs.__main__" id="pytkdocs.__main__" style="visibility: hidden; width: 0; height: 0;">
+<h2 class="hidden-toc" href="#pytkdocs.__main__" id="pytkdocs.__main__" style="visibility: hidden; position: absolute;">
         <a class="headerlink" href="#pytkdocs.__main__" title="Permanent link">¤</a></h2>
 <div class="doc doc-contents first">
 <p>Entry-point module, in case you use <code>python -m pytkdocs</code>.</p>

reference/__main__/index.html

@@ -362,7 +362,7 @@
 </a>
 <h1>cli.py</h1>
 <div class="doc doc-object doc-module">
-<h2 class="hidden-toc" href="#pytkdocs.cli" id="pytkdocs.cli" style="visibility: hidden; width: 0; height: 0;">
+<h2 class="hidden-toc" href="#pytkdocs.cli" id="pytkdocs.cli" style="visibility: hidden; position: absolute;">
 <a class="headerlink" href="#pytkdocs.cli" title="Permanent link">¤</a></h2>
 <div class="doc doc-contents first">
 <p>Module that contains the command line application.</p>