Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-12 20:10:50 +01:00
Code Issues Projects Releases Wiki Activity

updates for v0.14.0 schema style (#1170)

Browse Source
This commit is contained in:
Guillermo Ruffino 2021-05-14 20:49:29 -03:00 committed by GitHub
parent d8646a5f7e
commit 2d8b1a2733
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
schema_doc.py
View File

@ -481,7 +481,8 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
c = self.json_base_config or self.json_component
if c:
trigger_schema = self.find_props(c).get(key)
self.props = self.find_props(trigger_schema)
if trigger_schema is not None:
self.props = self.find_props(trigger_schema)
self.props_section_title = title_text
if title_text == PIN_CONFIGURATION_VARIABLES:
@ -545,6 +546,8 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
def find_registry_prop(self, registry_name, key, description):
registry = self.app.jschema["definitions"][registry_name]["anyOf"]
for item in registry:
if "$ref" in item:
item = self.get_ref(item)
if key in item["properties"]:
item["properties"][key]["markdownDescription"] = description
self.props = self.find_props(item["properties"][key])
@ -641,15 +644,33 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
ref = self.get_ref(prop["anyOf"][0])
self.prop_stack.append(self.props)
self.props = self.find_props(ref)
# nowhere put this props info...
# otherwise inner bullet list will be interpreted as property list
if self.props_level > 1:
else:
# TODO: if the list items are formated like:
# - ``value`` <optional description>
# - ``other value`` <optional description>
# then we could ensure these are enum values (or populate enum values double check.)
# Currently some enum values are also in the **value** format.
if (
# most likely an enum, the values are most likely retrieved from ESPHome validation schema
"enum" in prop
# or custom components has list of sensors/binary sensors, etc.
or (
prop.get("markdownDescription", "").startswith("**list**")
and self.docname.endswith("/custom")
)
):
raise nodes.SkipChildren
# nowhere put this props info...
# otherwise inner bullet list will be interpreted as property list
logger = logging.getLogger(__name__)
logger.info(
f"In {self.docname} / {self.previous_title_text} property {self.current_prop} a unknown info sub bullet list."
)
raise nodes.SkipChildren
else:
# nowhere put this props info...
# otherwise inner bullet list will be interpreted as property list
if self.props_level > 1:
raise nodes.SkipChildren
raise nodes.SkipChildren
if not self.props and self.multi_component is None:
raise nodes.SkipChildren
@ -914,6 +935,8 @@ class SchemaGeneratorVisitor(nodes.NodeVisitor):
prop_set = ref.get("anyOf")
if isinstance(prop_set, list):
for k in prop_set:
if "$ref" in k:
k = self.visitor.get_ref(k)
if key in k["properties"]:
self.store = k["properties"]
return self.store[key]