`ifcopenshell.util.doc`¶

Module Contents¶

class ifcopenshell.util.doc.DocExtractor¶

clean_description(description)¶

clean_highlighted_words(text)¶

extract_ifc2x3()¶

extract_ifc2x3_entities()¶

extract_ifc2x3_property_sets()¶

extract_ifc2x3_property_sets_site_domains()¶

extract_ifc2x3_types()¶

extract_ifc4()¶

extract_ifc4_entities()¶

extract_ifc4_property_sets()¶

extract_ifc4_property_sets_site_domains()¶

extract_ifc4_types()¶

extract_ifc4x3()¶

extract_ifc4x3_entities()¶

extract_ifc4x3_property_sets()¶

setup_ifc2x3_reference_lookup()¶

setup_ifc4_reference_lookup()¶

ifcopenshell.util.doc.get_attribute_doc(version, entity, attribute, recursive=True)¶

ifcopenshell.util.doc.get_class_suggestions(version, class_name)¶

ifcopenshell.util.doc.get_db(version)¶

ifcopenshell.util.doc.get_entity_doc(version, entity_name, recursive=True)¶

ifcopenshell.util.doc.get_inverse_attributes(el)¶

ifcopenshell.util.doc.get_predefined_type_doc(version, entity, predefined_type)¶

ifcopenshell.util.doc.get_property_doc(version, pset, prop)¶

ifcopenshell.util.doc.get_property_set_doc(version, pset)¶

ifcopenshell.util.doc.get_schema_by_name(version: str) → ifcopenshell.ifcopenshell_wrapper.schema_definition¶

ifcopenshell.util.doc.get_type_doc(version, ifc_type)¶

ifcopenshell.util.doc.run_doc_api_examples()¶

ifcopenshell.util.doc.BASE_MODULE_PATH¶

ifcopenshell.util.doc.IFC2x3_DOCS_LOCATION¶

ifcopenshell.util.doc.IFC4_DOCS_LOCATION¶

ifcopenshell.util.doc.IFC4x3_DEV_LOCATION¶

ifcopenshell.util.doc.IFC4x3_HTML_LOCATION¶

ifcopenshell.util.doc.IFC4x3_SPEC_URL_TEMPLATE = 'https://ifc43-docs.standards.buildingsmart.org/IFC/RELEASE/IFC4x3/HTML/lexical/%s.htm'¶

ifcopenshell.util.doc.SCHEMA_FILES: dict[SUPPORTED_SCHEMA, dict]¶

ifcopenshell.util.doc.SUPPORTED_SCHEMA¶

ifcopenshell.util.doc.db¶

ifcopenshell.util.doc.extractor¶

ifcopenshell.util.doc.schema_by_name: dict[SUPPORTED_SCHEMA, ifcopenshell.ifcopenshell_wrapper.schema_definition | None]¶