Releases: machow/quartodoc
Releases · machow/quartodoc
v0.3.1: add builder source_dir option
What's Changed
- feat: Builder source_dir parameter for non-package loads by @machow in #131
- docs: correctly escape when mentioning quarto block by @machow in #126
- docs: use quartodoc build for cli instructions by @machow in #127
- tests: python interlinks by @machow in #122
- docs: quarto install link by @machow in #129
- docs: how to document classes by @machow in #132
Full Changelog: v0.3.0...v0.3.1
v0.3.0: config layouts, module docs, CLI entrypoint
What's Changed
- feat: layouts module for representing config settings (#64)
- feat: allow documenting entire modules (#81)
- feat: add cli entrypoint (#107)
- feat: quartodoc build accepts
--filter
argument (#121) - feat: top-level imports of
Auto
,blueprint
, andcollect
(#121) - ux: log when an api page is written (#89)
- refactor!: remove Builder methods:
.do_collect()
,do_blueprint()
,do_summarize()
(#121) - refactor!:
Builder.rewrite_all_pages
now set to False by default (#121) - fix: sidebar now always includes page named index (#79)
- fix: always render *args and **kwargs in signature (#102)
- fix: better support for rendering /, and * in signatures (#119)
- docs: site overhaul (#121)
Full Changelog: v0.2.1...v0.3.0
Fix: contents of custom sections missing, breaking renders
What's Changed
Full Changelog: v0.2.1...v0.2.2
v0.2.1: support rendering attributes, dynamically loading docstrings
v0.2.0
v0.1.0: streamlined config, mostly stable
This release is able to generate docsites from simple config in your _quarto.yml
. It's ready for basic use.
quartodoc's next aim is to ensure it can handle complex cases, by porting the documentation sites for siuba, vetiver, shiny, and plotnine.
(As part of that process, I may make breaking changes to the API).
What's Changed
- feat interlinks by @machow in #17
- feat builder by @machow in #18
- feat: support simplified config, fully specified interlinking syntax by @machow in #26
- refactor(renderer)!: change to_md method name to render by @machow in #36
- docs: flesh out handling docstrings page by @machow in #14
- docs: flesh out interlinks page by @machow in #15
- docs: page on extending by @machow in #35
- examples: basic dascore starter code by @machow in #16
- example shiny by @machow in #28
Full Changelog: v0.0.3...v0.1.0
v0.0.3: refactor for initial doc site
docs: add github icon
v0.0.2: generate section titles, handle returns section
ci: add pypi release