Make syntax highlighting explicit in docs

This commit is contained in:
Dion Moult
2023-01-10 10:16:28 +11:00
parent 66e067d1ce
commit c8ba96cde8
236 changed files with 753 additions and 251 deletions
@@ -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)
@@ -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)
@@ -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
@@ -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)
@@ -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)
@@ -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,
@@ -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)
@@ -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)
@@ -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)
@@ -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)
@@ -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,
@@ -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)
@@ -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)
@@ -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)
@@ -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)
@@ -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)
@@ -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)
@@ -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)