Releases: machow/quartodoc
Releases · machow/quartodoc
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
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 likeprint
should produce the correct link. Linking
to non-python documentation sections now requires explicitly specifying the domain (e.g.:std:2to3fixer:`print`
).
- This change causes interlinks to search only for python objects in inventory files. As a result, when
New Contributors
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