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)
2023-12-13: pdoc 14.2.0
pdoc now documents PyO3 or pybind11 submodules that are not picked up by Python's builtin pkgutil module.
(#633, @mhils)
pdoc now supports Python 3.12's type statements and has improved TypeAlias rendering.
(#651, @mhils)
Imports in a TYPE_CHECKING section that reference members defined in another module's TYPE_CHECKING section now work
correctly.
(#649, @mhils)
Add support for code-block ReST directives
(#624, @JCGoran)
If a variable's value meets certain entropy criteria and matches an environment variable value,
pdoc will now emit a warning and display the variable's name as a placeholder instead.
This heuristic is meant to prevent accidental leakage of environment secrets and can be disabled by setting
PDOC_DISPLAY_ENV_VARS=1.
(#622, @mhils)
2023-09-10: pdoc 14.1.0
Add compatibility with Python 3.12
(#620, @mhils)
Add support for relative links. Instead of explicitly referring to mypackage.helpers.foo,
Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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)
Updates the requirements on pdoc to permit the latest version.
Changelog
Sourced from pdoc's changelog.
... (truncated)
Commits
82e633e
bump to 14.5.0b24e04e
fix CIfde455d
add options for include directive (#684)f55ba28
remove slack link79be31c
call embed_images when including a file (#692)1b36ea2
Bump jinja2 from 3.1.3 to 3.1.4 (#688)600df0b
Bump the dependencies group with 13 updates (#686)091cfd6
Bump the dependencies group with 13 updates (#676)2d58854
add overflow-y: hidden to mathjax containers (#675)7b07452
Bump the dependencies group with 11 updates (#672)Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually 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