ifcopenshell.util.doc#

Module Contents#

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#
ifcopenshell.util.doc.db#
ifcopenshell.util.doc.extractor#
ifcopenshell.util.doc.schema_by_name#
class ifcopenshell.util.doc.DocExtractor#
clean_description(self, description)#
clean_highlighted_words(self, text)#
extract_ifc2x3(self)#
extract_ifc2x3_entities(self)#
extract_ifc2x3_property_sets(self)#
extract_ifc2x3_property_sets_site_domains(self)#
extract_ifc2x3_types(self)#
extract_ifc4(self)#
extract_ifc4_entities(self)#
extract_ifc4_property_sets(self)#
extract_ifc4_property_sets_site_domains(self)#
extract_ifc4_types(self)#
extract_ifc4x3(self)#
extract_ifc4x3_entities(self)#
extract_ifc4x3_property_sets(self)#
setup_ifc2x3_reference_lookup(self)#
setup_ifc4_reference_lookup(self)#
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)#
ifcopenshell.util.doc.get_type_doc(version, ifc_type)#
ifcopenshell.util.doc.run_doc_api_examples()#