Skip to content

Latest commit

 

History

History
107 lines (67 loc) · 2.59 KB

CHANGELOG.md

File metadata and controls

107 lines (67 loc) · 2.59 KB

Release History

pdoc 1.0

This release features a major rewrite of pdoc, dropping compatibility with Python 2 and focusing on modern Python 3 only.

  • Added: First-class support for type annotations
  • Added: Simpler directory structure
  • Added: New responsive documentation theme
  • Added: New website and documentation
  • Added: 100% test coverage and CI
  • Use Jinja2 instead of mako.
  • Removed: Support for __pdoc__, which is rarely required when following modern Python standards. This feature may return depending on user feedback.
  • Removed: Markdown output. The project now focuses on HTML documentation. PRs to re-add markdown support will be gladly accepted.

pdoc is now maintained by @mhils and the rest of the mitmproxy team.

pdoc 0.3.1

  • Bugfix release.

pdoc 0.3.1

  • Source code is extracted from wrapped if it exists, and then falls back to inspect.getsourcelines. This reverses the behavior implemented in #6.
  • Fix Python 2.6 compatibility by requiring Markdown < 2.5 (#19). Markdown 2.5 dropped support for Python 2.6.
  • Get rid of tabs that sneaked in from #17.
  • Fix pep8 violations.

pdoc 0.3.0

pdoc 0.2.4

  • Fixed bug in HTTP server that was referencing a non-existent variable.

pdoc 0.2.3

  • Fixed #10 (the --template-dir flag now works).

pdoc 0.2.2

  • Fixes #7 by ignoring module loaders that lack a 'path' attribute.

pdoc 0.2.1

  • Fixes #5 by trying to find source for decorated functions. (@austin1howard)

pdoc 0.2.0

  • Fix issue #2 by making pdoc a package instead of a module. The templates are now included as package_data, which seems to be more portable (its final location is more predictable).

pdoc 0.1.8

  • pdoc now interprets __pdoc__[key] = None as an explicit way to hide key from the public interface of its module.

pdoc 0.1.7

  • Removed new from the public interface. I think init is sufficient.

pdoc 0.1.6

  • Fixed bug #1.

pdoc 0.1.5

  • Fixed a bug with an improper use of getattr.
  • Made pdoc aware of slots. (Every identifier in slots is automatically interpreted as an instance variable.)

pdoc 0.1.4

  • Fixed bug where getargspec wasn't being used in Python 2.x.

pdoc 0.1.3

  • Avoid a FQDN lookup.

pdoc 0.1.2

  • A few doco touchups.
  • Fixed a bug in Py3K. Use getfullargspec when available.

pdoc 0.1.1

  • Documentation touch ups.
  • Removed unused command line flags.

pdoc 0.1.0

First public release.