pdoc 15.0.2__tar.gz → 15.0.4__tar.gz

{pdoc-15.0.2 → pdoc-15.0.4}/CHANGELOG.md

@@ -5,12 +5,24 @@
 ## Unreleased: pdoc next
 
 
+## 2025-06-04: pdoc 15.0.4
+
+- Include included HTML headers in the ToC by default by enabling markdown2's `mixed=True` option of the `header-ids` extra
+  (#806, @mrossinek)
+- Make `pdoc .` work to document the module in the current directory.
+  ([#813](https://github.com/mitmproxy/pdoc/pull/813), @mhils)
+
+## 2025-04-21: pdoc 15.0.3
+
+- Add missing styles for Github's markdown alerts.
+  ([#796](https://github.com/mitmproxy/pdoc/pull/796), @Steve-Tech)
+
 ## 2025-04-17: pdoc 15.0.2
 
 - Fix a bug where type aliases wouldn't be linked.
   ([#798](https://github.com/mitmproxy/pdoc/pull/798), @mhils)
 - Fix a bug where invalid Numpydoc docstrings would raise an exception.
-  ([#789](https://github.com/mitmproxy/pdoc/pull/789), @mhils)
+  ([#789](https://github.com/mitmproxy/pdoc/pull/789), @tobiscode, @mhils)
 - Improve debuggability of docstring processing
   ([#784](https://github.com/mitmproxy/pdoc/pull/784), @tobiscode)
 - Fix handling of URL-escaped module names

{pdoc-15.0.2/pdoc.egg-info → pdoc-15.0.4}/PKG-INFO

@@ -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 → pdoc-15.0.4}/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-15.0.2 → pdoc-15.0.4}/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-15.0.2 → pdoc-15.0.4}/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-15.0.2 → pdoc-15.0.4}/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-15.0.4/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-15.0.4/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-15.0.4/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 → pdoc-15.0.4/pdoc.egg-info}/PKG-INFO

@@ -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 → pdoc-15.0.4}/pdoc.egg-info/SOURCES.txt

@@ -53,8 +53,11 @@ pdoc/templates/deprecated/resources/favicon.svg
 pdoc/templates/resources/bootstrap-reboot.min.css
 pdoc/templates/resources/box-arrow-in-left.svg
 pdoc/templates/resources/elasticlunr.min.js
+pdoc/templates/resources/exclamation-octagon-fill.svg
+pdoc/templates/resources/exclamation-square-fill.svg
 pdoc/templates/resources/exclamation-triangle-fill.svg
 pdoc/templates/resources/info-circle-fill.svg
+pdoc/templates/resources/lightbulb.svg
 pdoc/templates/resources/lightning-fill.svg
 pdoc/templates/resources/navtoggle.svg
 pdoc/templates/resources/pdoc-logo.svg

{pdoc-15.0.2 → pdoc-15.0.4}/test/test_extract.py

@@ -100,6 +100,10 @@ def test_parse_spec(monkeypatch):
     assert str(here / "testdata") in sys.path
     sys.path = p
 
+    monkeypatch.chdir(here / "testdata" / "demopackage" / "subpackage")
+    assert parse_spec(".") == "demopackage.subpackage"
+    assert parse_spec("..") == "demopackage"
+
 
 def test_parse_spec_mod_and_dir(tmp_path, monkeypatch):
     """Test that we display a warning when both a module and a local directory exist with the provided name."""

{pdoc-15.0.2 → pdoc-15.0.4}/test/test_render_helpers.py

@@ -110,6 +110,22 @@ def test_markdown_toc():
     assert to_html("#foo\n#bar").toc_html  # type: ignore
 
 
+def test_mixed_toc():
+    """
+    markdown2 can handle mixed markdown and HTML headings.
+
+    Let's test that this works as expected.
+    """
+    expected = [
+        "<ul>",
+        '  <li><a href="#foo">foo</a></li>',
+        '  <li><a href="#bar">bar</a></li>',
+        "</ul>",
+        "",
+    ]
+    assert to_html("#foo\n<h1>bar</h1>").toc_html == "\n".join(expected)
+
+
 @pytest.mark.parametrize(
     "md,html",
     [