v0.9.1: fix multiline signature

What's Changed

• fix: add trailing commas to multiline signature by @machow in #381

Full Changelog: v0.9.0...v0.9.1

v0.9.0: sidebar customization

What's Changed

• feat: Allow addings additional options to sidebar by @gadenbuie in #370

New Contributors

• @gadenbuie made their first contribution in #370

Full Changelog: v0.8.1...v0.9.0

v0.8.1: fix escaping inside description blocks

Fixes

• fix: descriptions no longer escape quotes inside code by @machow in #375

Full Changelog: v0.8.0...v0.8.1

v0.8.0: description lists, Auto.excludes, and Auto.member_order

Breaking changes

• The internal logic of rendering has been reworked a bit (#325, #374).
  • The dataclass ParamRow now represents each row of a parameter table (previously was a tuple)
  • parameter/attribute/etc.. table field sanitization now occurs inside ParamRow methods, rather than being duplicated inside each render concrete.

Features

• feat!: initial description-list support; render_header cleanup by @machow in #325
• feat: add Auto member_order option by @machow in #373
  • set member_order: "source" to list members in source order (rather than sorting alphabetically)
• feat: implement Auto excludes option by @machow in #372
  • allows excluding a list of specific members

Fixes

• fix: use shortname for member children linked style by @machow in #366
• fix: make header css classes more robust by stripping non-alphanumerics by @machow in #367
• fix: parameter description list do not render None as default by @machow in #374
• fix: missing branch in show_signature_annotations by @machow in #362

Chores

• tests: get_object returns annotations from pyi stub files by @machow in #360

Full Changelog: v0.7.6...v0.8.0

v0.7.6: support griffe v1

What's Changed

• fix: support griffe v1, and maintain backwards compatibility to v0.37.0 (#359)

Full Changelog: v0.7.5...v0.7.6

v0.7.5: add missing requests dependency

What's Changed

• chore(deps): add missing requests dependency by @gforsyth in #352

New Contributors

• @gforsyth made their first contribution in #352

Full Changelog: v0.7.4...v0.7.5

v0.7.4: small interlinks fix

What's Changed

• fix: support downloading objects.txt inventories by @machow in #350
• fix: Shinyswatch url in examples by @coatless in #348
• docs: now use fast interlinks to build

New Contributors

• @coatless made their first contribution in #348

Full Changelog: v0.7.3...v0.7.4

v0.7.3

What's Changed

• fix: compatibility with griffe 0.39 by @machow in #326
• fix: remove duplicate names in annotations by @machow in #345
• fix: do not exclude child methods on alias classes by @machow in #327
• docs: how to document only Python files by @filipwastberg in #321
• dev: pin pytest<8.0.0 by @machow in #335
• chore: define pandoc InlineContent type to be recursive by @has2k1 in #316

New Contributors

• @filipwastberg made their first contribution in #321

Full Changelog: v0.7.2...v0.7.3

v0.7.2

What's Changed

• Fix: dynamic load members by @machow in #309
• Feat: Pandoc Markdown Writers by @has2k1 in #302
  • Adds a quartodoc.pandoc submodule, to make it easier to render quarto friendly markdown.
  • This is currently used by the plotnine docs, but will be used in the quartodoc Renderer in a future release.
• Dev: More extendable quartodoc by @has2k1 in #311
  • This change adds a private endpoint to the renderer called ._pages_written(), in order to support the plotnine docs. We are thinking of ways in which people may want to extend the quartodoc building process. Please open an issue if you need a way to extend any aspects of quartodoc.

Full Changelog: v0.7.1...v0.7.2

v0.7.1: more robust dynamic object loading

What's Changed

• fix: get_object dynamic supports methods set by assignments by @machow in #305

Full Changelog: v0.7.0...v0.7.1