Releases: machow/quartodoc
Releases · machow/quartodoc
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.
- Adds a
- 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.
- This change adds a private endpoint to the renderer called
Full Changelog: v0.7.1...v0.7.2
v0.7.1: more robust dynamic object loading
What's Changed
Full Changelog: v0.7.0...v0.7.1
v0.7.0: move to griffe>=0.33
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
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
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 likeinclude_attribute
. - This PR also enables using external functions (e.g. imported into a module) in its members.
- Note that if a module has an
- docs: configuring docstring styles by @machow in #301
New Contributors
Full Changelog: v0.6.4...v0.6.5
v0.6.4: pydantic v2 compatibility
What's Changed
- dev: allow quartodoc to work with pydantic v2 by @machow in #294
- note that we simply
import pydantic.v1
for now.
- note that we simply
- fix: ensure docstring section transform preserves starting text by @machow in #289
- fix: when pointing to
_quarto.yml
in another folder, put current directory onsys.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
v0.6.2: rendered signature fixes
What's Changed
- fix(interlinks): ensure that json fixup only happens when json is not nil by @cpcloud in #268
- fix: no render self by @machow in #271
- fix(interlinks): do not error if no config found by @machow in #274
- fix: signature when alias by @machow in #281
- docs: improvements by @hamelsmu in #264
- The programming section of the guide now has much more detail!
- docs: render readme by @machow in #273
- dev: update devcontainer config by @eitsupi in #265
New Contributors
Full Changelog: v0.6.1...v0.6.2
v0.6.1: fix member_options causing object lookup error
What's Changed
Full Changelog: v0.6.0...v0.6.1