mirror of
https://github.com/simonw/datasette.git
synced 2026-06-24 17:54:35 +02:00
8e01542fe9
datasette/template_contexts.py is now a thin index with no documentation strings of its own - the docs live next to the code: - Each page's Context class (DatabaseContext, QueryContext, TableContext, RowContext) carries a docstring, its template name and help metadata on view-added fields, in the view module itself - extra_field() fields document themselves from the Extra classes - The keys render_template() adds to every page are documented in TEMPLATE_BASE_CONTEXT in app.py, next to the code that adds them, with the contract tests keeping the two in sync docs/template_context.rst is regenerated from the dataclasses, so the table and row pages now include field types like the others. Refs #2127 Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
45 lines
1.6 KiB
Python
45 lines
1.6 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("``{}``\n".format(name))
|
|
cog.out(" {}\n\n".format(doc))
|
|
|
|
for klass in PAGES.values():
|
|
title = "{} page".format(klass.__name__.removesuffix("Context"))
|
|
intro = "{} Rendered using the ``{}`` template.".format(
|
|
klass.__doc__, klass.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("``{}`` - ``{}``\n".format(f.name, f.type_name))
|
|
cog.out(" {}\n\n".format(f.help))
|
|
|
|
|
|
def _section(cog, title, intro):
|
|
cog.out("{}\n{}\n\n".format(title, "-" * len(title)))
|
|
cog.out("{}\n\n".format(intro))
|