models - Chirp

docs.models

module

Frozen dataclasses for the docs module.

All types are immutable and thread-safe.DocPageis the universal unit — hand-written markdown and autodoc-generated pages share the same type so the collection, search, templates,…

Frozen dataclasses for the docs module.

All types are immutable and thread-safe.DocPageis the universal unit — hand-written markdown and autodoc-generated pages share the same type so the collection, search, templates, and tools treat them identically.

docs.models

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`		—

Symbols on this page

class DocSource

Where aDocPageoriginated.

class TocEntry

A single heading extracted from rendered HTML.

class DocBlock

One section of a doc page, split at an H2 (or H3) boundary.

idis a snake_case identifier suitable for a kida block name…

class DocMetadata

Frontmatter fields parsed from a markdown file header.

class DocPage

One documentation page — the universal unit of the docs module.

Both hand-written markdown files and autodoc-generated reference pages produceDocPageinstances. Templates, search,…

class NavGroup

A group of pages for sidebar navigation.

When a category directory contains an index file (index.md, _index.md, or README.md), it…

class ParamDoc

One parameter in a route or tool signature.

class RouteDoc

Autodoc-generated from a singleRoute.

query_media_typescarries normalized accepted request media ranges for provisional HTTP QUERY routes and remainsNonefor ordinary routes.

class ToolDoc

Autodoc-generated from a single registered tool.

DocSource

class

Where aDocPageoriginated.

TocEntry

class

A single heading extracted from rendered HTML.

DocBlock

class

One section of a doc page, split at an H2 (or H3) boundary.

idis a snake_case identifier suitable for a kida block name (section_<id>). anchoris the original kebab-case heading id preserved for URL fragments (#section-overview). Content before the first heading becomes a synthesizedintroblock with depth=0.

DocMetadata

class

Frontmatter fields parsed from a markdown file header.

DocPage

class

One documentation page — the universal unit of the docs module.

Both hand-written markdown files and autodoc-generated reference pages produceDocPageinstances. Templates, search, and tools operate on this type exclusively.

NavGroup

class

A group of pages for sidebar navigation.

When a category directory contains an index file (index.md, _index.md, or README.md), it becomes the landing_page and the category heading links to it.

ParamDoc

class

One parameter in a route or tool signature.

RouteDoc

class

Autodoc-generated from a singleRoute.

query_media_typescarries normalized accepted request media ranges for provisional HTTP QUERY routes and remainsNonefor ordinary routes.

ToolDoc

class

Autodoc-generated from a single registered tool.

View source · /home/runner/work/chirp/chirp/site/../src/chirp/docs/models.py:1