comp-chem/cp2k
1
0
Fork 0
mirror of https://github.com/cp2k/cp2k.git synced 2026-07-21 14:35:15 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve input keyword metadata rendering (#5569)

Browse source
This commit is contained in:
SY Wang 2026-07-17 20:34:23 +08:00 • committed by GitHub
parent 4ca962cc2c
commit f6c0ee4712
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/generate_input_reference.py
View file

@ -342,20 +342,28 @@ def render_keyword(
output += [f":module: {section_xref}"]
else:
output += [":noindex:"]
output += [f":type: '{data_type}{n_var_brackets}'"]
if default_value or default_unit:
default_unit_bracketed = f"[{default_unit}]" if default_unit else ""
output += [f":value: '{default_value} {default_unit_bracketed}'"]
output += [""]
# Render keyword properties as compact, unbulleted lines instead of placing the
# type and default value in the object signature.
metadata = [f"**Type:** {escape_markdown(data_type + n_var_brackets)}"]
if default_value or default_unit:
default = default_value
if default_unit:
default += f" [{default_unit}]"
metadata += [f"**Default:** {escape_markdown(default.strip())}"]
if repeats:
output += ["**Keyword can be repeated.**", ""]
metadata += ["**Repeatable:** yes"]
if len(keyword_names) > 1:
aliases = " ,".join(keyword_names[1:])
output += [f"**Aliases:** {escape_markdown(aliases)}", ""]
aliases = ", ".join(keyword_names[1:])
metadata += [f"**Aliases:** {escape_markdown(aliases)}"]
if lone_keyword_value:
output += [f"**Lone keyword:** `{escape_markdown(lone_keyword_value)}`", ""]
metadata += [f"**Lone keyword:** {escape_markdown(lone_keyword_value)}"]
if usage:
output += [f"**Usage:** _{escape_markdown(usage)}_", ""]
metadata += [f"**Usage:** _{escape_markdown(usage)}_"]
output += [" \n".join(metadata), ""]
if description:
output += [f"**Description:** {escape_markdown(description)}", ""]
if data_type == "enum":
output += ["**Valid values:**"]
for item in keyword.findall("DATA_TYPE/ENUMERATION/ITEM"):
@ -369,7 +377,6 @@ def render_keyword(
if mentions:
mentions_list = ", ".join([f"⭐[](project:{m})" for m in mentions])
output += [f"**Mentions:** {mentions_list}", ""]
output += [escape_markdown(description)]
if github:
output += [github_link(location)]
output += ["", "```", ""] # Close py:data directive.