{"id":45967,"library":"quartodoc","title":"Quartodoc","description":"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.","status":"active","version":"0.11.1","language":"python","source_language":"en","source_url":"https://github.com/machow/quartodoc","tags":["documentation","quarto","api-docs"],"install":[{"cmd":"pip install quartodoc","lang":"bash","label":"PyPI"},{"cmd":"pip install quartodoc[pandas]","lang":"bash","label":"With pandas support"}],"dependencies":[{"reason":"Quarto CLI must be installed separately and available in PATH","package":"quarto","optional":false},{"reason":"Optional but commonly used for DataFrame display in docs","package":"pandas","optional":true}],"imports":[{"wrong":"from quartodoc import get_auto_documentation_plan","symbol":"Auto","correct":"from quartodoc import Auto"},{"symbol":"Builder","correct":"from quartodoc import Builder"},{"symbol":"MdRenderer","correct":"from quartodoc import MdRenderer"}],"quickstart":{"code":"from quartodoc import get_auto_documentation_plan\n\nplan = get_auto_documentation_plan(\n    package=\"mypackage\",\n    output_dir=\"docs/api\",\n    title=\"API Reference\",\n)\nplan.write_metadata()\nprint(\"Plan written to docs/api/_metadata.yml\")","lang":"python","description":"Generate a basic API documentation plan for a package."},"warnings":[{"fix":"Install Quarto from https://quarto.org/docs/download/","message":"Requires Quarto CLI installed separately. pip install does not install Quarto itself.","severity":"gotcha","affected_versions":"all"},{"fix":"Use 'get_auto_documentation_plan' instead of 'build_docs'.","message":"In version 0.11.0, the function 'get_auto_documentation_plan' replaced 'build_docs'. Old code using 'build_docs' will break.","severity":"breaking","affected_versions":">=0.11.0"},{"fix":"Use 'from quartodoc import Blueprint' instead of 'from quartodoc.blueprint import Blueprint'.","message":"The 'blueprint' module is deprecated in favor of 'Blueprint' class from main module.","severity":"deprecated","affected_versions":">=0.10.0"}],"env_vars":null,"search_vec":"'0.11.1':18 '3.9':21 'api':4,30 'api-doc':29 'cadenc':26 'content':15 'current':16 'doc':31 'docstr':12 'document':5,27 'generat':3 'merg':11 'narrat':14 'project':8 'python':7,20 'quarto':10,28 'quartodoc':1,2 'releas':25 'stabl':24 'support':19 'use':9 'version':17","created_at":"2026-06-07T12:57:37.207056+00:00","updated_at":"2026-06-07T12:57:37.207056+00:00","problems":null,"ecosystem":"pypi","meta_description":null,"install_score":null,"quickstart_score":null,"quickstart_tag":null,"pypi_latest":null,"cli_name":null,"cli_version":null,"type":"library","homepage":null,"github":null,"docs":null,"changelog":null,"pypi":null,"npm":null,"openapi_spec":null,"status_page":null,"smithery":null,"categories":["devops"],"base_url":null,"auth_type":null,"provenance":{"verified_status":"passing","verified_at":"2026-07-03","last_verified":"2026-07-03","next_check":"2026-08-02","install_tag":null}}