Skip to content

Commit c28fe41

Browse files
pawamoypawamoy
committed
Deployed c4b58a6 with MkDocs version: 1.1.2
1 parent 7541924 commit c28fe41

9 files changed

Lines changed: 110 additions & 58 deletions

File tree

‎__pycache__/macros.cpython-39.pyc‎

0 Bytes
Binary file not shown.

‎changelog/index.html‎

Lines changed: 76 additions & 30 deletions
Large diffs are not rendered by default.

‎contributing/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -826,7 +826,7 @@ <h2 id="environment-setup">Environment setup<a class="headerlink" href="#environ
826826
pipx install poetry
827827
</code></pre></div>
828828
<p>Now you can try running <code>make setup</code> again,
829-
or simply <code>poetry install</code>.</p>
829+
or simply <code>poetry install -E numpy-style</code>.</p>
830830
</div>
831831
<p>You now have the dependencies installed.</p>
832832
<p>You can run the application with <code>poetry run pytkdocs [ARGS...]</code>.</p>

‎credits/index.html‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -791,12 +791,14 @@ <h3 id="direct-dependencies">Direct dependencies<a class="headerlink" href="#dir
791791
<a href="https://github.com/encode/httpx"><code>httpx</code></a> |
792792
<a href="https://github.com/timothycrosley/isort"><code>isort</code></a> |
793793
<a href="https://github.com/mattrobenolt/jinja2-cli"><code>jinja2-cli</code></a> |
794+
<a href="https://github.com/marshmallow-code/marshmallow"><code>marshmallow</code></a> |
794795
<a href="https://www.mkdocs.org"><code>mkdocs</code></a> |
795796
<a href="https://github.com/pawamoy/mkdocs-coverage"><code>mkdocs-coverage</code></a> |
796797
<a href="https://github.com/fralau/mkdocs_macros_plugin"><code>mkdocs-macros-plugin</code></a> |
797798
<a href="https://squidfunk.github.io/mkdocs-material/"><code>mkdocs-material</code></a> |
798799
<a href="https://github.com/mkdocstrings/mkdocstrings"><code>mkdocstrings</code></a> |
799800
<a href="http://www.mypy-lang.org/"><code>mypy</code></a> |
801+
<a href="https://github.com/samuelcolvin/pydantic"><code>pydantic</code></a> |
800802
<a href="https://docs.pytest.org/en/latest/"><code>pytest</code></a> |
801803
<a href="https://github.com/pytest-dev/pytest-cov"><code>pytest-cov</code></a> |
802804
<a href="https://github.com/pytest-dev/pytest-randomly"><code>pytest-randomly</code></a> |
@@ -857,7 +859,6 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
857859
<a href="https://palletsprojects.com/p/markupsafe/"><code>MarkupSafe</code></a> |
858860
<a href="https://github.com/pycqa/mccabe"><code>mccabe</code></a> |
859861
<a href="https://github.com/mkdocstrings/autorefs"><code>mkdocs-autorefs</code></a> |
860-
<a href="UNKNOWN"><code>mkdocs-macros-test</code></a> |
861862
<a href="https://github.com/facelessuser/mkdocs-material-extensions"><code>mkdocs-material-extensions</code></a> |
862863
<a href="https://github.com/python/mypy_extensions"><code>mypy-extensions</code></a> |
863864
<a href="http://nltk.org/"><code>nltk</code></a> |
@@ -868,7 +869,7 @@ <h3 id="indirect-dependencies">Indirect dependencies<a class="headerlink" href="
868869
<a href="https://github.com/pytest-dev/pluggy"><code>pluggy</code></a> |
869870
<a href="https://github.com/pexpect/ptyprocess"><code>ptyprocess</code></a> |
870871
<a href="https://py.readthedocs.io/"><code>py</code></a> |
871-
<a href="https://pycodestyle.readthedocs.io/"><code>pycodestyle</code></a> |
872+
<a href="https://pycodestyle.pycqa.org/"><code>pycodestyle</code></a> |
872873
<a href="https://github.com/PyCQA/pydocstyle/"><code>pydocstyle</code></a> |
873874
<a href="https://github.com/PyCQA/pyflakes"><code>pyflakes</code></a> |
874875
<a href="https://pygments.org/"><code>Pygments</code></a> |

