{"categories":[{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"}],"enrichment":{"capability":"quartodoc generates Python API reference documentation from docstrings using Quarto and Markdown, serving as a Sphinx alternative that integrates with Quarto projects.","skillfed_tags":["quarto-integration","docstring-extraction","api-docs"],"use_cases":["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."],"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.\n\nThe 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.","worth_installing":"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."},"id":"quartodoc","links":{"html":"https://skillfed.io/packages/quartodoc","md":"https://skillfed.io/packages/quartodoc.md","pypi":"https://pypi.org/project/quartodoc/"},"maintenance":{"status":"aging"},"meta":{"latest_release":"2025-06-10","license_spdx":null,"license_treatment":"permissive","name":"quartodoc","python_support":"supports_current","summary":"Generate API documentation with Quarto."},"popularity":{"monthly_downloads":83567,"position":14065,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.11.1"}