Improve rendering of enums on Python 3.12+.
(#708, @mhils)
Fix a bug where hyperlinks would get parsed as docstring references.
(#709, @mhils)
Fix a TypeError when trying to parse modules that implement __dir__ incorrectly.
(#710, @mhils)
Fix a bug where a combination of @dataclass and ctypes.Structure would crash pdoc.
(#711, @mhils)
Update bundled version of markdown2.
(#717, @mhils)
2024-06-25: pdoc 14.5.1
CVE-2024-38526: Documentation generated with math mode (pdoc --math) does not include scripts
from polyfill.io anymore. Users who produce documentation with math mode should update immediately. All other users are unaffected.
(#703, @adhintz)
2024-05-16: pdoc 14.5.0
The .. include: rST directive now supports start-line, end-line, start-after, end-before options.
(#684, @frankharkins)
Fix image embedding in included rST files.
(#692, @meghprkh)
Support type-hints from stub-only packages. E.g: scipy-stubs
(#671, @erikdesmedt)
Modify css styles for MathJax to remove unnessesary scroll bars
(#675, @thehappycheese)
2024-01-18: pdoc 14.4.0
Private methods can now be included in the documentation by adding @public to the docstring.
This complements the existing @private annotation.
(#655, @tmeyier)
pdoc now correctly detects the source file for wrapped functions.
(#657, @tmeyier)
Fixed a bug where memory addresses were not removed from output.
(#663, @mhils)
2023-12-22: pdoc 14.3.0
Improve rendering of .pyi type stubs containing @typing.overload.
(#652, @mhils)
@property and @cached_property attributes now have a "View Source" button.
(#654, @tmeyier)
You can trigger a rebase of this PR by commenting @dependabot rebase.
Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it
- `@dependabot merge` will merge this PR after your CI passes on it
- `@dependabot squash and merge` will squash and merge this PR after your CI passes on it
- `@dependabot cancel merge` will cancel a previously requested merge and block automerging
- `@dependabot reopen` will reopen this PR if it is closed
- `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
- `@dependabot show ignore conditions` will show all of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
Note
Automatic rebases have been disabled on this pull request as it has been open for over 30 days.
Updates the requirements on pdoc to permit the latest version.
Changelog
Sourced from pdoc's changelog.
... (truncated)
Commits
e6464b6
bump to 14.6.08d6d980
docs: make it more clear what@private
does (#716)1f08df5
add support for GitHub Markdown alerts (#718)f2ffa5e
update markdown2 (#717)8939754
refactorlinkify
(#670)8aef099
update ruff's pyproject configuration (#712)552378f
expectinspect.signature
to raise, fix #678 (#711)d571959
fix TypeError on spec walking, fix #680 (#710)a3d4946
improve enum rendering, fix #701 (#708)59efaca
fix #698 (#709)You can trigger a rebase of this PR by commenting
@dependabot rebase
.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show