‎reference/objects/index.html‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2349,6 +2349,14 @@ <h3 id="pytkdocs.objects.Object.add_child" class="doc doc-heading">
23492349
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">Method</span><span class="p">):</span>
23502350
<span class="bp">self</span><span class="o">.</span><span class="n">methods</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="c1"># type: ignore</span>
23512351
<span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="n">Attribute</span><span class="p">):</span>
2352+
<span class="c1"># Dataclass attributes with default values will already be present in `self.attributes` as they are</span>
2353+
<span class="c1"># resolved differently by the python interpreter. As they have a concrete value, they are already present</span>
2354+
<span class="c1"># in the &quot;original&quot; class. They should be overridden with the new &quot;dataclass&quot; attribute coming in here</span>
2355+
<span class="c1"># (having the &quot;dataclass_field&quot; property set)</span>
2356+
<span class="n">new_attribute_name</span> <span class="o">=</span> <span class="n">obj</span><span class="o">.</span><span class="n">name</span>
2357+
<span class="k">for</span> <span class="n">attribute</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">attributes</span><span class="p">:</span>
2358+
<span class="k">if</span> <span class="n">attribute</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">new_attribute_name</span><span class="p">:</span>
2359+
<span class="bp">self</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">attribute</span><span class="p">)</span>
23522360
<span class="bp">self</span><span class="o">.</span><span class="n">attributes</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span> <span class="c1"># type: ignore</span>
23532361
<span class="n">obj</span><span class="o">.</span><span class="n">parent</span> <span class="o">=</span> <span class="bp">self</span>
23542362

‎reference/parsers/docstrings/restructured_text/index.html‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1217,7 +1217,6 @@ <h2 id="pytkdocs.parsers.docstrings.restructured_text.ParsedDirective" class="do
12171217

12181218

12191219

1220-
12211220
</div>
12221221

12231222
</div>
@@ -1267,8 +1266,6 @@ <h2 id="pytkdocs.parsers.docstrings.restructured_text.ParsedValues" class="doc d
12671266

12681267

12691268

1270-
1271-
12721269

12731270

12741271

‎search/search_index.json‎

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

