Make syntax highlighting explicit in docs

src/ifcopenshell-python/ifcopenshell/__init__.py

@@ -21,7 +21,9 @@
 Typically used for opening an IFC via a filepath, or accessing one of the
 submodules.
 
-Example::
+Example:
+
+.. code:: python
 
     import ifcopenshell
     print(ifcopenshell.version) # v0.7.0-1b1fd1e6
@@ -143,7 +145,9 @@ def create_entity(type, schema="IFC4", *args, **kwargs):
     :returns: An entity instance
     :rtype: ifcopenshell.entity_instance.entity_instance
 
-    Example::
+    Example:
+
+    .. code:: python
 
         person = ifcopenshell.create_entity("IfcPerson") # #0=IfcPerson($,$,$,$,$,$,$,$)
         model = ifcopenshell.file()
@@ -165,7 +169,9 @@ def register_schema(schema):
     :param schema: A schema object
     :type schema: ifcopenshell.express.schema_class.SchemaClass
 
-    Example::
+    Example:
+
+    .. code:: python
 
         schema = ifcopenshell.express.parse("/path/to/ifc-custom.exp")
         ifcopenshell.register_schema(schema)

src/ifcopenshell-python/ifcopenshell/api/aggregate/assign_object.py

@@ -64,7 +64,9 @@ class Usecase:
         :return: The IfcRelAggregate relationship instance
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             project = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcProject")
             element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")

src/ifcopenshell-python/ifcopenshell/api/aggregate/unassign_object.py

@@ -43,7 +43,9 @@ class Usecase:
             whole still contains any other parts.
         :rtype: ifcopenshell.entity_instance.entity_instance, None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcSite")
             subelement1 = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcBuilding")

src/ifcopenshell-python/ifcopenshell/api/attribute/edit_attributes.py

