Pdoc3

Latest version: v0.11.1

Safety actively analyzes 666166 Python packages for vulnerabilities to keep your Python projects secure.

Scan your dependencies

Page 2 of 8

0.8.5

=====
- Fix installation issue on non-UTF-8 platforms.
- Fix working with 'develop' installations in virtual environments.

0.8.4

=====
- Fix inline code interpretation inside fenced code blocks.

0.8.3

=====
- Fix extracting TOC with interleaved doctests in fenced code blocks,
regression since 0.8.2.

0.8.2

=====
- Enhancements:
- New CLI switch `--skip-errors` for skipping invalid/broken modules with
a warning instead of raising an error.
- CSS tweak to highlight :target-ed section.
- Paths to generated files (with `--output-dir`) are now printed to stdout.
- Support for `__docformat__` from PEP 258.
- Support for Python 3.8 positional-only arguments.
- Bugfixes:
- Better handle raw URLs and some markdown links.
- Consistently use `sort_identifiers` and variable type annotations in
markdown and PDF templates.
- Don't warn about missing key for `__pdoc__`-skipped submodules.
- Fix git path comparison and normalize `.. include::` paths on Windos.
- Fix sidebar scrollbar visible thrugh search results overlay.
- Avoid extracting doctest comments into HTML sidebar TOC.
- Support Google-style docstring multi-line Returns statement containing
description only.
- Support hyphens in Google-style docstring argument types.
- Fix hyperlinks for type annotations with spaces.
- Other:
- Bump HTML template CDN resources.
- Use non-breaking hyphen in return annotation arrow.
- Multi-line func/class signature in PDF template.
- Other minor docs improvements.

0.8.1

=====
- New search widget (config tunable `search_query`) using Google CSE.
- Support type annotations for variables (third time's the charm).
- Fix crash on `Module.is_namespace` given a dyunamic/generated module.

0.8.0

=====
- New features:
- Whitelisting `_private` members with `__pdoc__[key] = True`.
- Support function signatures (and annotations) for Python built-in/C extension types.
- Show type annotations also for variables (some; no instance variables).
- Consult `__docformat__` variable in the documented module (PEP 258).
- Skip traversal of `__pdoc__`-ignored package/directory.
- HTML sidebar (index) now has a separate scrollbar.
- Changes:
- Improved reference linking in more complex type expressions.
- `show_type_annotations` config tunable is now set by default.
- Fixes:
- Fix crash when some `class.__module__` is None.
- Avoid URL manipulation inside code blocks.
- Improved doctests and googledoc docformat.

Page 2 of 8

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.