mirror of
https://github.com/simonw/datasette.git
synced 2026-07-31 22:44:08 +02:00
e889403d3b* ruff>=0.16.0 See https://astral.sh/blog/ruff-v0.16.0 * uv run ruff check . --fix --unsafe-fixes * Ruff fixes by Claude Code Opus 5
43 lines
1.5 KiB
Python
43 lines
1.5 KiB
Python
"""
|
|
Cog helpers for generating docs/template_context.rst from the Context
|
|
dataclasses and TEMPLATE_BASE_CONTEXT - same pattern as json_api_doc.py.
|
|
"""
|
|
|
|
|
|
def template_context(cog):
|
|
from datasette.app import TEMPLATE_BASE_CONTEXT
|
|
from datasette.template_contexts import PAGES
|
|
|
|
cog.out("\n")
|
|
_section(
|
|
cog,
|
|
"Base context",
|
|
(
|
|
"These variables are available on every page rendered by "
|
|
"Datasette, including pages rendered by plugins that use "
|
|
":ref:`datasette.render_template() <datasette_render_template>`. "
|
|
"Plugins can add additional variables using the "
|
|
":ref:`plugin_hook_extra_template_vars` hook."
|
|
),
|
|
)
|
|
for name, doc in TEMPLATE_BASE_CONTEXT.items():
|
|
cog.out(f"``{name}``\n")
|
|
cog.out(f" {doc}\n\n")
|
|
|
|
for klass in PAGES.values():
|
|
title = "{} page".format(klass.__name__.removesuffix("Context"))
|
|
intro = f"{klass.__doc__} Rendered using the ``{klass.documented_template}`` template."
|
|
_section(cog, title, intro)
|
|
if klass.extras_scope is not None:
|
|
cog.out(
|
|
"Many of these keys are shared with the :ref:`JSON API "
|
|
"<json_api>` for this page.\n\n"
|
|
)
|
|
for f in sorted(klass.documented_fields(), key=lambda f: f.name):
|
|
cog.out(f"``{f.name}`` - ``{f.type_name}``\n")
|
|
cog.out(f" {f.help}\n\n")
|
|
|
|
|
|
def _section(cog, title, intro):
|
|
cog.out("{}\n{}\n\n".format(title, "-" * len(title)))
|
|
cog.out(f"{intro}\n\n")
|