@@ -36,7 +36,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             element = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")
             ifcopenshell.api.run("attribute.edit_attributes", model,

src/ifcopenshell-python/ifcopenshell/api/boundary/assign_connection_geometry.py

@@ -61,7 +61,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             ifcopenshell.api.run("boundary.assign_connection_geometry", model,
                 rel_space_boundary=element,

src/ifcopenshell-python/ifcopenshell/api/classification/add_classification.py

@@ -62,7 +62,9 @@ class Usecase:
         :return: The added IfcClassification element
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Option 1: adding a custom clasification from scratch
             ifcopenshell.api.run("classification.add_classification", model,

src/ifcopenshell-python/ifcopenshell/api/classification/add_reference.py

@@ -84,7 +84,9 @@ class Usecase:
         :return: The newly added IfcClassificationReference
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Option 1: adding and assigning a new reference from scratch
             wall_type = model.by_type("IfcWallType")[0]

src/ifcopenshell-python/ifcopenshell/api/classification/edit_classification.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             classification = model.by_type("IfcClassification")[0]
             # Change the name of the classification system to "Foo"

src/ifcopenshell-python/ifcopenshell/api/classification/edit_reference.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             reference = model.by_type("IfcClassification")[0]
             # Change the name of the reference to "Foo"

src/ifcopenshell-python/ifcopenshell/api/classification/remove_classification.py

@@ -30,7 +30,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             classification = model.by_type("IfcClassification")[0]
             ifcopenshell.api.run("classification.remove_classification", model,

src/ifcopenshell-python/ifcopenshell/api/classification/remove_reference.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             wall_type = model.by_type("IfcWallType")[0]
             classification = ifcopenshell.api.run("classification.add_classification",

src/ifcopenshell-python/ifcopenshell/api/constraint/add_metric.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: The newly created IfcMetric entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             objective = ifcopenshell.api.run("constraint.add_objective", model)
             metric = ifcopenshell.api.run("constraint.add_metric", model,

src/ifcopenshell-python/ifcopenshell/api/constraint/add_objective.py

@@ -32,7 +32,9 @@ class Usecase:
         :return: The newly created IfcObjective entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a new objective for code compliance requirements
             objective = ifcopenshell.api.run("constraint.add_objective", model)

src/ifcopenshell-python/ifcopenshell/api/constraint/edit_metric.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             objective = ifcopenshell.api.run("constraint.add_objective", model)
             metric = ifcopenshell.api.run("constraint.add_metric", model,

src/ifcopenshell-python/ifcopenshell/api/constraint/edit_objective.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             objective = ifcopenshell.api.run("constraint.add_objective", model)
             ifcopenshell.api.run("constraint.edit_objective", model,

src/ifcopenshell-python/ifcopenshell/api/constraint/remove_constraint.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             objective = ifcopenshell.api.run("constraint.add_objective", model)
             ifcopenshell.api.run("constraint.remove_constraint", model,

src/ifcopenshell-python/ifcopenshell/api/constraint/remove_metric.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             objective = ifcopenshell.api.run("constraint.add_objective", model)
             metric = ifcopenshell.api.run("constraint.add_metric", model,

src/ifcopenshell-python/ifcopenshell/api/context/add_context.py

@@ -107,7 +107,9 @@ class Usecase:
             IfcGeometricRepresentationSubContext entity
         :rtype: ifcopenshell.entity_instance.entity_instance, optional
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # If we plan to store 3D geometry in our IFC model, we have to setup
             # a "Model" context.

src/ifcopenshell-python/ifcopenshell/api/context/edit_context.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
             # Revit had a bug where they incorrectly called the body representation a "Facetation"

src/ifcopenshell-python/ifcopenshell/api/context/remove_context.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             model = ifcopenshell.api.run("context.add_context", model, context_type="Model")
             # Revit had a bug where they incorrectly called the body representation a "Facetation"

src/ifcopenshell-python/ifcopenshell/api/control/assign_control.py

@@ -43,7 +43,9 @@ class Usecase:
         :return: The newly created IfcRelAssignsToControl
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # One common usecase is to assign a calendar to a task
             calendar = ifcopenshell.api.run("sequence.add_work_calendar", model)

src/ifcopenshell-python/ifcopenshell/api/control/unassign_control.py

@@ -33,7 +33,9 @@ class Usecase:
             IfcRelAssignsToControl is returned, otherwise None.
         :rtype: ifcopenshell.entity_instance.entity_instance, None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's relate a cost item and a product
             wall = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcWall")

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item.py

@@ -37,7 +37,9 @@ class Usecase:
         :return: The newly created IfcCostItem
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # The very first cost item must be in a cost schedule
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_item_quantity.py

@@ -57,7 +57,9 @@ class Usecase:
             parameter
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             chair = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcFurniture")
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_schedule.py

@@ -45,7 +45,9 @@ class Usecase:
         :return: The newly created IfcCostSchedule entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             # Now that we have a cost schedule, we may add cost items to it

src/ifcopenshell-python/ifcopenshell/api/cost/add_cost_value.py

@@ -50,7 +50,9 @@ class Usecase:
         :return: The newly created IfcCostValue
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # We always need a schedule first prior to adding any cost items
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)

src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_item_quantity.py

@@ -50,7 +50,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/assign_cost_value.py

@@ -41,7 +41,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's create a schedule of rates with a single rate in it of 5.0
             rate_tables = ifcopenshell.api.run("cost.add_cost_schedule", model,

src/ifcopenshell-python/ifcopenshell/api/cost/calculate_cost_item_resource_value.py

@@ -44,7 +44,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # First, we need a cost schedule and item
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)

src/ifcopenshell-python/ifcopenshell/api/cost/copy_cost_item_values.py

@@ -34,7 +34,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Assume we have a schedule with multiple items in it
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_item_quantity.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_schedule.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             ifcopenshell.api.run("cost.edit_cost_schedule", model,

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/edit_cost_value_formula.py

@@ -39,7 +39,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item.py

@@ -32,7 +32,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_item_quantity.py

@@ -32,7 +32,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_schedule.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/remove_cost_value.py

@@ -32,7 +32,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/cost/unassign_cost_item_quantity.py

@@ -36,7 +36,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             schedule = ifcopenshell.api.run("cost.add_cost_schedule", model)
             item = ifcopenshell.api.run("cost.add_cost_item", model, cost_schedule=schedule)

src/ifcopenshell-python/ifcopenshell/api/document/add_information.py

@@ -37,7 +37,9 @@ class Usecase:
         :return: The newly created IfcDocumentInformation entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             # A document typically has a unique drawing or document name (which

src/ifcopenshell-python/ifcopenshell/api/document/add_reference.py

@@ -41,7 +41,9 @@ class Usecase:
         :return: The newly created IfcDocumentReference entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             ifcopenshell.api.run("document.edit_information", model,

src/ifcopenshell-python/ifcopenshell/api/document/assign_document.py

@@ -42,7 +42,9 @@ class Usecase:
         :return: The IfcRelAssociatesDocument relationship
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             ifcopenshell.api.run("document.edit_information", model,

src/ifcopenshell-python/ifcopenshell/api/document/edit_information.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             ifcopenshell.api.run("document.edit_information", model,

src/ifcopenshell-python/ifcopenshell/api/document/edit_reference.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             ifcopenshell.api.run("document.edit_information", model,

src/ifcopenshell-python/ifcopenshell/api/document/remove_information.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Add a document
             document = ifcopenshell.api.run("document.add_information", model)

src/ifcopenshell-python/ifcopenshell/api/document/remove_reference.py

@@ -28,7 +28,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             reference = ifcopenshell.api.run("document.add_reference", model, information=document)

src/ifcopenshell-python/ifcopenshell/api/document/unassign_document.py

@@ -32,7 +32,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             document = ifcopenshell.api.run("document.add_information", model)
             ifcopenshell.api.run("document.edit_information", model,

src/ifcopenshell-python/ifcopenshell/api/drawing/assign_product.py

@@ -49,7 +49,9 @@ class Usecase:
         :return: The created IfcRelAssignsToProduct relationship
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             furniture = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcFurniture")
             annotation = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcAnnotation")

src/ifcopenshell-python/ifcopenshell/api/drawing/edit_text_literal.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             text = model.createIfcTextLiteral()
             ifcopenshell.api.run("drawing.edit_text_literal", model,

src/ifcopenshell-python/ifcopenshell/api/drawing/unassign_product.py

@@ -37,7 +37,9 @@ class Usecase:
         :return: The created IfcRelAssignsToProduct relationship
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             furniture = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcFurniture")
             annotation = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcAnnotation")

src/ifcopenshell-python/ifcopenshell/api/geometry/add_axis_representation.py

@@ -60,7 +60,9 @@ class Usecase:
         :return: The newly created IfcShapeRepresentation entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             context = ifcopenshell.util.representation.get_context(model, "Plan", "Axis", "GRAPH_VIEW")
             axis = ifcopenshell.api.run("geometry.add_axis_representation", model,

src/ifcopenshell-python/ifcopenshell/api/georeference/add_georeferencing.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             ifcopenshell.api.run("georeference.add_georeferencing", model)
         """

src/ifcopenshell-python/ifcopenshell/api/georeference/edit_georeferencing.py

@@ -52,7 +52,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             ifcopenshell.api.run("georeference.add_georeferencing", model)
             # This is the simplest scenario, a defined CRS (GDA2020 / MGA Zone

src/ifcopenshell-python/ifcopenshell/api/grid/create_axis_curve.py

@@ -39,7 +39,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # A pretty standard rectangular grid, with only two axes.
             grid = ifcopenshell.api.run("root.create_entity", model, ifc_class="IfcGrid")

src/ifcopenshell-python/ifcopenshell/api/group/add_group.py

@@ -39,7 +39,9 @@ class Usecase:
         :return: The newly created IfcGroup
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
         """

src/ifcopenshell-python/ifcopenshell/api/group/assign_group.py

@@ -34,7 +34,9 @@ class Usecase:
         :return: The IfcRelAssignsToGroup relationship
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             group = ifcopenshell.api.run("group.add_group", model, Name="Furniture")
             ifcopenshell.api.run("group.assign_group", model,

src/ifcopenshell-python/ifcopenshell/api/group/edit_group.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             group = ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
             ifcopenshell.api.run("group.edit_group", model,

src/ifcopenshell-python/ifcopenshell/api/group/remove_group.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             group = ifcopenshell.api.run("group.add_group", model, Name="Unit 1A")
             ifcopenshell.api.run("group.remove_group", model, group=group)

src/ifcopenshell-python/ifcopenshell/api/group/unassign_group.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             group = ifcopenshell.api.run("group.add_group", model, Name="Furniture")
             furniture = model.by_type("IfcFurniture")

src/ifcopenshell-python/ifcopenshell/api/group/update_group_products.py

@@ -34,7 +34,9 @@ class Usecase:
         :return: The IfcRelAssignsToGroup relationship
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             group = ifcopenshell.api.run("group.add_group", model, Name="Furniture")
             ifcopenshell.api.run("group.update_group_products", model,

src/ifcopenshell-python/ifcopenshell/api/layer/assign_layer.py

@@ -39,7 +39,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Remember, all geometry needs to specify the context it is part of first.
             # See ifcopenshell.api.context.add_context for details.

src/ifcopenshell-python/ifcopenshell/api/layer/edit_layer.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
             ifcopenshell.api.run("layer.edit_layer", model,

src/ifcopenshell-python/ifcopenshell/api/layer/remove_layer.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             layer = ifcopenshell.api.run("layer.add_layer", model, Name="AI-WALL")
             ifcopenshell.api.run("layer.remove_layer", model, layer=layer)

src/ifcopenshell-python/ifcopenshell/api/layer/unassign_layer.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Remember, all geometry needs to specify the context it is part of first.
             # See ifcopenshell.api.context.add_context for details.

src/ifcopenshell-python/ifcopenshell/api/library/add_library.py

@@ -55,7 +55,9 @@ class Usecase:
         :return: The newly created IfcLibraryInformation
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             ifcopenshell.api.run("library.add_library", model, name="Brickschema")
         """

src/ifcopenshell-python/ifcopenshell/api/library/add_reference.py

@@ -38,7 +38,9 @@ class Usecase:
         :return: The newly created IfcLibraryReference element
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
 

src/ifcopenshell-python/ifcopenshell/api/library/assign_reference.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: The IfcRelAssociatesLibrary relationship entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
 

src/ifcopenshell-python/ifcopenshell/api/library/edit_library.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
             ifcopenshell.api.run("library.edit_library", model, library=library,

src/ifcopenshell-python/ifcopenshell/api/library/edit_reference.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
             # Let's create a reference to a single AHU in our Brickschema dataset

src/ifcopenshell-python/ifcopenshell/api/library/remove_library.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
             ifcopenshell.api.run("library.remove_library", model, library=library)

src/ifcopenshell-python/ifcopenshell/api/library/remove_reference.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
             reference = ifcopenshell.api.run("library.add_reference", model, library=library)

src/ifcopenshell-python/ifcopenshell/api/library/unassign_reference.py

@@ -30,7 +30,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             library = ifcopenshell.api.run("library.add_library", model, name="Brickschema")
 

src/ifcopenshell-python/ifcopenshell/api/material/add_constituent.py

@@ -44,7 +44,9 @@ class Usecase:
         :return: The newly created IfcMaterialConstituent
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a window type that has an aluminium frame
             # and a glass glazing panel. Notice we are assigning to the type

src/ifcopenshell-python/ifcopenshell/api/material/add_layer.py

@@ -42,7 +42,9 @@ class Usecase:
         :return: The newly created IfcMaterialLayer
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a wall type that has two layers of
             # gypsum with steel studs inside. Notice we are assigning to

src/ifcopenshell-python/ifcopenshell/api/material/add_list_item.py

@@ -45,7 +45,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a window type that has an aluminium frame
             # and a glass glazing panel. Notice we are assigning to the type

src/ifcopenshell-python/ifcopenshell/api/material/add_material.py

@@ -55,7 +55,9 @@ class Usecase:
         :return: The newly created IfcMaterial
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's create two materials with their respective categories
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")

src/ifcopenshell-python/ifcopenshell/api/material/add_material_set.py

@@ -66,7 +66,9 @@ class Usecase:
         :return: The newly created material set element
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a wall type that has two layers of
             # gypsum with steel studs inside. Notice we are assigning to

src/ifcopenshell-python/ifcopenshell/api/material/add_profile.py

@@ -48,7 +48,9 @@ class Usecase:
         :return: The newly created IfcMaterialProfile
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a steel I-beam. Notice we are assigning to
             # the type only, as all occurrences of that type will automatically

src/ifcopenshell-python/ifcopenshell/api/material/assign_material.py

@@ -67,7 +67,9 @@ class Usecase:
         :return: The IfcRelAssociatesMaterial entity
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's start with a simple concrete material
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")

src/ifcopenshell-python/ifcopenshell/api/material/assign_profile.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a steel I-beam. Notice we are assigning to
             # the type only, as all occurrences of that type will automatically

src/ifcopenshell-python/ifcopenshell/api/material/copy_material.py

@@ -41,7 +41,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")
             wood = ifcopenshell.api.run("material.add_material", model, name="TIM01", category="wood")

src/ifcopenshell-python/ifcopenshell/api/material/edit_assigned_material.py

@@ -31,7 +31,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")
             ifcopenshell.api.run("material.edit_assigned_material", model,

src/ifcopenshell-python/ifcopenshell/api/material/edit_constituent.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's add two materials
             aluminium1 = ifcopenshell.api.run("material.add_material", model, name="AL01", category="aluminium")

src/ifcopenshell-python/ifcopenshell/api/material/edit_layer.py

@@ -34,7 +34,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's create two materials typically used for steel stud partition
             # walls with gypsum lining.

src/ifcopenshell-python/ifcopenshell/api/material/edit_layer_usage.py

@@ -34,7 +34,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's start with a simple concrete material
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")

src/ifcopenshell-python/ifcopenshell/api/material/edit_profile.py

@@ -37,7 +37,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's create a material set to store our profiles.
             material_set = ifcopenshell.api.run("material.add_profile_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/edit_profile_usage.py

@@ -39,7 +39,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Let's imagine we have a steel I-beam. Notice we are assigning to
             # the type only, as all occurrences of that type will automatically

src/ifcopenshell-python/ifcopenshell/api/material/remove_constituent.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a material set for windows made out of aluminium and glass.
             material_set = ifcopenshell.api.run("material.add_material_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/remove_layer.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a material set for steel stud partition walls.
             material_set = ifcopenshell.api.run("material.add_material_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/remove_list_item.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a material list for aluminium windows.
             material_set = ifcopenshell.api.run("material.add_material_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/remove_material.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a material
             aluminium = ifcopenshell.api.run("material.add_material", model, name="AL01", category="aluminium")

src/ifcopenshell-python/ifcopenshell/api/material/remove_material_set.py

@@ -33,7 +33,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Create a material set
             material_set = ifcopenshell.api.run("material.add_material_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/remove_profile.py

@@ -29,7 +29,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # First, let's create a material set.
             material_set = ifcopenshell.api.run("material.add_profile_set", model,

src/ifcopenshell-python/ifcopenshell/api/material/reorder_set_item.py

@@ -36,7 +36,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             material_set = ifcopenshell.api.run("material.add_material_set", model,
                 name="Window", set_type="IfcMaterialList")

src/ifcopenshell-python/ifcopenshell/api/material/unassign_material.py

@@ -35,7 +35,9 @@ class Usecase:
         :return: None
         :rtype: None
 
-        Example::
+        Example:
+
+        .. code:: python
 
             concrete = ifcopenshell.api.run("material.add_material", model, name="CON01", category="concrete")
 

src/ifcopenshell-python/ifcopenshell/api/nest/assign_object.py

@@ -80,7 +80,9 @@ class Usecase:
         :return: The IfcRelNests relationship instance
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Faucets are designed to attach onto a sink through a predrilled hole.
             sink = ifcopenshell.api.run("root.create_entity", model,

src/ifcopenshell-python/ifcopenshell/api/owner/add_actor.py

@@ -48,7 +48,9 @@ class Usecase:
         :return: The newly created IfcActor or IfcOccupant
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             # Setup an organisation with a single role
             organisation = ifcopenshell.api.run("owner.add_organisation", model,

src/ifcopenshell-python/ifcopenshell/api/owner/add_address.py

@@ -40,7 +40,9 @@ class Usecase:
         :return: The new IfcPostalAddress or IfcTelecomAddress
         :rtype: ifcopenshell.entity_instance.entity_instance
 
-        Example::
+        Example:
+
+        .. code:: python
 
             organisation = ifcopenshell.api.run("owner.add_organisation", model)
 

src/ifcopenshell-python/ifcopenshell/api/owner/add_application.py

@@ -49,7 +49,9 @@ class Usecase:
             application intended for computers to read.
         :type application_identifier: str, optional
 
-        Example::
+        Example:
+
+        .. code:: python
 
             application = ifcopenshell.api.run("owner.add_application", model)
         """