v0.6.0: rendering interlinks, speeding up interlinks, and signature_name option

What's Changed

• feat: render_interlinks option by @hamelsmu in #161
  • Converts type annotations to interlinks in API documentation.
• feat: interlinks fast option by @machow in #253
  • Option to speed up the interlinks filter, by directly parsing text inventory files, rather than converting to JSON.
  • This can cause sites using extremely large inventory files to build much faster.
• feat: add Auto signature_name and member_options fields by @machow in #257
  • signature_name controls how much of a function signatures name gets shown (e.g. just the function name, etc..)
  • member_options allows you to configure options for a piece of content's members (e.g. their signature_name)

Full Changelog: v0.5.0...v0.6.0

v0.5.0

What's Changed

• feat: allow single blank line in numpydoc parameter docstrings by @machow in #255
• feat: include filters by @machow in #256
• feat(interlinks)!: filter on py domain by default by @jmbuhr in #254
  • This change causes interlinks to search only for python objects in inventory files. As a result, when
    using the python.org inventory, linking to objects like print should produce the correct link. Linking
    to non-python documentation sections now requires explicitly specifying the domain (e.g. :std:2to3fixer:`print`).

New Contributors

• @jmbuhr made their first contribution in #254

Full Changelog: v0.4.3...v0.5.0

v0.4.3: autopackage fix

What's Changed

• fix: autopackage works with no module docstring by @machow in #234
• dev: migrate to pyproject.toml by @hamelsmu in #240
• dev: use upper bound for griffe version by @machow in #243
• dev: add artifacts for Codespaces by @hamelsmu in #252
• docs: builder parser arg by @machow in #244
• docs: examples and tutorials by @machow in #250

Full Changelog: v0.4.2...v0.4.3

v0.4.2: subtitles, set default options, watcher fixes

What's Changed

• feat: add subtitle option to section by @machow in #187
• feat: add config file (_quarto.yml) to quartodoc build --watch by @hamelsmu in #229
• feat: option defaults by @machow in #233
• fix: ignore extraneous files for quartdoc build -- watch by @hamelsmu in #228
• fix: dynamic load better handles instances by @machow in #231

Full Changelog: v0.4.1...v0.4.2

v0.4.1: include_empty option to skip undocumented objects

What's Changed

• Add include_empty option to Auto, which skips documenting objects without a docstring (#218)

Full Changelog: v0.4.0...v0.4.1

v0.4.0: very simple, automatic package docs; better automodule

What's Changed

• add --watch flag to quartodoc build by @hamelsmu in #210
• feat: automodule by @machow in #212
  • creates a default reference, if user doesn't specify sections.
• fix: modules now can include classes as members
  • We're still exploring the best way to have embedded docs (e.g. when documenting a module, including docs for a method on the class on the module).
• docs: refactor headings by @hamelsmu in #216

Full Changelog: v0.3.5...v0.4.0

v0.3.5

What's Changed

• fix: better messaging when object can't be found by @machow in #192
• fix: do not render attribute annotations twice by @machow in #205
• fix: Add .qmd path to summary link for Page by @schloerke in #202
• fix: do not accept extra fields in pydantic by @machow in #200
• feat: use italics when rendering a "required" default value by @schloerke in #207
• dev: pin pydantic to v1 by @machow in #214

New Contributors

• @schloerke made their first contribution in #207

Full Changelog: v0.3.4...v0.3.5

v0.3.4

What's Changed

• feat: Add a high-level dynamic argument, to attempt loading every object dynamically by default (#182)
• feat: add entries for canonical paths to sphinx inventory. This enables more robust interlinking (#180)
• feat: yaml validation by @hamelsmu in #189
  • This should result in better messages, when there is an error in quartodoc configs!
• fix: correct sidebar structure by (#173)
• refactor: add _render_table method to consolidate code by @machow in #181

Full Changelog: v0.3.3...v0.3.4

v0.3.3: support griffe v0.28, wrap interlinks in code

What's Changed

Fixes

• fix: support griffe v0.28 by @machow in #152
• fix dynamic class loading by @machow in #174
• fix: do not sanitize interlinks in table descriptions by @machow in #178

Features

• feat: interlink link content now in a code element by @machow in #179

Misc

• dev: pin versions & get rid of panflute by @hamelsmu in #162
• dev: remove python 3.8 tag by @machow in #171
• chore: add COC, update license and authors by @machow in #70

New Contributors

• @hamelsmu made their first contribution in #162

Full Changelog: v0.3.2...v0.3.3

v0.3.2: lua interlinks filter

Note that this PR removes the old python interlinks filter, in favor of a lua one. This enables people to use versions of quarto v1.3+.

The filter should be installed automatically, when you run quarto add extension machow/quartodoc.

What's Changed

• docs: miscellaneous updates by @machow in #148
• feat: Lua interlinks filter by @machow in #128
  • The only change in behavior should be the output if it cannot find an item to create a link from. Previously, for a link like :function:`my_func` it output the full input. The new output is closer to a reader might expect.
  • old output: :function:`my_func`
  • new output: `my_func`

Full Changelog: v0.3.1...v0.3.2