Skip to content

Releases: machow/quartodoc

v0.7.0: move to griffe>=0.33

20 Nov 18:39
540d29c
Compare
Choose a tag to compare

What's Changed

  • dev!: bump griffe to >=0.33 by @has2k1 in #304
    • This gives us access to newer griffe features and bug fixes. For example, letting methods inherit docstrings in the future.

New Contributors

Full Changelog: v0.6.6...v0.7.0

v0.6.6: minor fix - add current directory to sys.path when building

16 Nov 17:07
1f4f9f3
Compare
Choose a tag to compare

What's Changed

  • fix: really add cwd to sys path this time by @machow in #303
    • this supports the case where people build docs in a subdirectory, but depend on importing a file from the root directory.

Full Changelog: v0.6.5...v0.6.6

v0.6.5: support google docstring admonitions

20 Oct 21:04
c4cbbea
Compare
Choose a tag to compare

What's Changed

  • feat: added admonition support for google docstrings by @epinzur in #286
  • fix: resolve external alias members via loading by @machow in #300
    • Note that if a module has an __all__ attribute defined, this PR uses that to define its initial members. These members are still subsequently filtered with options like include_attribute.
    • This PR also enables using external functions (e.g. imported into a module) in its members.
  • docs: configuring docstring styles by @machow in #301

New Contributors

Full Changelog: v0.6.4...v0.6.5

v0.6.4: pydantic v2 compatibility

16 Oct 16:29
a37b560
Compare
Choose a tag to compare

What's Changed

  • dev: allow quartodoc to work with pydantic v2 by @machow in #294
    • note that we simply import pydantic.v1 for now.
  • fix: ensure docstring section transform preserves starting text by @machow in #289
  • fix: when pointing to _quarto.yml in another folder, put current directory on sys.path, before switching directories. (see #296, #297)
  • docs: add signature_name to docstring and all content options section by @machow in #290
  • docs: add ci badge by @machow in #291

Full Changelog: v0.6.3...v0.6.4

v0.6.3: more robust dynamic loading of methods

05 Oct 20:05
4036ba3
Compare
Choose a tag to compare

What's Changed

  • fix: clean up MdRenderer error message by @peekxc in #282
  • fix: dynamic child should load parent dynamically by @machow in #279

New Contributors

Full Changelog: v0.6.2...v0.6.3

v0.6.2: rendered signature fixes

29 Sep 19:31
7fb7518
Compare
Choose a tag to compare

What's Changed

New Contributors

Full Changelog: v0.6.1...v0.6.2

v0.6.1: fix member_options causing object lookup error

01 Sep 17:17
1de0c38
Compare
Choose a tag to compare

What's Changed

  • fix: setting member_options no longer unsets package on members by @machow in #262

Full Changelog: v0.6.0...v0.6.1

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

31 Aug 22:36
7339f4d
Compare
Choose a tag to compare

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

29 Aug 14:15
e02bcee
Compare
Choose a tag to compare

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

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

v0.4.3: autopackage fix

24 Aug 21:57
416eaa7
Compare
Choose a tag to compare

What's Changed

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