Skip to content

Releases: machow/quartodoc

v0.7.3

03 Jun 21:51
79e11e2
Compare
Choose a tag to compare

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

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

v0.7.2

11 Dec 20:14
6781777
Compare
Choose a tag to compare

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

20 Nov 20:02
3881be4
Compare
Choose a tag to compare

What's Changed

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

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

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