Docs as a feature — serve markdown and auto-generated API reference.
Load markdown files at startup, render once via patitas, and serve through Kida templates with fragment navigation. Optionally introspect the frozen app to generate API reference pages (autodoc).
Basic usage::
from chirp.docs import DocsPlugin
app.mount("/docs", DocsPlugin(content_dir="./content/docs"))
Requirespatitas (pip install chirp[markdown]).
docs
| Name | Type | Default | Description |
|---|---|---|---|
type
|
|
— | |
qualified_name
|
|
— | |
element_type
|
|
— | |
description
|
|
— | |
source_file
|
|
— | |
line_number
|
|
— | |
is_autodoc
|
|
— | |
autodoc_element
|
|
— | |
_autodoc_template
|
|
— | |
_autodoc_url_path
|
|
— | |
_autodoc_page_type
|
|
— | |
title
|
|
— | |
doc_content_hash
|
|
— |
View source · /home/runner/work/chirp/chirp/site/../src/chirp/docs/__init__.py:1