pdoc 15.0.3__tar.gz → 16.0.0__tar.gz

{pdoc-15.0.3 → pdoc-16.0.0}/CHANGELOG.md

@@ -5,6 +5,32 @@
 ## Unreleased: pdoc next
 
 
+## 2025-10-27: pdoc 16.0.0
+
+- pdoc has a new logo. 🐍
+  ([#838](https://github.com/mitmproxy/pdoc/pull/838), @mhils)
+- Add support for Python 3.14.
+  ([#843](https://github.com/mitmproxy/pdoc/pull/843), @mhils)
+- Drop support for Python 3.9, which as reached
+  [end of life](https://devguide.python.org/versions/).
+  ([#842](https://github.com/mitmproxy/pdoc/pull/842), @mhils)
+- Fix linking of identifiers that contain unicode characters.
+  ([#831](https://github.com/mitmproxy/pdoc/issues/831), @iFreilicht)
+- Replace vendored version of `markdown2` with the [official
+  upstream](https://github.com/trentm/python-markdown2)
+- Add support for keyword args for Google flavor docs.
+  ([#840](https://github.com/mitmproxy/pdoc/pull/840), @aleksslitvinovs)
+- Add support for Pydantic-style field docstrings,
+  e.g. `pydantic.Field(description="...")`
+  ([#802](https://github.com/mitmproxy/pdoc/pull/802), @jinnovation)
+
+## 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.

{pdoc-15.0.3/pdoc.egg-info → pdoc-16.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 15.0.3
+Version: 16.0.0
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0
@@ -16,24 +16,25 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Jinja2>=2.11.0
 Requires-Dist: pygments>=2.12.0
 Requires-Dist: MarkupSafe>=1.1.1
+Requires-Dist: markdown2>=2.5.4
 
 <p align="center">
 <a href="https://pdoc.dev/"><img alt="pdoc" src="https://pdoc.dev/logo.svg" width="200" height="100" /></a>
 <br><br>
-<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg"></a>
-<img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github">
+<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIj48cGF0aCBkPSJNNjcuODA3IDIzLjI0NGMtMTguMDMyIDUuNTIzLTI0LjI3MyA5LjQxMS0zMy4xOTMgMTYuMTY5UzE5LjQwNyA1MS4xMjUgOS4zNCA2OS43NkMzLjI3IDgwLjk5Ni44MjcgOTkuMjcxIDEgMTExLjY3OWMuMTE0IDguMTY5IDIuMTg4IDEzLjU1OSAyLjE4OCAxMy41NTlTNDIuMzI2IDI0Ny4yNyAyMC40MzUgMjc4LjEwNWMtMTAuNDg4IDE0Ljc3MyA4NC40MjIgMjcuMDA3IDgwLjA0NyAxMC40NS0xMC4zOTctMzkuMzQ4LTI3LjU5NS05Ny40MDktMzEuOTA4LTExMy42NjctMy4wNDctMTEuNDg0IDguMTYtMjEuOTk1IDE2LjI5NS0yNy4zNDMgMy4zODMtMi4yMjQgOC4wNTEtMy43ODYgOC4wNTEtMy43ODZsNTEuOTI0LTE1LjU5NXMyMy44MDktOC41NzkgMzQuMDYyLTI2LjU2NyAxMi42ODktMzcuNTg0IDEyLjY4OS0zNy41ODQuNDk1LTE2LjU4OC01LjkzOS0yMy4xNC0yLjczMi01Ljg2Ni0xOC42NDYtMTIuNDk4LTQ5LjEyMi0xMC4wNTMtNDkuMTIyLTEwLjA1My0zMi4wNDktLjYwMi01MC4wODEgNC45MjF6IiBmaWxsPSIjMjBhZDZjIi8+PGcgdHJhbnNmb3JtPSJyb3RhdGUoMzQzLjk5MykiPjxlbGxpcHNlIGN4PSI1Mi4yNzYiIGN5PSI5NC4wODkiIGZpbGw9IiNmZmYiIHJ4PSIyNy44NTIiIHJ5PSIyNy44MjMiLz48ZWxsaXBzZSBjeD0iNTIuNTM4IiBjeT0iOTQuNjg5IiByeD0iMTguNjg4IiByeT0iMTguMzMxIiBmaWxsPSIjMTA1YTQ4Ii8+PGVsbGlwc2UgY3g9IjYzLjMzMyIgY3k9Ijg2LjMiIGZpbGw9IiNmZmYiIHJ4PSI3LjU5NiIgcnk9IjcuNTg4Ii8+PC9nPjxnIGZpbGw9IiMxMDVhNDgiPjxlbGxpcHNlIGN4PSI5NC4xNTQiIGN5PSIxMzUuNzM0IiByeD0iNC41MDUiIHJ5PSI1LjI1NyIgdHJhbnNmb3JtPSJyb3RhdGUoMzI1LjAxNSkiLz48ZWxsaXBzZSBjeD0iMTY3Ljg2IiBjeT0iNTYuOTUxIiByeD0iNC40ODQiIHJ5PSI1LjIzMSIgdHJhbnNmb3JtPSJyb3RhdGUoMzU4Ljc3OSkiLz48L2c+PHBhdGggZD0iTTE4OC45NjIgNzcuNDU4bC0zNC4yNDggMTAuMTcxYy02Ljg3OCAxLjk3My05Ljk3NCAzLjM4OC0xNC44ODggMy42NnMtMTAuODY4LTEuODY5LTEwLjg2OC0xLjg2OWwtMi4zNDIgOC42MzNjMi4xOTcuOTQ0IDkuOTY5IDIuMzkgMTQuNzU2IDIuNTkyczE1LjU4Mi0yLjQ2IDE1LjU4Mi0yLjQ2bDI3LjQ3MS03LjUzNGMxLjk1MS00LjcwOSAzLjQzMi05LjIzOCA0LjUzNy0xMy4xOTN6IiBmaWxsPSIjZTc4MzYxIi8+PC9zdmc+"></a>
+<a href="https://github.com/mitmproxy/pdoc/actions"><img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github"></a>
 <img height="20" alt="Code Coverage" src="https://shields.mitmproxy.org/badge/coverage-100%25-brightgreen">
 <a href="https://autofix.ci"><img height="20" alt="autofix.ci: yes" src="https://shields.mitmproxy.org/badge/autofix.ci-yes-success?logo=data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMTI4IDEyOCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCB0cmFuc2Zvcm09InNjYWxlKDAuMDYxLC0wLjA2MSkgdHJhbnNsYXRlKC0yNTAsLTE3NTApIiBkPSJNMTMyNSAtMzQwcS0xMTUgMCAtMTY0LjUgMzIuNXQtNDkuNSAxMTQuNXEwIDMyIDUgNzAuNXQxMC41IDcyLjV0NS41IDU0djIyMHEtMzQgLTkgLTY5LjUgLTE0dC03MS41IC01cS0xMzYgMCAtMjUxLjUgNjJ0LTE5MSAxNjl0LTkyLjUgMjQxcS05MCAxMjAgLTkwIDI2NnEwIDEwOCA0OC41IDIwMC41dDEzMiAxNTUuNXQxODguNSA4MXExNSA5OSAxMDAuNSAxODAuNXQyMTcgMTMwLjV0MjgyLjUgNDlxMTM2IDAgMjU2LjUgLTQ2IHQyMDkgLTEyNy41dDEyOC41IC0xODkuNXExNDkgLTgyIDIyNyAtMjEzLjV0NzggLTI5OS41cTAgLTEzNiAtNTggLTI0NnQtMTY1LjUgLTE4NC41dC0yNTYuNSAtMTAzLjVsLTI0MyAtMzAwdi01MnEwIC0yNyAzLjUgLTU2LjV0Ni41IC01Ny41dDMgLTUycTAgLTg1IC00MS41IC0xMTguNXQtMTU3LjUgLTMzLjV6TTEzMjUgLTI2MHE3NyAwIDk4IDE0LjV0MjEgNTcuNXEwIDI5IC0zIDY4dC02LjUgNzN0LTMuNSA0OHY2NGwyMDcgMjQ5IHEtMzEgMCAtNjAgNS41dC01NCAxMi41bC0xMDQgLTEyM3EtMSAzNCAtMiA2My41dC0xIDU0LjVxMCA2OSA5IDEyM2wzMSAyMDBsLTExNSAtMjhsLTQ2IC0yNzFsLTIwNSAyMjZxLTE5IC0xNSAtNDMgLTI4LjV0LTU1IC0yNi41bDIxOSAtMjQydi0yNzZxMCAtMjAgLTUuNSAtNjB0LTEwLjUgLTc5dC01IC01OHEwIC00MCAzMCAtNTMuNXQxMDQgLTEzLjV6TTEyNjIgNjE2cS0xMTkgMCAtMjI5LjUgMzQuNXQtMTkzLjUgOTYuNWw0OCA2NCBxNzMgLTU1IDE3MC41IC04NXQyMDQuNSAtMzBxMTM3IDAgMjQ5IDQ1LjV0MTc5IDEyMXQ2NyAxNjUuNWg4MHEwIC0xMTQgLTc3LjUgLTIwNy41dC0yMDggLTE0OXQtMjg5LjUgLTU1LjV6TTgwMyA1OTVxODAgMCAxNDkgMjkuNXQxMDggNzIuNWwyMjEgLTY3bDMwOSA4NnE0NyAtMzIgMTA0LjUgLTUwdDExNy41IC0xOHE5MSAwIDE2NSAzOHQxMTguNSAxMDMuNXQ0NC41IDE0Ni41cTAgNzYgLTM0LjUgMTQ5dC05NS41IDEzNHQtMTQzIDk5IHEtMzcgMTA3IC0xMTUuNSAxODMuNXQtMTg2IDExNy41dC0yMzAuNSA0MXEtMTAzIDAgLTE5Ny41IC0yNnQtMTY5IC03Mi41dC0xMTcuNSAtMTA4dC00MyAtMTMxLjVxMCAtMzQgMTQuNSAtNjIuNXQ0MC41IC01MC41bC01NSAtNTlxLTM0IDI5IC01NCA2NS41dC0yNSA4MS41cS04MSAtMTggLTE0NSAtNzB0LTEwMSAtMTI1LjV0LTM3IC0xNTguNXEwIC0xMDIgNDguNSAtMTgwLjV0MTI5LjUgLTEyM3QxNzkgLTQ0LjV6Ii8+PC9zdmc+"></a>
 <a href="https://pypi.python.org/pypi/pdoc"><img height="20" alt="PyPI Version" src="https://shields.mitmproxy.org/pypi/v/pdoc.svg"></a>
@@ -52,7 +53,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.9 and newer.
+pdoc is compatible with Python 3.10 and newer.
 
 
 # Usage

{pdoc-15.0.3 → pdoc-16.0.0}/README.md

@@ -1,8 +1,8 @@
 <p align="center">
 <a href="https://pdoc.dev/"><img alt="pdoc" src="https://pdoc.dev/logo.svg" width="200" height="100" /></a>
 <br><br>
-<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg"></a>
-<img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github">
+<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIj48cGF0aCBkPSJNNjcuODA3IDIzLjI0NGMtMTguMDMyIDUuNTIzLTI0LjI3MyA5LjQxMS0zMy4xOTMgMTYuMTY5UzE5LjQwNyA1MS4xMjUgOS4zNCA2OS43NkMzLjI3IDgwLjk5Ni44MjcgOTkuMjcxIDEgMTExLjY3OWMuMTE0IDguMTY5IDIuMTg4IDEzLjU1OSAyLjE4OCAxMy41NTlTNDIuMzI2IDI0Ny4yNyAyMC40MzUgMjc4LjEwNWMtMTAuNDg4IDE0Ljc3MyA4NC40MjIgMjcuMDA3IDgwLjA0NyAxMC40NS0xMC4zOTctMzkuMzQ4LTI3LjU5NS05Ny40MDktMzEuOTA4LTExMy42NjctMy4wNDctMTEuNDg0IDguMTYtMjEuOTk1IDE2LjI5NS0yNy4zNDMgMy4zODMtMi4yMjQgOC4wNTEtMy43ODYgOC4wNTEtMy43ODZsNTEuOTI0LTE1LjU5NXMyMy44MDktOC41NzkgMzQuMDYyLTI2LjU2NyAxMi42ODktMzcuNTg0IDEyLjY4OS0zNy41ODQuNDk1LTE2LjU4OC01LjkzOS0yMy4xNC0yLjczMi01Ljg2Ni0xOC42NDYtMTIuNDk4LTQ5LjEyMi0xMC4wNTMtNDkuMTIyLTEwLjA1My0zMi4wNDktLjYwMi01MC4wODEgNC45MjF6IiBmaWxsPSIjMjBhZDZjIi8+PGcgdHJhbnNmb3JtPSJyb3RhdGUoMzQzLjk5MykiPjxlbGxpcHNlIGN4PSI1Mi4yNzYiIGN5PSI5NC4wODkiIGZpbGw9IiNmZmYiIHJ4PSIyNy44NTIiIHJ5PSIyNy44MjMiLz48ZWxsaXBzZSBjeD0iNTIuNTM4IiBjeT0iOTQuNjg5IiByeD0iMTguNjg4IiByeT0iMTguMzMxIiBmaWxsPSIjMTA1YTQ4Ii8+PGVsbGlwc2UgY3g9IjYzLjMzMyIgY3k9Ijg2LjMiIGZpbGw9IiNmZmYiIHJ4PSI3LjU5NiIgcnk9IjcuNTg4Ii8+PC9nPjxnIGZpbGw9IiMxMDVhNDgiPjxlbGxpcHNlIGN4PSI5NC4xNTQiIGN5PSIxMzUuNzM0IiByeD0iNC41MDUiIHJ5PSI1LjI1NyIgdHJhbnNmb3JtPSJyb3RhdGUoMzI1LjAxNSkiLz48ZWxsaXBzZSBjeD0iMTY3Ljg2IiBjeT0iNTYuOTUxIiByeD0iNC40ODQiIHJ5PSI1LjIzMSIgdHJhbnNmb3JtPSJyb3RhdGUoMzU4Ljc3OSkiLz48L2c+PHBhdGggZD0iTTE4OC45NjIgNzcuNDU4bC0zNC4yNDggMTAuMTcxYy02Ljg3OCAxLjk3My05Ljk3NCAzLjM4OC0xNC44ODggMy42NnMtMTAuODY4LTEuODY5LTEwLjg2OC0xLjg2OWwtMi4zNDIgOC42MzNjMi4xOTcuOTQ0IDkuOTY5IDIuMzkgMTQuNzU2IDIuNTkyczE1LjU4Mi0yLjQ2IDE1LjU4Mi0yLjQ2bDI3LjQ3MS03LjUzNGMxLjk1MS00LjcwOSAzLjQzMi05LjIzOCA0LjUzNy0xMy4xOTN6IiBmaWxsPSIjZTc4MzYxIi8+PC9zdmc+"></a>
+<a href="https://github.com/mitmproxy/pdoc/actions"><img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github"></a>
 <img height="20" alt="Code Coverage" src="https://shields.mitmproxy.org/badge/coverage-100%25-brightgreen">
 <a href="https://autofix.ci"><img height="20" alt="autofix.ci: yes" src="https://shields.mitmproxy.org/badge/autofix.ci-yes-success?logo=data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMTI4IDEyOCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCB0cmFuc2Zvcm09InNjYWxlKDAuMDYxLC0wLjA2MSkgdHJhbnNsYXRlKC0yNTAsLTE3NTApIiBkPSJNMTMyNSAtMzQwcS0xMTUgMCAtMTY0LjUgMzIuNXQtNDkuNSAxMTQuNXEwIDMyIDUgNzAuNXQxMC41IDcyLjV0NS41IDU0djIyMHEtMzQgLTkgLTY5LjUgLTE0dC03MS41IC01cS0xMzYgMCAtMjUxLjUgNjJ0LTE5MSAxNjl0LTkyLjUgMjQxcS05MCAxMjAgLTkwIDI2NnEwIDEwOCA0OC41IDIwMC41dDEzMiAxNTUuNXQxODguNSA4MXExNSA5OSAxMDAuNSAxODAuNXQyMTcgMTMwLjV0MjgyLjUgNDlxMTM2IDAgMjU2LjUgLTQ2IHQyMDkgLTEyNy41dDEyOC41IC0xODkuNXExNDkgLTgyIDIyNyAtMjEzLjV0NzggLTI5OS41cTAgLTEzNiAtNTggLTI0NnQtMTY1LjUgLTE4NC41dC0yNTYuNSAtMTAzLjVsLTI0MyAtMzAwdi01MnEwIC0yNyAzLjUgLTU2LjV0Ni41IC01Ny41dDMgLTUycTAgLTg1IC00MS41IC0xMTguNXQtMTU3LjUgLTMzLjV6TTEzMjUgLTI2MHE3NyAwIDk4IDE0LjV0MjEgNTcuNXEwIDI5IC0zIDY4dC02LjUgNzN0LTMuNSA0OHY2NGwyMDcgMjQ5IHEtMzEgMCAtNjAgNS41dC01NCAxMi41bC0xMDQgLTEyM3EtMSAzNCAtMiA2My41dC0xIDU0LjVxMCA2OSA5IDEyM2wzMSAyMDBsLTExNSAtMjhsLTQ2IC0yNzFsLTIwNSAyMjZxLTE5IC0xNSAtNDMgLTI4LjV0LTU1IC0yNi41bDIxOSAtMjQydi0yNzZxMCAtMjAgLTUuNSAtNjB0LTEwLjUgLTc5dC01IC01OHEwIC00MCAzMCAtNTMuNXQxMDQgLTEzLjV6TTEyNjIgNjE2cS0xMTkgMCAtMjI5LjUgMzQuNXQtMTkzLjUgOTYuNWw0OCA2NCBxNzMgLTU1IDE3MC41IC04NXQyMDQuNSAtMzBxMTM3IDAgMjQ5IDQ1LjV0MTc5IDEyMXQ2NyAxNjUuNWg4MHEwIC0xMTQgLTc3LjUgLTIwNy41dC0yMDggLTE0OXQtMjg5LjUgLTU1LjV6TTgwMyA1OTVxODAgMCAxNDkgMjkuNXQxMDggNzIuNWwyMjEgLTY3bDMwOSA4NnE0NyAtMzIgMTA0LjUgLTUwdDExNy41IC0xOHE5MSAwIDE2NSAzOHQxMTguNSAxMDMuNXQ0NC41IDE0Ni41cTAgNzYgLTM0LjUgMTQ5dC05NS41IDEzNHQtMTQzIDk5IHEtMzcgMTA3IC0xMTUuNSAxODMuNXQtMTg2IDExNy41dC0yMzAuNSA0MXEtMTAzIDAgLTE5Ny41IC0yNnQtMTY5IC03Mi41dC0xMTcuNSAtMTA4dC00MyAtMTMxLjVxMCAtMzQgMTQuNSAtNjIuNXQ0MC41IC01MC41bC01NSAtNTlxLTM0IDI5IC01NCA2NS41dC0yNSA4MS41cS04MSAtMTggLTE0NSAtNzB0LTEwMSAtMTI1LjV0LTM3IC0xNTguNXEwIC0xMDIgNDguNSAtMTgwLjV0MTI5LjUgLTEyM3QxNzkgLTQ0LjV6Ii8+PC9zdmc+"></a>
 <a href="https://pypi.python.org/pypi/pdoc"><img height="20" alt="PyPI Version" src="https://shields.mitmproxy.org/pypi/v/pdoc.svg"></a>
@@ -21,7 +21,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.9 and newer.
+pdoc is compatible with Python 3.10 and newer.
 
 
 # Usage

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/__init__.py

@@ -260,6 +260,25 @@ pdoc only interprets a subset of the reStructuredText specification.
 Adding additional syntax elements is usually easy. If you feel that pdoc doesn't parse a docstring element properly,
 please amend `pdoc.docstrings` and send us a pull request!
 
+## ...document Pydantic models?
+
+For [Pydantic models](https://docs.pydantic.dev/latest/concepts/models/), pdoc
+will extract [field](https://docs.pydantic.dev/latest/concepts/fields/)
+descriptions and treat them just like [documented
+variables](#document-variables). For example, the following two Pydantic models
+would have identical pdoc-rendered documentation:
+
+```python
+from pydantic import BaseModel, Field
+
+class Foo(BaseModel):
+    a: int = Field(description="Docs for field a.")
+
+class OtherFoo(BaseModel):
+    a: int
+    """Docs for field a."""
+
+```
 
 ## ...render math formulas?
 
@@ -481,7 +500,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.3"  # this is read from setup.py
+__version__ = "16.0.0"  # this is read from setup.py
 
 from pathlib import Path
 from typing import overload

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/_compat.py

@@ -13,20 +13,7 @@ else:  # pragma: no cover
     class TypeAliasType:
         """Placeholder class for TypeAliasType"""
 
-if sys.version_info >= (3, 10):
-    from typing import TypeAlias
-else:  # pragma: no cover
-    class TypeAlias:
-        pass
-
-if sys.version_info >= (3, 10):
-    from types import UnionType  # type: ignore
-else:  # pragma: no cover
-    class UnionType:
-        pass
-
-
-if (3, 9) <= sys.version_info < (3, 9, 8) or (3, 10) <= sys.version_info < (3, 10, 1):  # pragma: no cover
+if (3, 10) <= sys.version_info < (3, 10, 1):  # pragma: no cover
     import inspect
     import types
 
@@ -40,21 +27,9 @@ if (3, 9) <= sys.version_info < (3, 9, 8) or (3, 10) <= sys.version_info < (3, 1
 else:
     from inspect import formatannotation
 
-if sys.version_info >= (3, 10):
-    from typing import is_typeddict
-else:  # pragma: no cover
-    def is_typeddict(tp):
-        try:
-            return tp.__orig_bases__[-1].__name__ == "TypedDict"
-        except Exception:
-            return False
-
 
 __all__ = [
     "ast_TypeAlias",
     "TypeAliasType",
-    "TypeAlias",
-    "UnionType",
     "formatannotation",
-    "is_typeddict",
 ]

pdoc-16.0.0/pdoc/_pydantic.py

@@ -0,0 +1,54 @@
+"""Work with Pydantic models."""
+
+from __future__ import annotations
+
+import types
+from typing import Any
+from typing import TypeAlias
+from typing import TypeGuard
+
+try:
+    import pydantic
+except ImportError:  # pragma: no cover
+    pydantic = None  # type: ignore
+
+ClassOrModule: TypeAlias = type | types.ModuleType
+"""Type alias for the type of `Namespace.obj`."""
+
+IGNORED_FIELDS: frozenset[str] = frozenset(
+    (["__fields__"] + list(pydantic.BaseModel.__dict__.keys()))
+    if pydantic is not None
+    else []
+)
+"""Fields to ignore when generating docs, e.g. those that emit deprecation
+warnings or that are not relevant to users of BaseModel-derived classes."""
+
+
+def is_pydantic_model(obj: ClassOrModule) -> TypeGuard[pydantic.BaseModel]:
+    """Returns whether an object is a Pydantic model."""
+    if pydantic is None:  # pragma: no cover
+        # classes that subclass pydantic.BaseModel can only be instantiated if pydantic is importable
+        # => if we cannot import pydantic, the passed object cannot be a subclass of BaseModel.
+        return False
+
+    return isinstance(obj, type) and issubclass(obj, pydantic.BaseModel)
+
+
+def default_value(parent: ClassOrModule, name: str, obj: Any) -> Any:
+    """Determine the default value of obj.
+
+    For pydantic BaseModels, extract the default value from field metadata.
+    For all other objects, return `obj` as-is.
+    """
+    if is_pydantic_model(parent):
+        pydantic_fields = parent.__pydantic_fields__
+        return pydantic_fields[name].default if name in pydantic_fields else obj
+
+    return obj
+
+
+def get_field_docstring(parent: ClassOrModule, field_name: str) -> str | None:
+    if is_pydantic_model(parent):
+        if field := parent.__pydantic_fields__.get(field_name, None):
+            return field.description
+    return None

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/doc.py

@@ -38,19 +38,20 @@ import types
 from typing import Any
 from typing import ClassVar
 from typing import Generic
+from typing import TypeAlias
 from typing import TypedDict
 from typing import TypeVar
-from typing import Union
+from typing import cast
 from typing import get_origin
+from typing import is_typeddict
 import warnings
 
+from pdoc import _pydantic
 from pdoc import doc_ast
 from pdoc import doc_pyi
 from pdoc import extract
-from pdoc._compat import TypeAlias
 from pdoc._compat import TypeAliasType
 from pdoc._compat import formatannotation
-from pdoc._compat import is_typeddict
 from pdoc.doc_types import GenericAlias
 from pdoc.doc_types import NonUserDefinedCallables
 from pdoc.doc_types import empty
@@ -210,7 +211,10 @@ class Doc(Generic[T]):
         )
 
 
-class Namespace(Doc[T], metaclass=ABCMeta):
+U = TypeVar("U", bound=types.ModuleType | type)
+
+
+class Namespace(Doc[U], metaclass=ABCMeta):
     """
     A documentation object that can have children. In other words, either a module or a class.
     """
@@ -319,13 +323,17 @@ class Namespace(Doc[T], metaclass=ABCMeta):
                     qualname,
                     docstring="",
                     annotation=self._var_annotations.get(name, empty),
-                    default_value=obj,
+                    default_value=_pydantic.default_value(self.obj, name, obj),
                     taken_from=taken_from,
                 )
-            if self._var_docstrings.get(name):
+
+            if _doc := _pydantic.get_field_docstring(cast(type, self.obj), name):
+                doc.docstring = _doc
+            elif self._var_docstrings.get(name):
                 doc.docstring = self._var_docstrings[name]
-            if self._func_docstrings.get(name) and not doc.docstring:
+            elif self._func_docstrings.get(name) and not doc.docstring:
                 doc.docstring = self._func_docstrings[name]
+
             members[doc.name] = doc
 
         if isinstance(self, Module):
@@ -775,6 +783,12 @@ class Class(Namespace[type]):
         for cls in self._bases:
             sorted, unsorted = doc_ast.sort_by_source(cls, sorted, unsorted)
         sorted.update(unsorted)
+
+        if _pydantic.is_pydantic_model(self.obj):
+            sorted = {
+                k: v for k, v in sorted.items() if k not in _pydantic.IGNORED_FIELDS
+            }
+
         return sorted
 
     @cached_property
@@ -868,10 +882,7 @@ class Class(Namespace[type]):
         ]
 
 
-if sys.version_info >= (3, 10):
-    WrappedFunction = types.FunctionType | staticmethod | classmethod
-else:  # pragma: no cover
-    WrappedFunction = Union[types.FunctionType, staticmethod, classmethod]
+WrappedFunction = types.FunctionType | staticmethod | classmethod
 
 
 class Function(Doc[types.FunctionType]):
@@ -908,7 +919,7 @@ class Function(Doc[types.FunctionType]):
         else:
             unwrapped = func
         super().__init__(modulename, qualname, unwrapped, taken_from)
-        self.wrapped = func
+        self.wrapped = func  # type: ignore
 
     @cache
     @_include_fullname_in_traceback

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/doc_types.py

@@ -16,6 +16,7 @@ import types
 from types import BuiltinFunctionType
 from types import GenericAlias
 from types import ModuleType
+from types import UnionType
 import typing
 from typing import TYPE_CHECKING
 from typing import Any
@@ -25,7 +26,6 @@ from typing import get_origin
 import warnings
 
 from . import extract
-from ._compat import UnionType
 from .doc_ast import type_checking_sections
 
 if TYPE_CHECKING:
@@ -108,19 +108,7 @@ def safe_eval_type(
         err = str(e)
         _, mod, _ = err.split("'")
     except Exception as e:
-        if "unsupported operand type(s) for |" in str(e) and sys.version_info < (3, 10):
-            py_ver = ".".join(str(x) for x in sys.version_info[:3])
-            warnings.warn(
-                f"Error parsing type annotation {t} for {fullname}: {e}. "
-                f"You are likely attempting to use Python 3.10 syntax (PEP 604 union types) with an older Python "
-                f"release. `X | Y`-style type annotations are invalid syntax on Python {py_ver}, which is what your "
-                f"pdoc instance is using. `from __future__ import annotations` (PEP 563) postpones evaluation of "
-                f"annotations, which is why your program won't crash right away. However, pdoc needs to evaluate your "
-                f"type annotations and is unable to do so on Python {py_ver}. To fix this issue, either invoke pdoc "
-                f"from Python 3.10+, or switch to `typing.Union[]` syntax."
-            )
-        else:
-            warnings.warn(f"Error parsing type annotation {t} for {fullname}: {e}")
+        warnings.warn(f"Error parsing type annotation {t} for {fullname}: {e}")
         return t
 
     # Simple _eval_type has failed. We now execute all TYPE_CHECKING sections in the module and try again.
@@ -185,8 +173,6 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
     # Added a special check for typing.Literal, whose literal strings would otherwise be evaluated.
 
     if isinstance(t, str):
-        if sys.version_info < (3, 9):  # pragma: no cover
-            t = t.strip("\"'")
         t = typing.ForwardRef(t)
 
     if get_origin(t) is Literal:
@@ -197,24 +183,22 @@ def _eval_type(t, globalns, localns, recursive_guard=frozenset()):
         # https://github.com/python/cpython/blob/4f51fa9e2d3ea9316e674fb9a9f3e3112e83661c/Lib/typing.py#L684-L707
         if t.__forward_arg__ in recursive_guard:  # pragma: no cover
             return t
-        if not t.__forward_evaluated__ or localns is not globalns:
-            if globalns is None and localns is None:  # pragma: no cover
-                globalns = localns = {}
-            elif globalns is None:  # pragma: no cover
-                globalns = localns
-            elif localns is None:  # pragma: no cover
-                localns = globalns
-            __forward_module__ = getattr(t, "__forward_module__", None)
-            if __forward_module__ is not None:
-                globalns = getattr(
-                    sys.modules.get(__forward_module__, None), "__dict__", globalns
-                )
-            (type_,) = (eval(t.__forward_code__, globalns, localns),)
-            t.__forward_value__ = _eval_type(
-                type_, globalns, localns, recursive_guard | {t.__forward_arg__}
+
+        if globalns is None and localns is None:  # pragma: no cover
+            globalns = localns = {}
+        elif globalns is None:  # pragma: no cover
+            globalns = localns
+        elif localns is None:  # pragma: no cover
+            localns = globalns
+        __forward_module__ = getattr(t, "__forward_module__", None)
+        if __forward_module__ is not None:
+            globalns = getattr(
+                sys.modules.get(__forward_module__, None), "__dict__", globalns
             )
-            t.__forward_evaluated__ = True
-        return t.__forward_value__
+        (type_,) = (eval(t.__forward_code__, globalns, localns),)
+        return _eval_type(
+            type_, globalns, localns, recursive_guard | {t.__forward_arg__}
+        )
 
     # https://github.com/python/cpython/blob/main/Lib/typing.py#L333-L343
     # fmt: off

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/docstrings.py

@@ -104,13 +104,15 @@ def google(docstring: str) -> str:
     )
 
 
-GOOGLE_LIST_SECTIONS = ["Args", "Raises", "Attributes"]
+GOOGLE_LIST_SECTIONS = ["Args", "Raises", "Attributes", "Keyword Args"]
 """Section headers listed in the official Google docstring style guide."""
 
 GOOGLE_LIST_SECTION_ALIASES = {
     "Parameters": "Args",
     "Params": "Args",
     "Arguments": "Args",
+    "Raise": "Raises",
+    "Keyword Arguments": "Keyword Args",
 }
 """
 Alternative section headers that are not listed in the official Google

{pdoc-15.0.3 → pdoc-16.0.0}/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.3 → pdoc-16.0.0}/pdoc/render_helpers.py

@@ -24,9 +24,10 @@ except ImportError:  # pragma: no cover
     from jinja2 import contextfilter as pass_context  # type: ignore
 
 from jinja2.runtime import Context
+import markdown2
 from markupsafe import Markup
 
-import pdoc.markdown2
+import pdoc
 
 from . import docstrings
 
@@ -61,7 +62,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,
@@ -175,7 +176,7 @@ def to_html(docstring: str) -> str:
     # careful: markdown2 returns a subclass of str with an extra
     # .toc_html attribute. don't further process the result,
     # otherwise this attribute will be lost.
-    return pdoc.markdown2.markdown(  # type: ignore
+    return markdown2.markdown(  # type: ignore
         docstring,
         extras=markdown_extensions,
         link_patterns=markdown_link_patterns,
@@ -408,7 +409,7 @@ def linkify(
             # First part of the identifier (e.g. "foo") - this is optional for relative references.
             (?:
                 \b
-                (?!\d)[a-zA-Z0-9_]+
+                (?!\d)\w+
                 |
                 \.*  # We may also start with multiple dots.
             )
@@ -416,7 +417,7 @@ def linkify(
             (?:
                 # A single dot or a dot surrounded with pygments highlighting.
                 (?:\.|</span><span\ class="o">\.</span><span\ class="n">)
-                (?!\d)[a-zA-Z0-9_]+
+                (?!\d)\w+
             )+
             (?:\(\)|\b(?!\(\)))  # we either end on () or on a word boundary.
             (?!</a>)  # not an existing link
@@ -424,7 +425,7 @@ def linkify(
 
             | # Part 2: `foo` or `foo()`. `foo.bar` is already covered with part 1.
             (?<=<code>)
-                 (?!\d)[a-zA-Z0-9_]+
+                 (?!\d)\w+
             (?:\(\))?
             (?=</code>(?!</a>))
             """,

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/templates/content.css

@@ -445,9 +445,9 @@ This makes sure that the pdoc styling doesn't leak to the rest of the page when
 
 .pdoc .attribution img {
     margin-left: 5px;
-    height: 35px;
-    vertical-align: middle;
-    width: 70px;
+    height: 27px;
+    vertical-align: bottom;
+    width: 50px;
     transition: all 200ms;
 }
 

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc/templates/default/index.html.jinja2

@@ -14,7 +14,7 @@ A custom template could override this by setting root_module_name to false befor
 </html>
 {% else %}
 {% extends "frame.html.jinja2" %}
-{% block title %}Module List &ndash; pdoc {{ __version__ }}{% endblock %}
+{% block title %}Module List{% endblock %}
 {% block style %}
     {{ super() | safe }}
     <style>

pdoc-16.0.0/pdoc/templates/resources/pdoc-logo.svg

@@ -0,0 +1 @@
+<svg xmlns="http://www.w3.org/2000/svg" role="img" aria-label="pdoc logo" width="300" height="160" viewBox="0 0 150 80"><title>pdoc</title><path d="M132.316 48.886c.276-4.679 2.342-6.698 4.409-7.982s4.27-1.165 6.751-1.055c1.586.07 3.044.156 4.222-.482 1.142-.619 2.026-1.932 2.162-3.739.268-3.576-1.929-5.368-5.006-5.551s-7.599.524-10.517 1.606c-4.455 1.652-8.588 6.606-9.552 8.992s-2.342 6.193-1.745 10.873 2.664 9.221 5.878 11.79 5.878 3.808 10.103 4.312 3.444.229 6.062.229 5.006-2.202 4.914-4.909-2.296-5.001-4.501-4.863-3.077.505-5.281.229-7.715-2.064-7.899-9.451z" fill="#198754"/><circle cx="101.504" cy="48.943" r="14.208" fill="none" stroke="#198754" stroke-width="9.354"/><path d="M87.81.002c-3.637.065-5.001.454-7.014 1.232s-3.443 1.363-6.3 4.282c-1.723 1.76-3.148 5.019-3.776 7.329-.413 1.521-.316 2.63-.316 2.63l-.195 34.612c.065 5.774-6.755 8.305-9.612 8.37s-9.678-1.038-9.743-9.408 7.128-9.521 8.362-9.521c1.413-.13 2.526-.021 3.718-.016 2.071.009 4.157-.778 4.092-4.671s-4.157-4.736-4.157-4.736c-6.3-.843-11.43 2.206-11.43 2.206S40.917 38.15 41.372 49.634 51.568 68.19 61.311 68.125s18.316-7.007 18.445-17.193l.13-22.772c.046-2.291 2.683-3.644 4.476-4.203.745-.232 1.694-.274 1.694-.274l10.457-.13s4.871-.324 7.729-3.114 4.352-6.294 4.352-6.294.974-3.049.13-4.606-.195-1.233-2.792-3.309-8.573-4.477-8.573-4.477S91.447-.063 87.81.002zM0 47.169l.065 28.417S0 80.127 4.481 79.997s5.072-3.866 5.049-4.152l-.113-28.482s1.624-7.656 9.937-7.721 10.002 6.942 10.002 8.499-.909 10.51-9.093 10.51c-.948 0-2.99-.567-4.145-.272-3.919 1-3.194 4.554-3.194 4.554s.065 5.061 7.404 4.996 18.575-6.034 18.575-19.074S26.953 30.04 19.549 29.91 1.234 35.296 0 47.169z" fill="#198754"/><g transform="matrix(.325601 0 0 .325256 -10.32669 -45.802786)"><circle cx="297.554" cy="172.286" r="16.5" fill="#fff"/><ellipse cx="297.709" cy="172.642" rx="11.071" ry="10.871" fill="#105a48"/><circle cx="304.104" cy="167.667" r="4.5" fill="#fff"/></g><path d="M94.661 17.032l.893-1.476s.99.714 1.916.925 1.575.114 2.955.114l14.565-.162c1.283-.032 3.085-.762 3.02-3.293s-.373-3.503-.373-3.503l1.283-.487s.52.503.877 1.573.309 1.995.292 2.66-.227 1.541-.227 1.541 1.564-.308 2.359-1.038.823-.779 1.489-1.508.812-.86.812-.86.552-.13.877.26.341.957.065 1.46-1.672 2.206-3.247 3.066-2.76 1.427-3.929 1.768-3.848.73-7.063.714l-10.944-.114s-2.143-.081-3.02-.373-2.241-.973-2.598-1.265z" fill="#d36d49"/><g fill="#105a48"><ellipse cx="93.052" cy="43.567" rx=".869" ry="1.014" transform="rotate(341.022)"/><ellipse cx="104.3" cy="-16.184" rx=".865" ry="1.009" transform="rotate(14.786)"/></g></svg>

{pdoc-15.0.3 → pdoc-16.0.0/pdoc.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pdoc
-Version: 15.0.3
+Version: 16.0.0
 Summary: API Documentation for Python Projects
 Author-email: Maximilian Hils <pdoc@maximilianhils.com>
 License: MIT-0
@@ -16,24 +16,25 @@ Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: Jinja2>=2.11.0
 Requires-Dist: pygments>=2.12.0
 Requires-Dist: MarkupSafe>=1.1.1
+Requires-Dist: markdown2>=2.5.4
 
 <p align="center">
 <a href="https://pdoc.dev/"><img alt="pdoc" src="https://pdoc.dev/logo.svg" width="200" height="100" /></a>
 <br><br>
-<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg"></a>
-<img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github">
+<a href="https://pdoc.dev/docs/pdoc.html"><img height="20" alt="pdoc documentation" src="https://shields.mitmproxy.org/badge/docs-pdoc.dev-brightgreen.svg?logo=data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIxOTIiIGhlaWdodD0iMTkyIj48cGF0aCBkPSJNNjcuODA3IDIzLjI0NGMtMTguMDMyIDUuNTIzLTI0LjI3MyA5LjQxMS0zMy4xOTMgMTYuMTY5UzE5LjQwNyA1MS4xMjUgOS4zNCA2OS43NkMzLjI3IDgwLjk5Ni44MjcgOTkuMjcxIDEgMTExLjY3OWMuMTE0IDguMTY5IDIuMTg4IDEzLjU1OSAyLjE4OCAxMy41NTlTNDIuMzI2IDI0Ny4yNyAyMC40MzUgMjc4LjEwNWMtMTAuNDg4IDE0Ljc3MyA4NC40MjIgMjcuMDA3IDgwLjA0NyAxMC40NS0xMC4zOTctMzkuMzQ4LTI3LjU5NS05Ny40MDktMzEuOTA4LTExMy42NjctMy4wNDctMTEuNDg0IDguMTYtMjEuOTk1IDE2LjI5NS0yNy4zNDMgMy4zODMtMi4yMjQgOC4wNTEtMy43ODYgOC4wNTEtMy43ODZsNTEuOTI0LTE1LjU5NXMyMy44MDktOC41NzkgMzQuMDYyLTI2LjU2NyAxMi42ODktMzcuNTg0IDEyLjY4OS0zNy41ODQuNDk1LTE2LjU4OC01LjkzOS0yMy4xNC0yLjczMi01Ljg2Ni0xOC42NDYtMTIuNDk4LTQ5LjEyMi0xMC4wNTMtNDkuMTIyLTEwLjA1My0zMi4wNDktLjYwMi01MC4wODEgNC45MjF6IiBmaWxsPSIjMjBhZDZjIi8+PGcgdHJhbnNmb3JtPSJyb3RhdGUoMzQzLjk5MykiPjxlbGxpcHNlIGN4PSI1Mi4yNzYiIGN5PSI5NC4wODkiIGZpbGw9IiNmZmYiIHJ4PSIyNy44NTIiIHJ5PSIyNy44MjMiLz48ZWxsaXBzZSBjeD0iNTIuNTM4IiBjeT0iOTQuNjg5IiByeD0iMTguNjg4IiByeT0iMTguMzMxIiBmaWxsPSIjMTA1YTQ4Ii8+PGVsbGlwc2UgY3g9IjYzLjMzMyIgY3k9Ijg2LjMiIGZpbGw9IiNmZmYiIHJ4PSI3LjU5NiIgcnk9IjcuNTg4Ii8+PC9nPjxnIGZpbGw9IiMxMDVhNDgiPjxlbGxpcHNlIGN4PSI5NC4xNTQiIGN5PSIxMzUuNzM0IiByeD0iNC41MDUiIHJ5PSI1LjI1NyIgdHJhbnNmb3JtPSJyb3RhdGUoMzI1LjAxNSkiLz48ZWxsaXBzZSBjeD0iMTY3Ljg2IiBjeT0iNTYuOTUxIiByeD0iNC40ODQiIHJ5PSI1LjIzMSIgdHJhbnNmb3JtPSJyb3RhdGUoMzU4Ljc3OSkiLz48L2c+PHBhdGggZD0iTTE4OC45NjIgNzcuNDU4bC0zNC4yNDggMTAuMTcxYy02Ljg3OCAxLjk3My05Ljk3NCAzLjM4OC0xNC44ODggMy42NnMtMTAuODY4LTEuODY5LTEwLjg2OC0xLjg2OWwtMi4zNDIgOC42MzNjMi4xOTcuOTQ0IDkuOTY5IDIuMzkgMTQuNzU2IDIuNTkyczE1LjU4Mi0yLjQ2IDE1LjU4Mi0yLjQ2bDI3LjQ3MS03LjUzNGMxLjk1MS00LjcwOSAzLjQzMi05LjIzOCA0LjUzNy0xMy4xOTN6IiBmaWxsPSIjZTc4MzYxIi8+PC9zdmc+"></a>
+<a href="https://github.com/mitmproxy/pdoc/actions"><img height="20" alt="CI Status" src="https://shields.mitmproxy.org/github/actions/workflow/status/mitmproxy/pdoc/main.yml?label=CI&logo=github"></a>
 <img height="20" alt="Code Coverage" src="https://shields.mitmproxy.org/badge/coverage-100%25-brightgreen">
 <a href="https://autofix.ci"><img height="20" alt="autofix.ci: yes" src="https://shields.mitmproxy.org/badge/autofix.ci-yes-success?logo=data:image/svg+xml;base64,PHN2ZyBmaWxsPSIjZmZmIiB2aWV3Qm94PSIwIDAgMTI4IDEyOCIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj48cGF0aCB0cmFuc2Zvcm09InNjYWxlKDAuMDYxLC0wLjA2MSkgdHJhbnNsYXRlKC0yNTAsLTE3NTApIiBkPSJNMTMyNSAtMzQwcS0xMTUgMCAtMTY0LjUgMzIuNXQtNDkuNSAxMTQuNXEwIDMyIDUgNzAuNXQxMC41IDcyLjV0NS41IDU0djIyMHEtMzQgLTkgLTY5LjUgLTE0dC03MS41IC01cS0xMzYgMCAtMjUxLjUgNjJ0LTE5MSAxNjl0LTkyLjUgMjQxcS05MCAxMjAgLTkwIDI2NnEwIDEwOCA0OC41IDIwMC41dDEzMiAxNTUuNXQxODguNSA4MXExNSA5OSAxMDAuNSAxODAuNXQyMTcgMTMwLjV0MjgyLjUgNDlxMTM2IDAgMjU2LjUgLTQ2IHQyMDkgLTEyNy41dDEyOC41IC0xODkuNXExNDkgLTgyIDIyNyAtMjEzLjV0NzggLTI5OS41cTAgLTEzNiAtNTggLTI0NnQtMTY1LjUgLTE4NC41dC0yNTYuNSAtMTAzLjVsLTI0MyAtMzAwdi01MnEwIC0yNyAzLjUgLTU2LjV0Ni41IC01Ny41dDMgLTUycTAgLTg1IC00MS41IC0xMTguNXQtMTU3LjUgLTMzLjV6TTEzMjUgLTI2MHE3NyAwIDk4IDE0LjV0MjEgNTcuNXEwIDI5IC0zIDY4dC02LjUgNzN0LTMuNSA0OHY2NGwyMDcgMjQ5IHEtMzEgMCAtNjAgNS41dC01NCAxMi41bC0xMDQgLTEyM3EtMSAzNCAtMiA2My41dC0xIDU0LjVxMCA2OSA5IDEyM2wzMSAyMDBsLTExNSAtMjhsLTQ2IC0yNzFsLTIwNSAyMjZxLTE5IC0xNSAtNDMgLTI4LjV0LTU1IC0yNi41bDIxOSAtMjQydi0yNzZxMCAtMjAgLTUuNSAtNjB0LTEwLjUgLTc5dC01IC01OHEwIC00MCAzMCAtNTMuNXQxMDQgLTEzLjV6TTEyNjIgNjE2cS0xMTkgMCAtMjI5LjUgMzQuNXQtMTkzLjUgOTYuNWw0OCA2NCBxNzMgLTU1IDE3MC41IC04NXQyMDQuNSAtMzBxMTM3IDAgMjQ5IDQ1LjV0MTc5IDEyMXQ2NyAxNjUuNWg4MHEwIC0xMTQgLTc3LjUgLTIwNy41dC0yMDggLTE0OXQtMjg5LjUgLTU1LjV6TTgwMyA1OTVxODAgMCAxNDkgMjkuNXQxMDggNzIuNWwyMjEgLTY3bDMwOSA4NnE0NyAtMzIgMTA0LjUgLTUwdDExNy41IC0xOHE5MSAwIDE2NSAzOHQxMTguNSAxMDMuNXQ0NC41IDE0Ni41cTAgNzYgLTM0LjUgMTQ5dC05NS41IDEzNHQtMTQzIDk5IHEtMzcgMTA3IC0xMTUuNSAxODMuNXQtMTg2IDExNy41dC0yMzAuNSA0MXEtMTAzIDAgLTE5Ny41IC0yNnQtMTY5IC03Mi41dC0xMTcuNSAtMTA4dC00MyAtMTMxLjVxMCAtMzQgMTQuNSAtNjIuNXQ0MC41IC01MC41bC01NSAtNTlxLTM0IDI5IC01NCA2NS41dC0yNSA4MS41cS04MSAtMTggLTE0NSAtNzB0LTEwMSAtMTI1LjV0LTM3IC0xNTguNXEwIC0xMDIgNDguNSAtMTgwLjV0MTI5LjUgLTEyM3QxNzkgLTQ0LjV6Ii8+PC9zdmc+"></a>
 <a href="https://pypi.python.org/pypi/pdoc"><img height="20" alt="PyPI Version" src="https://shields.mitmproxy.org/pypi/v/pdoc.svg"></a>
@@ -52,7 +53,7 @@ API Documentation for Python Projects.
 pip install pdoc
 ```
 
-pdoc is compatible with Python 3.9 and newer.
+pdoc is compatible with Python 3.10 and newer.
 
 
 # Usage

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ pyproject.toml
 pdoc/__init__.py
 pdoc/__main__.py
 pdoc/_compat.py
+pdoc/_pydantic.py
 pdoc/doc.py
 pdoc/doc_ast.py
 pdoc/doc_pyi.py
@@ -23,9 +24,6 @@ pdoc.egg-info/dependency_links.txt
 pdoc.egg-info/entry_points.txt
 pdoc.egg-info/requires.txt
 pdoc.egg-info/top_level.txt
-pdoc/markdown2/LICENSE
-pdoc/markdown2/README.md
-pdoc/markdown2/__init__.py
 pdoc/templates/README.md
 pdoc/templates/build-search-index.js
 pdoc/templates/content.css
@@ -61,6 +59,7 @@ pdoc/templates/resources/lightbulb.svg
 pdoc/templates/resources/lightning-fill.svg
 pdoc/templates/resources/navtoggle.svg
 pdoc/templates/resources/pdoc-logo.svg
+test/test__pydantic.py
 test/test_doc.py
 test/test_doc_ast.py
 test/test_doc_pyi.py

{pdoc-15.0.3 → pdoc-16.0.0}/pdoc.egg-info/requires.txt

@@ -1,3 +1,4 @@
 Jinja2>=2.11.0
 pygments>=2.12.0
 MarkupSafe>=1.1.1
+markdown2>=2.5.4