make spec tables prettier
This commit is contained in:
parent
39ef845a53
commit
6e0fe70500
7 changed files with 49 additions and 15 deletions
|
@ -318,6 +318,29 @@ table.citation td {
|
||||||
border-bottom: none;
|
border-bottom: none;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
table.colwidths-auto caption {
|
||||||
|
font-family: monospace;
|
||||||
|
font-size: x-large;
|
||||||
|
padding: 2px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.colwidths-auto {
|
||||||
|
width:100%;
|
||||||
|
margin-top: 20px;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.colwidths-auto tr td:nth-child(1) {
|
||||||
|
width: 15%;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.colwidths-auto tr td:nth-child(2) {
|
||||||
|
width: 15%;
|
||||||
|
}
|
||||||
|
|
||||||
|
table.colwidths-auto tr td:nth-child(3) {
|
||||||
|
width: 70%;
|
||||||
|
}
|
||||||
|
|
||||||
/* -- other body styles ----------------------------------------------------- */
|
/* -- other body styles ----------------------------------------------------- */
|
||||||
|
|
||||||
ol.arabic {
|
ol.arabic {
|
||||||
|
|
|
@ -6,8 +6,7 @@
|
||||||
{{common_event.desc}}
|
{{common_event.desc}}
|
||||||
|
|
||||||
{% for table in common_event.tables %}
|
{% for table in common_event.tables %}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
|
||||||
|
|
||||||
{{ tables.paramtable(table.rows, ["Key", "Type", "Description"]) }}
|
{{ tables.paramtable(table.rows, [(table.title or "") ~ " Key", "Type", "Description"]) }}
|
||||||
|
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
|
@ -12,7 +12,6 @@
|
||||||
{{event.desc}}
|
{{event.desc}}
|
||||||
|
|
||||||
{% for table in event.content_fields %}
|
{% for table in event.content_fields %}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
|
||||||
|
|
||||||
{{ tables.paramtable(table.rows, [(table.title or "Content") ~ " Key", "Type", "Description"]) }}
|
{{ tables.paramtable(table.rows, [(table.title or "Content") ~ " Key", "Type", "Description"]) }}
|
||||||
|
|
||||||
|
|
|
@ -18,8 +18,8 @@ Request format:
|
||||||
{{ tables.split_paramtable(endpoint.req_param_by_loc) }}
|
{{ tables.split_paramtable(endpoint.req_param_by_loc) }}
|
||||||
{% if (endpoint.req_body_tables) %}
|
{% if (endpoint.req_body_tables) %}
|
||||||
{% for table in endpoint.req_body_tables -%}
|
{% for table in endpoint.req_body_tables -%}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
{{ tables.paramtable(table.rows, [(table.title or "") ~ " Parameter", "Type", "Description"] ) }}
|
||||||
{{ tables.paramtable(table.rows) }}
|
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
||||||
|
@ -37,9 +37,9 @@ Response headers:
|
||||||
Response format:
|
Response format:
|
||||||
|
|
||||||
{% for table in endpoint.res_tables -%}
|
{% for table in endpoint.res_tables -%}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
|
||||||
|
|
||||||
{{ tables.paramtable(table.rows) }}
|
{{ tables.paramtable(table.rows, [(table.title or "") ~ " Parameter", "Type", "Description"] ) }}
|
||||||
|
|
||||||
|
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
|
|
|
@ -4,9 +4,14 @@
|
||||||
{{(4 + event.msgtype | length) * title_kind}}
|
{{(4 + event.msgtype | length) * title_kind}}
|
||||||
{{event.desc | wrap(80)}}
|
{{event.desc | wrap(80)}}
|
||||||
{% for table in event.content_fields -%}
|
{% for table in event.content_fields -%}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
|
||||||
|
|
||||||
{{ tables.paramtable(table.rows, [(table.title or "Content") ~ " Key", "Type", "Description"]) }}
|
{% if table.title -%}
|
||||||
|
{% set tabletitle = table.title -%}
|
||||||
|
{% else -%}
|
||||||
|
{% set tabletitle = "" -%}
|
||||||
|
{% endif -%}
|
||||||
|
|
||||||
|
{{ tables.paramtable(table.rows, [(table.title or "Content") ~ " Key", "Type", "Description"] ) }}
|
||||||
|
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
Example:
|
Example:
|
||||||
|
|
|
@ -8,7 +8,7 @@
|
||||||
{% endif %}
|
{% endif %}
|
||||||
|
|
||||||
{% for table in definition.tables -%}
|
{% for table in definition.tables -%}
|
||||||
{{"``"+table.title+"``" if table.title else "" }}
|
{{"``7777"+table.title+"``" if table.title else "" }}
|
||||||
{{ tables.paramtable(table.rows) }}
|
{{ tables.paramtable(table.rows) }}
|
||||||
{% endfor %}
|
{% endfor %}
|
||||||
|
|
||||||
|
|
|
@ -36,6 +36,14 @@
|
||||||
{% set fieldwidths = (([titlerow] + flatrows) |
|
{% set fieldwidths = (([titlerow] + flatrows) |
|
||||||
fieldwidths(rowkeys[0:-1], [10, 10])) + [50] -%}
|
fieldwidths(rowkeys[0:-1], [10, 10])) + [50] -%}
|
||||||
|
|
||||||
|
{% set caption = titlerow['key'] | replace (' Key', '') | replace ('Parameter', '') -%}
|
||||||
|
{% if caption == 'Content' -%}
|
||||||
|
{% set caption = '' -%}
|
||||||
|
{% endif -%}
|
||||||
|
|
||||||
|
{{".. table:: "}}{{ caption }}
|
||||||
|
{{" :widths: auto"}}
|
||||||
|
{{""}}
|
||||||
{{ tableheader(fieldwidths) }}
|
{{ tableheader(fieldwidths) }}
|
||||||
{{ tablerow(fieldwidths, titlerow, rowkeys) }}
|
{{ tablerow(fieldwidths, titlerow, rowkeys) }}
|
||||||
{{ tableheader(fieldwidths) }}
|
{{ tableheader(fieldwidths) }}
|
||||||
|
@ -59,7 +67,7 @@
|
||||||
# Write a table header row, for the given column widths
|
# Write a table header row, for the given column widths
|
||||||
#}
|
#}
|
||||||
{% macro tableheader(widths) -%}
|
{% macro tableheader(widths) -%}
|
||||||
{% for arg in widths -%}
|
{{" "}}{% for arg in widths -%}
|
||||||
{{"="*arg}} {% endfor -%}
|
{{"="*arg}} {% endfor -%}
|
||||||
{% endmacro %}
|
{% endmacro %}
|
||||||
|
|
||||||
|
@ -71,7 +79,7 @@
|
||||||
# attributes of 'row' to look up for values to put in the columns.
|
# attributes of 'row' to look up for values to put in the columns.
|
||||||
#}
|
#}
|
||||||
{% macro tablerow(widths, row, keys) -%}
|
{% macro tablerow(widths, row, keys) -%}
|
||||||
{% for key in keys -%}
|
{{" "}}{% for key in keys -%}
|
||||||
{% set value=row[key] -%}
|
{% set value=row[key] -%}
|
||||||
{% if not loop.last -%}
|
{% if not loop.last -%}
|
||||||
{# the first few columns need space after them -#}
|
{# the first few columns need space after them -#}
|
||||||
|
@ -81,7 +89,7 @@
|
||||||
the preceding columns, plus the number of preceding columns (for the
|
the preceding columns, plus the number of preceding columns (for the
|
||||||
separators)) -#}
|
separators)) -#}
|
||||||
{{ value | wrap(widths[loop.index0]) |
|
{{ value | wrap(widths[loop.index0]) |
|
||||||
indent_block(widths[0:-1]|sum + loop.index0) -}}
|
indent_block(widths[0:-1]|sum + loop.index0 + 2) -}}
|
||||||
{% endif -%}
|
{% endif -%}
|
||||||
{% endfor -%}
|
{% endfor -%}
|
||||||
{% endmacro %}
|
{% endmacro %}
|
||||||
|
@ -93,10 +101,10 @@
|
||||||
# write a tablespan row. This is a single value which spans the entire table.
|
# write a tablespan row. This is a single value which spans the entire table.
|
||||||
#}
|
#}
|
||||||
{% macro tablespan(widths, value) -%}
|
{% macro tablespan(widths, value) -%}
|
||||||
{{value}}
|
{{" "}}{{value}}
|
||||||
{# we write a trailing space to stop the separator being misinterpreted
|
{# we write a trailing space to stop the separator being misinterpreted
|
||||||
# as a header line. -#}
|
# as a header line. -#}
|
||||||
{{"-"*(widths|sum + widths|length -1)}} {% endmacro %}
|
{{" "}}{{"-"*(widths|sum + widths|length -1)}} {% endmacro %}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue