Skip to content

Commit db763c4

Browse files
Fix docs for concrete_sections
1 parent a615a7d commit db763c4

File tree

3 files changed

+22
-12
lines changed

3 files changed

+22
-12
lines changed

docs/source/rst/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,10 @@ concrete_rectangular_section
198198
""""""""""""""""""""""""""""
199199
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_rectangular_section
200200

201+
concrete_column_section
202+
"""""""""""""""""""""""
203+
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_column_section
204+
201205
concrete_tee_section
202206
""""""""""""""""""""
203207
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_tee_section
@@ -206,6 +210,10 @@ concrete_circular_section
206210
"""""""""""""""""""""""""
207211
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_circular_section
208212

213+
add_bar
214+
"""""""
215+
.. autofunction:: sectionproperties.pre.library.concrete_sections.add_bar
216+
209217

210218
*bridge_sections* Module
211219
^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/rst/section_library.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,11 @@ Concrete Rectangular Section
139139
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_rectangular_section
140140
:noindex:
141141

142+
Concrete Column Section
143+
-----------------------
144+
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_column_section
145+
:noindex:
146+
142147
Concrete Tee Section
143148
--------------------
144149
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_tee_section
@@ -149,6 +154,11 @@ Concrete Circular Section
149154
.. autofunction:: sectionproperties.pre.library.concrete_sections.concrete_circular_section
150155
:noindex:
151156

157+
Add Bar
158+
-------
159+
.. autofunction:: sectionproperties.pre.library.concrete_sections.add_bar
160+
:noindex:
161+
152162

153163
.. _label-bridge-library:
154164

sectionproperties/pre/library/concrete_sections.py

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -216,19 +216,8 @@ def concrete_column_section(
216216
conc_mat=concrete, steel_mat=steel, filled=False, n_circle=4
217217
)
218218
geometry.create_mesh(mesh_sizes=[500])
219-
220-
.. figure:: ../images/sections/concrete_rectangular_section_geometry.png
221-
:align: center
222-
:scale: 50 %
223-
224-
Concrete rectangular section geometry.
225-
226-
.. figure:: ../images/sections/concrete_rectangular_section_mesh.png
227-
:align: center
228-
:scale: 50 %
229-
230-
Mesh generated from the above geometry.
231219
"""
220+
232221
concrete_geometry = primitive_sections.rectangular_section(b, d, material=conc_mat)
233222
bar_extents = concrete_geometry.offset_perimeter(
234223
-cover - dia_bar / 2
@@ -498,13 +487,16 @@ def add_bar(
498487
n: int = 4,
499488
) -> geometry.CompoundGeometry:
500489
"""Adds a reinforcing bar to a *sectionproperties* geometry.
490+
501491
Bars are discretised by four points by default.
492+
502493
:param geometry: Reinforced concrete geometry to which the new bar will be added
503494
:param area: Bar cross-sectional area
504495
:param material: Material object for the bar
505496
:param x: x-position of the bar
506497
:param y: y-position of the bar
507498
:param n: Number of points to discretise the bar circle
499+
508500
:return: Reinforced concrete geometry with added bar
509501
"""
510502

0 commit comments

Comments
 (0)