Skip to content

Commit 35f152e

Browse files
committed
update docs
1 parent 70b6c0a commit 35f152e

File tree

9 files changed

+4772
-62
lines changed

9 files changed

+4772
-62
lines changed
247 KB
Loading

docs/_static/images/gallery/overview.svg

Lines changed: 0 additions & 1 deletion
This file was deleted.
140 KB
Loading

docs/conf.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -65,9 +65,9 @@
6565
"examples": [
6666
],
6767
"features": [
68-
{"title": "Free", "body": "All source code contributed to xsection is licensed under a <em>pure</em> BSD."},
69-
{"title": "Accurate", "body": "."},
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>.'},
68+
# {"title": "Free", "body": "All source code contributed to xsection is licensed under a <em>pure</em> BSD."},
69+
# {"title": "Accurate", "body": "."},
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>.'},
7171
],
7272
"home_image": "_static/images/home.png",
7373
"cannonical_home": "https://xsection.io",
@@ -92,14 +92,14 @@
9292

9393
html_static_path = ["_static"]
9494

95-
g = f"{html_baseurl}/examples/"# "https://gallery.stairlab.io"
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": "Basic Shapes", "link": f"{g}/introduction/", "image": "../_static/images/gallery/ShapeLibrary.png", "description": "Material and section constants."},
101-
{"title": "Stresses", "link": f"{g}/examples/framesections/", "image": "../_static/images/gallery/HaywardSmall.png", "description": "Detailed analysis of structural cross sections."},
102-
{"title": "Composites", "link": f"{g}/examples/example2/", "image": "../_static/images/gallery/concrete.png", "description": "."},
100+
{"title": "Basic Shapes", "link": f"{g}/introduction.html", "image": "../_static/images/gallery/W14x211.png", "description": "Material and section constants."},
101+
{"title": "Transforms", "link": f"{g}/transformations.html", "image": "../_static/images/gallery/transform.png", "description": "Transform shapes."},
102+
{"title": "Composites", "link": f"{g}/composite.html", "image": "../_static/images/gallery/concrete.png", "description": "."},
103103
]
104104

105105
def _add_css(app, pagename, templatename, context, doctree):

docs/examples/composite.ipynb

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,14 @@
88
"# Composite Shapes"
99
]
1010
},
11+
{
12+
"cell_type": "markdown",
13+
"id": "94dfcfb6",
14+
"metadata": {},
15+
"source": [
16+
"In this example a composite section is built by joining multiple basic shapes."
17+
]
18+
},
1119
{
1220
"cell_type": "code",
1321
"execution_count": null,
@@ -17,7 +25,6 @@
1725
"source": [
1826
"from xsection import CompositeSection\n",
1927
"from xsection.library import Circle, Equigon\n",
20-
"from xsection.analysis import SectionInteraction\n",
2128
"from xara_units.iks import inch, foot, ksi, kip \n",
2229
"import matplotlib.pyplot as plt\n",
2330
"import numpy as np"
@@ -44,7 +51,7 @@
4451
"cover = 1*inch + ds\n",
4552
"diameter = 15*inch\n",
4653
"core_radius = diameter/2 - cover - ds - d/2\n",
47-
"nr = 20 # number of longitudinal bars\n"
54+
"nr = 20 # number of longitudinal reinforcing bars\n"
4855
]
4956
},
5057
{
@@ -1295,9 +1302,17 @@
12951302
"artist"
12961303
]
12971304
},
1305+
{
1306+
"cell_type": "markdown",
1307+
"id": "ee193d8c",
1308+
"metadata": {},
1309+
"source": [
1310+
"## Moment-Curvature"
1311+
]
1312+
},
12981313
{
12991314
"cell_type": "code",
1300-
"execution_count": 26,
1315+
"execution_count": null,
13011316
"id": "6524ae34",
13021317
"metadata": {},
13031318
"outputs": [
@@ -1321,6 +1336,7 @@
13211336
}
13221337
],
13231338
"source": [
1339+
"from xsection.analysis import SectionInteraction\n",
13241340
"\n",
13251341
"# Define materials\n",
13261342
"mat = [\n",

docs/examples/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Examples
66
:maxdepth: 1
77

88
introduction
9-
library
9+
transformations
1010
composite
1111
uniaxial-capacity
1212
moment-curvature

docs/examples/introduction.ipynb

Lines changed: 1226 additions & 49 deletions
Large diffs are not rendered by default.

docs/examples/transformations.ipynb

Lines changed: 3518 additions & 0 deletions
Large diffs are not rendered by default.

pyproject.toml

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

0 commit comments

Comments
 (0)