Pdoc3

Latest version: v0.11.1

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

Scan your dependencies

Page 4 of 8

0.6.4

=====
- New template tunable `syntax_highlighting=True` that controls whether
Highlight.js is included even if `show_source_code=False`.
- Fix `pdoc.Class.mro()` for types extending types with the same name.
- Support initializing `pdoc.Module` from module string.
- HTML-escape function parameter defaults so that objects' reprs don't
break HTML.
- Other small bug fixes.

0.6.3

=====
- New support for LaTeX math syntax (using new config tunable `latex_math=True`).
- Support for running system-site-installed pdoc within a virtual environment.
- Bugfixes.

0.6.2

=====
- Fixes:
- Don't generate Modules for empty namespace packages (i.e. resource directories).
- Generate real markdown files when `--output-dir` is set but not `--html`.
- Fix formatting of numpydoc type-only parameters.
- Auto-reload modules upon changes when in `--http` mode.
- New config tunable: `google_analytics`.
- Warn on unknown config tunables passed on the CLI.

0.6.1

=====
- Minor maintenance release.

0.6.0

=====
- New support for PEP 484 Python type annotations.
- Class `__init__` methods are no longer documented separately.
Instead, class docstring now contains `__init__` method's docstring,
and class definition line now shows `__init__` parameters.
This is in line with Sphinx / Python stdlib documentation.
- PDF docs generation via Markdown, ingestible by various
Markdown-to-PDF converters.
- New module import mechanism with improved support for
namespace packages.
- CLI changes:
- New `--config` switch for easier setting of config.mako tunables.
- Deprecated switches in favor of new/standard ones:
- `--overwrite` → `-f, --force`
- `--html-dir` → `-o, --output-dir`
- `--html-no-source`, `--external-links` and `--link-prefix` are
removed in favor of new tunables settable with `--config`.
- `--output-dir` without `--html` outputs a tree of raw Markdown files.
- The semantics of module specified as filesystem path has changed:
before the full relative path was used to construct the python module
path, now only the basename is.
- Bugfixes regarding raw URLs and numpydoc transformations.

0.5.4

=====
- Bugfixes:
- Added support for metaclass subclasses.
- Fix pdoc.Function.params() error in case when keyword-only
parameters have no default values.
- Don't expand `os.environ` parameter default value as exposing it
is a security issue.

Page 4 of 8

© 2024 Safety CLI Cybersecurity Inc. All Rights Reserved.