‎sitemap.xml‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,87 @@
11
<?xml version="1.0" encoding="UTF-8"?>
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9"><url>
33
<loc>https://pawamoy.github.io/pytkdocs/</loc>
4-
<lastmod>2021-02-28</lastmod>
4+
<lastmod>2021-04-03</lastmod>
55
<changefreq>daily</changefreq>
66
</url><url>
77
<loc>https://pawamoy.github.io/pytkdocs/changelog/</loc>
8-
<lastmod>2021-02-28</lastmod>
8+
<lastmod>2021-04-03</lastmod>
99
<changefreq>daily</changefreq>
1010
</url><url>
1111
<loc>https://pawamoy.github.io/pytkdocs/credits/</loc>
12-
<lastmod>2021-02-28</lastmod>
12+
<lastmod>2021-04-03</lastmod>
1313
<changefreq>daily</changefreq>
1414
</url><url>
1515
<loc>https://pawamoy.github.io/pytkdocs/license/</loc>
16-
<lastmod>2021-02-28</lastmod>
16+
<lastmod>2021-04-03</lastmod>
1717
<changefreq>daily</changefreq>
1818
</url><url>
1919
<loc>https://pawamoy.github.io/pytkdocs/reference/__init__/</loc>
20-
<lastmod>2021-02-28</lastmod>
20+
<lastmod>2021-04-03</lastmod>
2121
<changefreq>daily</changefreq>
2222
</url><url>
2323
<loc>https://pawamoy.github.io/pytkdocs/reference/__main__/</loc>
24-
<lastmod>2021-02-28</lastmod>
24+
<lastmod>2021-04-03</lastmod>
2525
<changefreq>daily</changefreq>
2626
</url><url>
2727
<loc>https://pawamoy.github.io/pytkdocs/reference/cli/</loc>
28-
<lastmod>2021-02-28</lastmod>
28+
<lastmod>2021-04-03</lastmod>
2929
<changefreq>daily</changefreq>
3030
</url><url>
3131
<loc>https://pawamoy.github.io/pytkdocs/reference/loader/</loc>
32-
<lastmod>2021-02-28</lastmod>
32+
<lastmod>2021-04-03</lastmod>
3333
<changefreq>daily</changefreq>
3434
</url><url>
3535
<loc>https://pawamoy.github.io/pytkdocs/reference/objects/</loc>
36-
<lastmod>2021-02-28</lastmod>
36+
<lastmod>2021-04-03</lastmod>
3737
<changefreq>daily</changefreq>
3838
</url><url>
3939
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/__init__/</loc>
40-
<lastmod>2021-02-28</lastmod>
40+
<lastmod>2021-04-03</lastmod>
4141
<changefreq>daily</changefreq>
4242
</url><url>
4343
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/attributes/</loc>
44-
<lastmod>2021-02-28</lastmod>
44+
<lastmod>2021-04-03</lastmod>
4545
<changefreq>daily</changefreq>
4646
</url><url>
4747
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/docstrings/__init__/</loc>
48-
<lastmod>2021-02-28</lastmod>
48+
<lastmod>2021-04-03</lastmod>
4949
<changefreq>daily</changefreq>
5050
</url><url>
5151
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/docstrings/base/</loc>
52-
<lastmod>2021-02-28</lastmod>
52+
<lastmod>2021-04-03</lastmod>
5353
<changefreq>daily</changefreq>
5454
</url><url>
5555
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/docstrings/google/</loc>
56-
<lastmod>2021-02-28</lastmod>
56+
<lastmod>2021-04-03</lastmod>
5757
<changefreq>daily</changefreq>
5858
</url><url>
5959
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/docstrings/numpy/</loc>
60-
<lastmod>2021-02-28</lastmod>
60+
<lastmod>2021-04-03</lastmod>
6161
<changefreq>daily</changefreq>
6262
</url><url>
6363
<loc>https://pawamoy.github.io/pytkdocs/reference/parsers/docstrings/restructured_text/</loc>
64-
<lastmod>2021-02-28</lastmod>
64+
<lastmod>2021-04-03</lastmod>
6565
<changefreq>daily</changefreq>
6666
</url><url>
6767
<loc>https://pawamoy.github.io/pytkdocs/reference/properties/</loc>
68-
<lastmod>2021-02-28</lastmod>
68+
<lastmod>2021-04-03</lastmod>
6969
<changefreq>daily</changefreq>
7070
</url><url>
7171
<loc>https://pawamoy.github.io/pytkdocs/reference/serializer/</loc>
72-
<lastmod>2021-02-28</lastmod>
72+
<lastmod>2021-04-03</lastmod>
7373
<changefreq>daily</changefreq>
7474
</url><url>
7575
<loc>https://pawamoy.github.io/pytkdocs/contributing/</loc>
76-
<lastmod>2021-02-28</lastmod>
76+
<lastmod>2021-04-03</lastmod>
7777
<changefreq>daily</changefreq>
7878
</url><url>
7979
<loc>https://pawamoy.github.io/pytkdocs/code_of_conduct/</loc>
80-
<lastmod>2021-02-28</lastmod>
80+
<lastmod>2021-04-03</lastmod>
8181
<changefreq>daily</changefreq>
8282
</url><url>
8383
<loc>https://pawamoy.github.io/pytkdocs/coverage/</loc>
84-
<lastmod>2021-02-28</lastmod>
84+
<lastmod>2021-04-03</lastmod>
8585
<changefreq>daily</changefreq>
8686
</url>
8787
</urlset>

‎sitemap.xml.gz‎

2 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)