Deployed 645ca24 with MkDocs version: 1.1.2

Author: pawamoy

contributing/index.html

@@ -426,6 +426,13 @@
     Environment setup
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#tasks" class="md-nav__link">
+    Tasks
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -532,6 +539,13 @@
     Environment setup
   </a>
 
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#tasks" class="md-nav__link">
+    Tasks
+  </a>
+  
 </li>
 
         <li class="md-nav__item">
@@ -580,21 +594,42 @@ <h1 id="contributing">Contributing<a class="headerlink" href="#contributing" tit
 Every little bit helps, and credit will always be given.</p>
 <h2 id="environment-setup">Environment setup<a class="headerlink" href="#environment-setup" title="Permanent link">¤</a></h2>
 <p>Nothing easier!</p>
-<p>You just need two tools: Poetry and Invoke.</p>
+<p>Fork and clone the repository, then:</p>
+<div class="highlight"><pre><span></span><code><span class="nb">cd</span> mkdocstrings
+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>
 <div class="highlight"><pre><span></span><code>python3 -m pip install --user pipx
 pipx install poetry
 pipx install invoke
 </code></pre></div>
 
-<p>Now fork and clone the repository, then:</p>
-<div class="highlight"><pre><span></span><code><span class="nb">cd</span> mkdocstrings
-make setup
-</code></pre></div>
-
-<p>That's it!</p>
+<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>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
+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
+   through <code>poetry shell</code></li>
+</ol>
+<p>The Makefile detects if the Poetry environment is activated,
+so <code>make</code> will work the same with the virtualenv activated or not.</p>
 <h2 id="development">Development<a class="headerlink" href="#development" title="Permanent link">¤</a></h2>
 <p>As usual:</p>
 <ol>

credits/index.html

@@ -561,7 +561,6 @@ <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#dir
 <a href="http://www.crummy.com/software/BeautifulSoup/bs4/"><code>beautifulsoup4</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/nedbat/coveragepy"><code>coverage</code></a> |
 <a href="https://github.com/pawamoy/failprint"><code>failprint</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> |
@@ -572,25 +571,17 @@ <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#dir
 <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="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://www.mkdocs.org"><code>mkdocs</code></a> |
 <a href="https://squidfunk.github.io/mkdocs-material/"><code>mkdocs-material</code></a> |
-<a href="https://squidfunk.github.io/mkdocs-material/"><code>mkdocs-material</code></a> |
-<a href="http://www.mypy-lang.org/"><code>mypy</code></a> |
 <a href="http://www.mypy-lang.org/"><code>mypy</code></a> |
 <a href="https://github.com/facelessuser/pymdown-extensions"><code>pymdown-extensions</code></a> |
 <a href="https://docs.pytest.org/en/latest/"><code>pytest</code></a> |
-<a href="https://docs.pytest.org/en/latest/"><code>pytest</code></a> |
 <a href="https://github.com/pytest-dev/pytest-cov"><code>pytest-cov</code></a> |
-<a href="https://github.com/pytest-dev/pytest-cov"><code>pytest-cov</code></a> |
-<a href="https://github.com/pytest-dev/pytest-randomly"><code>pytest-randomly</code></a> |
 <a href="https://github.com/pytest-dev/pytest-randomly"><code>pytest-randomly</code></a> |
 <a href="http://pivotfinland.com/pytest-sugar/"><code>pytest-sugar</code></a> |
-<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/pytest-dev/pytest-xdist"><code>pytest-xdist</code></a> |
 <a href="https://github.com/pawamoy/pytkdocs"><code>pytkdocs</code></a> |
 <a href="https://github.com/uiri/toml"><code>toml</code></a> |

reference/references/index.html

@@ -398,7 +398,7 @@ <h2 class="hidden-toc" href="#mkdocstrings.references" id="mkdocstrings.referenc
 <div class="doc doc-object doc-attribute">
 <h2 class="doc doc-heading" id="mkdocstrings.references.AUTO_REF">
 <code class="highlight">
-AUTO_REF: <span class="n">Pattern</span><span class="p">[</span><span class="o">~</span><span class="n">AnyStr</span><span class="p">]</span> </code>
+AUTO_REF: <span class="n">Pattern</span> </code>
 <a class="headerlink" href="#mkdocstrings.references.AUTO_REF" title="Permanent link">¤</a></h2>
 <div class="doc doc-contents">
 <p>A regular expression to match unresolved Markdown references

search/search_index.json

@@ -1,63 +1,63 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
      <loc>https://pawamoy.github.io/mkdocstrings/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/usage/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/handlers/overview/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/handlers/python/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/reference/handlers/__init__/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/reference/handlers/python/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/reference/extension/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/reference/plugin/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/reference/references/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/troubleshooting/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/contributing/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/code_of_conduct/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/changelog/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/credits/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url><url>
      <loc>https://pawamoy.github.io/mkdocstrings/license/</loc>
-     <lastmod>2020-09-25</lastmod>
+     <lastmod>2020-09-26</lastmod>
      <changefreq>daily</changefreq>
     </url>
 </urlset>