quartodoc
Generate API documentation with Quarto.
Decision gist · record as of 2026-08-14
Yes, if you are already using Quarto for documentation and want a lightweight alternative to Sphinx for API reference generation. The low install friction and permissive MIT license make it accessible. However, the aging maintenance status (430 days since last release) suggests checking whether the package still aligns with current Quarto versions and your project's long-term needs before committing to it for critical documentation pipelines.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Quarto must be installed separately before quartodoc can generate documentation.
- Low install friction with a pure-Python wheel and 13 runtime dependencies.
- Maintenance status is aging—last release was 430 days ago, though the repository remains active with recent commits and no archival.
License · maintenance · safety
permissive license (permissive) — MIT License permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial projects.
last release 2025-06-10 (430 days) · last repo commit 2025-12-08 · 265 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 83,567 downloads/mo, #14,065 on PyPI
Alternatives
Verify before relying
pip install quartodoc
# Add to _quarto.yml:
quartodoc:
package: your_package
sections:
- title: API
contents:
- your_function
# Generate docs:
quartodoc build- Whether the 430-day gap since last release indicates active maintenance or stalled development despite recent commits.
- Performance characteristics when documenting large packages with many objects.
- Compatibility with recent Quarto versions and any breaking changes in the Quarto ecosystem.
What it is and what it does
quartodoc is a documentation generator that extracts Python docstrings and converts them into Markdown-based API reference pages for Quarto projects. It inspects functions, classes, methods, modules, and attributes from your package and generates structured reference documentation without requiring Sphinx. The tool integrates directly into Quarto's project workflow via configuration in `_quarto.yml`, allowing you to define which objects to document and organize them into sections.
The package depends on griffe for docstring parsing, pydantic for configuration validation, and several utilities like black, click, and watchdog for formatting and file monitoring. It supports Python 3.9 and later and runs on macOS, Windows, and Unix systems. Once configured, you run `quartodoc build` to generate documentation pages, optionally with `--watch` to rebuild automatically as your code changes.
Use it for
- Generate API reference docs for a Python library as part of a Quarto website without setting up Sphinx.
- Automatically rebuild API documentation when source code changes using the watch mode.
- Document specific functions, classes, and methods by listing them in a YAML configuration file.
- Integrate API docs into a larger Quarto project alongside tutorials, examples, and other content.
- Replace Sphinx-based documentation workflows with a simpler Markdown and Quarto-native approach.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
Yes, if you are already using Quarto for documentation and want a lightweight alternative to Sphinx for API reference generation.
The low install friction and permissive MIT license make it accessible. However, the aging maintenance status (430 days since last release) suggests checking whether the package still aligns with current Quarto versions and your project's long-term needs before committing to it for critical documentation pipelines.
Install
quartodoc on PyPI
Before you install
Low install friction with a pure-Python wheel and 13 runtime dependencies. Maintenance status is aging—last release was 430 days ago, though the repository remains active with recent commits and no archival.
Quarto must be installed separately before quartodoc can generate documentation.
License in practice
MIT License permits free use, modification, and distribution with minimal restrictions, making it suitable for both open-source and commercial projects.
Quickstart
pip install quartodoc
# Add to _quarto.yml:
quartodoc:
package: your_package
sections:
- title: API
contents:
- your_function
# Generate docs:
quartodoc buildVerify before relying
- Whether the 430-day gap since last release indicates active maintenance or stalled development despite recent commits.
- Performance characteristics when documenting large packages with many objects.
- Compatibility with recent Quarto versions and any breaking changes in the Quarto ecosystem.
Package facts
| License | permissive license permissive |
| Python support | Supports the current Python release >=3.9 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 13 packagesblackclickgriffesphobjinvtabulateimportlib-metadataimportlib-resourcespydanticpyyamlrequeststyping-extensionswatchdogplum-dispatch |
| Maintenance | Aging 430 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 83,567 / month, #14,065 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | License :: OSI Approved :: MIT LicenseOperating System :: MacOSOperating System :: Microsoft :: WindowsOperating System :: UnixProgramming Language :: Python :: 3 :: OnlyProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.9 |
Evidence: quartodoc-0.11.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “quarto documentation tool”
- quartodocquartodoc generates Python API reference documentation from…
- rumdlA Rust-based Markdown linter and formatter that checks files against…
- nbdevnbdev is a notebook-driven development platform that exports Jupyter…
Give your agent the search over MCP, or paste the wish link into any chat.
More Documentation packages
Docutils converts plaintext documentation in reStructuredText format into multiple output formats including HTML, XML, and LaTeX using a modular processing system.
Sphinx generates professional documentation from reStructuredText source files, producing HTML, PDF, EPUB, and other formats with automatic cross-references, code highlighting, and hierarchical navigation.
Griffe extracts the complete structure and signatures of Python programs to generate API documentation or detect breaking changes in your project's public API.
Install it if you need to programmatically inspect Python code structure, generate API docs, or enforce API stability in CI.
A Sphinx extension that outputs documentation in serialized HTML formats (JSON and pickle) alongside standard HTML.
Alabaster is a clean, responsive Sphinx theme for documentation that requires Python 3.10 or newer and Sphinx 6.2 or newer.
A Sphinx extension that generates HTML help files from reStructuredText documentation source.
See also pdoc3 · sphinx-autodoc2 · docstring-to-markdown · pydoc-markdown · sphinx-markdown-tables · mkdocs-gen-files · sphinx-markdown-builder · griffe2md · mkdocs