Skip to content

Commit 55310f2

Browse files
committed
Update documentation
1 parent a47ac3a commit 55310f2

File tree

10 files changed

+182
-1313
lines changed

10 files changed

+182
-1313
lines changed

docs/api/attributes/elastic.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,3 @@ elastic
99

1010
.. autoclass:: ElasticConstants
1111
:members:
12-
:undoc-members:

docs/api/attributes/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ Attributes
44
.. toctree::
55
:maxdepth: 1
66

7-
xsection.Section.elastic
7+
elastic
88
surface
99

docs/api/attributes/surface.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
.. _surface:
22

33
surface
4-
^^^^^^^
4+
^^^^^^^

docs/api/attributes/xsection.Section.elastic.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/api/index.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ The ``xsection.library`` submodule exposes the following convenience classes whi
2222
Circle <Circle>
2323
Rectangle <Rectangle>
2424
WideFlange <WideFlange>
25+
HalfFlange <HalfFlange>
2526
Channel <Channel>
2627
Angle <Angle>
2728
aisc_data <aiscData>
@@ -32,11 +33,11 @@ The ``xsection.library`` submodule exposes the following convenience classes whi
3233
:hidden:
3334

3435
xsection <self>
36+
library/index
3537
attributes/index
3638
methods/index
3739
polygon/xsection.PolygonSection
3840
composite/xsection.CompositeSection
39-
library/index
4041

4142

4243
.. currentmodule:: xsection

docs/api/library/index.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,10 @@ The `xsection.library` submodule holds several convenience classes that wrap the
1717
Circle <Circle>
1818
Rectangle <Rectangle>
1919
WideFlange
20+
HalfFlange
2021
Channel <Channel>
2122
Angle
23+
Equigon
2224
from_aisc <fromAISC>
2325
aisc_data <aiscData>
2426
@@ -33,7 +35,9 @@ The `xsection.library` submodule holds several convenience classes that wrap the
3335
from_aisc
3436
Circle
3537
Rectangle
38+
HalfFlange
3639
WideFlange
3740
Channel
3841
Angle
42+
Equigon
3943
```

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,6 @@
5959
f"{html_baseurl}index.html"
6060
]
6161
html_additional_pages = {'index': 'home.html'}
62-
g = "https://gallery.stairlab.io"
6362
html_context = {
6463
"description": description,
6564
"introduction": "xsection is a Python library for analyzing structural cross sections.",
@@ -68,7 +67,7 @@
6867
"features": [
6968
{"title": "Free", "body": "All source code contributed to xsection is licensed under a <em>pure</em> BSD."},
7069
{"title": "Accurate", "body": "."},
71-
{"title": "Integrated", "body": 'xsection is designed to integrate with state-of-the-art open-source software like <a href="https://xara.so">xara</a> and <a href="https://peer.berkeley.edu/opensees/">OpenSees</a>.'},
70+
{"title": "Integrated", "body": 'xsection is designed to integrate with state-of-the-art open-source software like <a href="https://xara.so">xara</a>.'},
7271
],
7372
"home_image": "_static/images/home.png",
7473
"cannonical_home": "https://xsection.io",
@@ -93,11 +92,12 @@
9392

9493
html_static_path = ["_static"]
9594

95+
g = f"{html_baseurl}/examples/"# "https://gallery.stairlab.io"
9696
def _add_examples(app, pagename, templatename, context, doctree):
9797
if templatename == "home.html":
9898
context["home_image"] = "_static/images/girder-light.png"
9999
context["examples"] = [
100-
{"title": "Databases", "link": f"{g}/examples/constants/", "image": "../_static/images/gallery/Constants.png", "description": "Material and section constants."},
100+
{"title": "Basic Shapes", "link": f"{g}/introduction/", "image": "../_static/images/gallery/ShapeLibrary.png", "description": "Material and section constants."},
101101
{"title": "Stresses", "link": f"{g}/examples/framesections/", "image": "../_static/images/gallery/HaywardSmall.png", "description": "Detailed analysis of structural cross sections."},
102102
{"title": "Composites", "link": f"{g}/examples/example2/", "image": "../_static/images/gallery/concrete.png", "description": "."},
103103
]

docs/examples/elastic/isotropy.ipynb

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,20 @@
55
"id": "f4fa1ab0",
66
"metadata": {},
77
"source": [
8-
"# Isotropy"
8+
"# Elastic Properties"
99
]
10+
},
11+
{
12+
"cell_type": "markdown",
13+
"id": "801a35bb",
14+
"metadata": {},
15+
"source": []
16+
},
17+
{
18+
"cell_type": "markdown",
19+
"id": "e909d8e5",
20+
"metadata": {},
21+
"source": []
1022
}
1123
],
1224
"metadata": {

docs/examples/introduction.ipynb

Lines changed: 156 additions & 1289 deletions
Large diffs are not rendered by default.

pyproject.toml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
22
name = "xsection"
3-
version = "0.0.20"
3+
version = "0.0.23"
44
authors = [
55
{name="Claudio M. Perez", email="50180406+claudioperez@users.noreply.github.com"}
66
]
@@ -42,7 +42,7 @@ classifiers = [
4242

4343
dependencies = [
4444
"numpy",
45-
"shps>=0.0.28",
45+
"shps>=0.0.29",
4646
"veux>=0.0.40",
4747
# Analysis
4848
"xara>=0.0.8",

0 commit comments

Comments
 (0)