pdoc 15.0.2__py3-none-any.whl → 15.0.4__py3-none-any.whl

pdoc/__init__.py

@@ -481,7 +481,7 @@ You can find an example in [`examples/library-usage`](https://github.com/mitmpro
 from __future__ import annotations
 
 __docformat__ = "markdown"  # explicitly disable rST processing in the examples above.
-__version__ = "15.0.2"  # this is read from setup.py
+__version__ = "15.0.4"  # this is read from setup.py
 
 from pathlib import Path
 from typing import overload

pdoc/extract.py

@@ -112,7 +112,7 @@ def parse_spec(spec: Path | str) -> str:
                     raise ModuleNotFoundError
         except pdoc.docstrings.AnyException:
             # Module does not exist, use local file.
-            spec = pspec
+            spec = pspec.resolve()
         else:
             # Module does exist. We now check if the local file/directory is the same (e.g. after pip install -e),
             # and emit a warning if that's not the case.

pdoc/render_helpers.py

@@ -61,7 +61,7 @@ markdown_extensions = {
     "cuddled-lists": None,
     "fenced-code-blocks": {"cssclass": formatter.cssclass},
     "footnotes": None,
-    "header-ids": None,
+    "header-ids": {"mixed": True, "prefix": None, "reset-count": True},
     "link-patterns": None,
     "markdown-in-html": None,
     "mermaid": None,

pdoc/templates/content.css

@@ -45,13 +45,27 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
 }
 
 /* Admonitions are currently not stylable via theme.css */
-.pdoc .alert.note  {
+.pdoc .alert.note {
     color: #084298;
     background-color: #cfe2ff;
     border-color: #b6d4fe;
     background-image: url("data:image/svg+xml,{% filter urlencode %}{% include 'resources/info-circle-fill.svg' %}{% endfilter %}");
 }
 
+.pdoc .alert.tip {
+    color: #0a3622;
+    background-color: #d1e7dd;
+    border-color: #a3cfbb;
+    background-image: url("data:image/svg+xml,{% filter urlencode %}{% include 'resources/lightbulb.svg' %}{% endfilter %}");
+}
+
+.pdoc .alert.important {
+    color: #055160;
+    background-color: #cff4fc;
+    border-color: #9eeaf9;
+    background-image: url("data:image/svg+xml,{% filter urlencode %}{% include 'resources/exclamation-square-fill.svg' %}{% endfilter %}");
+}
+
 .pdoc .alert.warning {
     color: #664d03;
     background-color: #fff3cd;
@@ -59,6 +73,13 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
     background-image: url("data:image/svg+xml,{% filter urlencode %}{% include 'resources/exclamation-triangle-fill.svg' %}{% endfilter %}");
 }
 
+.pdoc .alert.caution {
+    color: #842029;
+    background-color: #f8d7da;
+    border-color: #f5c2c7;
+    background-image: url("data:image/svg+xml,{% filter urlencode %}{% include 'resources/exclamation-octagon-fill.svg' %}{% endfilter %}");
+}
+
 .pdoc .alert.danger {
     color: #842029;
     background-color: #f8d7da;

pdoc/templates/resources/exclamation-octagon-fill.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="#842029" viewBox="0 0 16 16"><path d="M11.46.146A.5.5 0 0 0 11.107 0H4.893a.5.5 0 0 0-.353.146L.146 4.54A.5.5 0 0 0 0 4.893v6.214a.5.5 0 0 0 .146.353l4.394 4.394a.5.5 0 0 0 .353.146h6.214a.5.5 0 0 0 .353-.146l4.394-4.394a.5.5 0 0 0 .146-.353V4.893a.5.5 0 0 0-.146-.353zM8 4c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995A.905.905 0 0 1 8 4m.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2"/></svg>

pdoc/templates/resources/exclamation-square-fill.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="#055160" viewBox="0 0 16 16"><path d="M2 0a2 2 0 0 0-2 2v12a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V2a2 2 0 0 0-2-2zm6 4c.535 0 .954.462.9.995l-.35 3.507a.552.552 0 0 1-1.1 0L7.1 4.995A.905.905 0 0 1 8 4m.002 6a1 1 0 1 1 0 2 1 1 0 0 1 0-2"/></svg>

pdoc/templates/resources/lightbulb.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" fill="#0a3622" viewBox="0 0 16 16"><path d="M2 6a6 6 0 1 1 10.174 4.31c-.203.196-.359.4-.453.619l-.762 1.769A.5.5 0 0 1 10.5 13a.5.5 0 0 1 0 1 .5.5 0 0 1 0 1l-.224.447a1 1 0 0 1-.894.553H6.618a1 1 0 0 1-.894-.553L5.5 15a.5.5 0 0 1 0-1 .5.5 0 0 1 0-1 .5.5 0 0 1-.46-.302l-.761-1.77a2 2 0 0 0-.453-.618A5.98 5.98 0 0 1 2 6m6-5a5 5 0 0 0-3.479 8.592c.263.254.514.564.676.941L5.83 12h4.342l.632-1.467c.162-.377.413-.687.676-.941A5 5 0 0 0 8 1"/></svg>

{pdoc-15.0.2.dist-info → pdoc-15.0.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 15.0.2
+Version: 15.0.4
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0

{pdoc-15.0.2.dist-info → pdoc-15.0.4.dist-info}/RECORD

@@ -1,4 +1,4 @@
-pdoc/__init__.py,sha256=jnoeoAPOPSzWTb12xjX2gUW4SV_TUCS1QS6JdnavNOA,21456
+pdoc/__init__.py,sha256=1kfrQ7wmlLK_Wcspc4sQmC8sLWv-5L2RZxl8cshrGoQ,21456
 pdoc/__main__.py,sha256=DOXWKG7I0M-E9uSs8a--9RGJNI266_2VKZpVQR4paj0,8416
 pdoc/_compat.py,sha256=iXM2kfvS8oRg30EuA-HYWyVt5iorA5JrJHAhUZvsuu4,1447
 pdoc/doc.py,sha256=866peOsabjNx-rexUlF41K9GYBYHqEaMv_fQUuF8gD4,50099
@@ -6,10 +6,10 @@ pdoc/doc_ast.py,sha256=qoWLta30b2XTlwj9fI15IM0687T0dIp9Vk5bB325O60,11345
 pdoc/doc_pyi.py,sha256=r2QdI8WeUxY6jQ9O4xmL3m1zPVmIpxEAviqLYt_M5gk,5078
 pdoc/doc_types.py,sha256=tcZysNBSHk1tAxbr4JSmDARoLkHlxINVW6UYvEtzUvs,8465
 pdoc/docstrings.py,sha256=m3yzwekXlQxY-_wcVEyLzT6A6hJyY-yp95ooyzx90uA,17187
-pdoc/extract.py,sha256=1EtgteSdCF61Z5kr4nR3fL9BXwKoJ9FM92aNCPS48nM,14227
+pdoc/extract.py,sha256=8WAtzxjkTmUrGb4q4T4URyr8-Y0WM0FDEb5DcTH0TMA,14237
 pdoc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 pdoc/render.py,sha256=8vXpDlqzRayJdaH0oU6nA6aApFYeGrtxVLOmCD7EbIU,7081
-pdoc/render_helpers.py,sha256=Db-uB28WkWird--4Rtu4klJnP6S7p3LJFsaAXiH4fJQ,20395
+pdoc/render_helpers.py,sha256=6BmkERvKsxSAi9StsXbfzUro4zfhstDOPTgyMnp3bKM,20443
 pdoc/search.py,sha256=RGFaRftEQOg1Mw4FEOmJVRY9DhBncBYSFi5r4MSknTM,7248
 pdoc/web.py,sha256=9pRpukVWMEoWbthB1E9Yrg86KoSNmXMeBicno_cVcPQ,6933
 pdoc/markdown2/LICENSE,sha256=BfcOT5Iu-7wDaKcbIta8wkP-pFncOu4yXeBlMfbeYGI,1116
@@ -17,7 +17,7 @@ pdoc/markdown2/README.md,sha256=-b2NGwLPzTBnaCGPSqRCzHxSrqArlXxGG5w0c6pOqFk,200
 pdoc/markdown2/__init__.py,sha256=guvOlezAha8NQBH8TFkEwiP4zFy5tsV2NVYiEOWD2jg,159248
 pdoc/templates/README.md,sha256=ukxrGoYYCIYkScS5j2Dge8c3VEd01AzOiIKq6yl5OqE,1780
 pdoc/templates/build-search-index.js,sha256=igiRW84j_aRFmGv5j48e8gnWeTgfdL8Rs930vHOUYyU,982
-pdoc/templates/content.css,sha256=qKEm-MSpTgcAKP8PRO1vD_YfZDbUcOKpIvuOgDBBMlI,9344
+pdoc/templates/content.css,sha256=pkc5pL1CmGlgO3Kz7n6EHh1UbQ7vH9y17h7A-ytLEzY,10060
 pdoc/templates/custom.css,sha256=62cn8AmBJiplFJyAKXoZSlVa1s3lNOjkYwDp20pF-ew,106
 pdoc/templates/layout.css,sha256=xv7AgPtHiazW7S2AtNebRr2BKmOSPmX2wwcejXBRfQ0,4670
 pdoc/templates/livereload.html.jinja2,sha256=VHbZWN_dBRgBpaRzszvXbbX278-fzbok0JRIOeLep_E,566
@@ -42,14 +42,17 @@ pdoc/templates/deprecated/resources/favicon.svg,sha256=RM3DlJFPg4twb-v6dL3vSu9Zm
 pdoc/templates/resources/bootstrap-reboot.min.css,sha256=X9DhdaB62rZ-cUk2UhTGjbN48CChqT9kFvLgIjwix3s,4618
 pdoc/templates/resources/box-arrow-in-left.svg,sha256=i4IOdAa7nbkX3CVcc1z0vrpONTqFINOJvOf8vU_Ylsc,552
 pdoc/templates/resources/elasticlunr.min.js,sha256=B-hZUi0E_veZiR7dW0WSTq2ozGAoj_6VjREZuMfjs_U,17929
+pdoc/templates/resources/exclamation-octagon-fill.svg,sha256=vkUqGPYuZgqSexKP8N3BTQq0bjdKxWsItvzRfXsdzT8,469
+pdoc/templates/resources/exclamation-square-fill.svg,sha256=GE8DR1V5FCUrPx3siSx3d1NcFqjeIgJ_q1LcOeW_Y9Q,307
 pdoc/templates/resources/exclamation-triangle-fill.svg,sha256=9GIZHEl8zT2TlhXG_OPuM_HoCGSJskNCv1FYBVzg2hk,363
 pdoc/templates/resources/info-circle-fill.svg,sha256=kO3AMXfWtacpJPzC8Pvihf46OZd6Kpm5SjBRGhXLWQc,390
+pdoc/templates/resources/lightbulb.svg,sha256=vjDgQP8uYPryTQgSKnK_bywjX9ob-we5kTySyJ3DI9s,510
 pdoc/templates/resources/lightning-fill.svg,sha256=XEyCtbgxeAlwCezdsf7N0NFd5aMjwqyJJDpaFbYYTFA,265
 pdoc/templates/resources/navtoggle.svg,sha256=WVR0BJIucX0MgwwEawmfX0qYD1i_dSbUhoGnqPef3jw,187
 pdoc/templates/resources/pdoc-logo.svg,sha256=w5OsMmytDaA2Fr9CobeQQFxBNx4-wFFHtLvkORj0gjk,6989
-pdoc-15.0.2.dist-info/LICENSE,sha256=LrhIeJ7gKTDPyOX9YVuZGr9mpmyjpkvqH6LjxvE0szM,898
-pdoc-15.0.2.dist-info/METADATA,sha256=448hBCXQ-y-3rZfozXBq0dbJZG83T24O-pBdooMTsos,6775
-pdoc-15.0.2.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-pdoc-15.0.2.dist-info/entry_points.txt,sha256=-bK-S1ZvmqCWqi1hGnsl5nayWkzXB1BEs-Cynh5QZaI,43
-pdoc-15.0.2.dist-info/top_level.txt,sha256=rg5eIToBHzwTfZZi1E7NVHgie5joQuSuU1rWV0qKS9k,5
-pdoc-15.0.2.dist-info/RECORD,,
+pdoc-15.0.4.dist-info/LICENSE,sha256=LrhIeJ7gKTDPyOX9YVuZGr9mpmyjpkvqH6LjxvE0szM,898
+pdoc-15.0.4.dist-info/METADATA,sha256=4Jt9Y3u8F9FltJDZIGotjrOt4wx4ZKhlsZfipNL9uwU,6775
+pdoc-15.0.4.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+pdoc-15.0.4.dist-info/entry_points.txt,sha256=-bK-S1ZvmqCWqi1hGnsl5nayWkzXB1BEs-Cynh5QZaI,43
+pdoc-15.0.4.dist-info/top_level.txt,sha256=rg5eIToBHzwTfZZi1E7NVHgie5joQuSuU1rWV0qKS9k,5
+pdoc-15.0.4.dist-info/RECORD,,