quartodoc

library0.11.1pypypi✓ verified 82d ago

Quartodoc generates API documentation for Python projects using Quarto, merging docstrings with narrative content. Current version 0.11.1 supports Python >=3.9, with a stable release cadence.

devops

pip install quartodoc

INSTALL

IMPORT

SIG · QUARTODOC

quartodoc

devopspythonv0.11.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Auto

✓ from quartodoc import Auto

✗ from quartodoc import get_auto_documentation_plan

Builder

✓ from quartodoc import Builder

MdRenderer

✓ from quartodoc import MdRenderer

Generate a basic API documentation plan for a package.

from quartodoc import get_auto_documentation_plan plan = get_auto_documentation_plan( package="mypackage", output_dir="docs/api", title="API Reference", ) plan.write_metadata() print("Plan written to docs/api/_metadata.yml")

Debug

Known issues

gotchaRequires Quarto CLI installed separately. pip install does not install Quarto itself.

fix

Install Quarto from https://quarto.org/docs/download/

affects: all

breakingIn version 0.11.0, the function 'get_auto_documentation_plan' replaced 'build_docs'. Old code using 'build_docs' will break.

fix

Use 'get_auto_documentation_plan' instead of 'build_docs'.

affects: >=0.11.0

deprecatedThe 'blueprint' module is deprecated in favor of 'Blueprint' class from main module.

fix

Use 'from quartodoc import Blueprint' instead of 'from quartodoc.blueprint import Blueprint'.

affects: >=0.10.0

Upgrade

Version history

0.11.1latest on PyPI · released Jun 10, 2025

Audit

Dependencies

quartorequiredQuarto CLI must be installed separately and available in PATH

pandasoptionalOptional but commonly used for DataFrame display in docs

Agent activity

4 hits · last 30 days

node

Resources

No resource links recorded.