add docs

co1emi11er2 · Dec 10, 2024 · 080522b · 080522b
1 parent b967373
commit 080522b
Show file tree

Hide file tree

Showing 10 changed files with 243 additions and 7,000 deletions.
diff --git a/data/scripts/parsing_aisc_excel_database.ipynb b/data/scripts/parsing_aisc_excel_database.ipynb
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,3 +1,4 @@
 [deps]
 AISCSteel = "599de4a1-440e-403d-8b33-ce14758023a2"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+LiveServer = "16fef848-5104-11e9-1b77-fb7a48bbb589"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,7 +1,7 @@
 using AISCSteel
 using Documenter
 
-DocMeta.setdocmeta!(AISCSteel, :DocTestSetup, :(using AISCSteel); recursive=true)
+DocMeta.setdocmeta!(AISCSteel, :DocTestSetup, :(using AISCSteel); recursive=false)
 
 makedocs(;
     modules=[AISCSteel],
@@ -14,6 +14,12 @@ makedocs(;
     ),
     pages=[
         "Home" => "index.md",
+        "Chapter D - Tension" => "ChapterDTension.md",
+        "Chapter E - Compression" => "ChapterECompression.md",
+        "Chapter F - Flexure" => "ChapterFFlexure.md",
+        "Chapter G - Shear" => "ChapterGShear.md",
+        "Classifications" => "Classifications.md",
+        "Utils" => "Utils.md",
     ],
 )
 

diff --git a/docs/src/ChapterDTension.md b/docs/src/ChapterDTension.md
@@ -0,0 +1,5 @@
+# Chapter D - Design of Members for Tension
+
+This chapter applies to members subject to axial tension.
+
+*not implemented*
diff --git a/docs/src/ChapterECompression.md b/docs/src/ChapterECompression.md
@@ -0,0 +1,5 @@
+# Chapter E - Design of Members for Compression
+
+This chapter applies to members subject to axial compression.
+
+This section is *not implemented*.
diff --git a/docs/src/ChapterFFlexure.md b/docs/src/ChapterFFlexure.md
@@ -0,0 +1,94 @@
+# Chapter F - Design of Members for Flexure
+
+This chapter applies to members subject to simple bending about one principal axis. For
+simple bending, the member is loaded in a plane parallel to a principal axis that passes
+through the shear center or is restrained against twisting at load points and supports.
+
+- [F1. General Provisions](@ref)
+- [F2. Doubly Symmetric Compact I-Shaped Members and Channels Bent about Their Major Axis](@ref)
+- [F3. Doubly Symmetric I-Shaped Members with Compact Webs and Noncompact or Slender Flanges Bent about Their Major Axis](@ref)
+- [F4. Other I-Shaped Members with Compact or Noncompact Webs Bent about Their Major Axis](@ref)
+- [F5. Doubly Symmetric and Singly Symmetric I-Shaped Members with Slender Webs Bent about Their Major Axis](@ref)
+- [F6. I-Shaped Members and Channels Bent about Their Minor Axis](@ref)
+- [F7. Square and Rectangular HSS and Box Sections](@ref)
+- [F8. Round HSS](@ref)
+- [F9. Tees and Double Angles Loaded in the Plane of Symmetry](@ref)
+- [F10. Single Angles](@ref)
+- [F11. Rectangular Bars and Rounds](@ref)
+- [F12. Unsymmetrical Shapes](@ref)
+- [F13. Proportions of Beams and Girders](@ref)
+
+## F1. General Provisions
+
+## F2. Doubly Symmetric Compact I-Shaped Members and Channels Bent about Their Major Axis
+
+This section applies to doubly symmetric I-shaped members and channels bent about
+their major axis, having compact webs and compact flanges as defined in Section
+B4.1 for flexure.
+
+```@autodocs
+Modules = [AISCSteel.ChapterFFlexure.F2]
+```
+
+## F3. Doubly Symmetric I-Shaped Members with Compact Webs and Noncompact or Slender Flanges Bent about Their Major Axis
+
+This section applies to doubly symmetric I-shaped members bent about their major
+axis having compact webs and noncompact or slender flanges as defined in Section
+B4.1 for flexure.
+
+```@autodocs
+Modules = [AISCSteel.ChapterFFlexure.F3]
+```
+
+## F4. Other I-Shaped Members with Compact or Noncompact Webs Bent about Their Major Axis
+
+This section applies to doubly symmetric I-shaped members bent about their major
+axis with noncompact webs and singly symmetric I-shaped members with webs
+attached to the mid-width of the flanges, bent about their major axis, with compact
+or noncompact webs, as defined in Section B4.1 for flexure.
+
+```@autodocs
+Modules = [AISCSteel.ChapterFFlexure.F4]
+```
+
+## F5. Doubly Symmetric and Singly Symmetric I-Shaped Members with Slender Webs Bent about Their Major Axis
+
+This section applies to doubly symmetric and singly symmetric I-shaped members
+with slender webs attached to the mid-width of the flanges and bent about their major
+axis as defined in Section B4.1 for flexure.
+
+```@autodocs
+Modules = [AISCSteel.ChapterFFlexure.F5]
+```
+
+## F6. I-Shaped Members and Channels Bent about Their Minor Axis
+
+This section is *not implemented*.
+
+## F7. Square and Rectangular HSS and Box Sections
+
+This section is *not implemented*.
+
+## F8. Round HSS
+
+This section is *not implemented*.
+
+## F9. Tees and Double Angles Loaded in the Plane of Symmetry
+
+This section is *not implemented*.
+
+## F10. Single Angles
+
+This section is *not implemented*.
+
+## F11. Rectangular Bars and Rounds
+
+This section is *not implemented*.
+
+## F12. Unsymmetrical Shapes
+
+This section is *not implemented*.
+
+## F13. Proportions of Beams and Girders
+
+This section is *not implemented*.
diff --git a/docs/src/ChapterGShear.md b/docs/src/ChapterGShear.md
@@ -0,0 +1,7 @@
+# Chapter G - Design of Members for Compression
+
+This chapter addresses webs of singly or doubly symmetric members subject to shear in the
+plane of the web, single angles and HSS subject to shear, and shear in the weak direction of
+singly or doubly symmetric shapes.
+
+This section is *not implemented*.
diff --git a/docs/src/Classifications.md b/docs/src/Classifications.md
@@ -0,0 +1,7 @@
+# Classifications
+
+These will be moved to Chapter B soon.
+
+```@autodocs
+Modules = [AISCSteel.Classifications]
+```
diff --git a/docs/src/Utils.md b/docs/src/Utils.md
@@ -0,0 +1,7 @@
+# Utils
+
+These functions are more internal for now.
+
+```@autodocs
+Modules = [AISCSteel.Utils]
+```
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -4,11 +4,89 @@ CurrentModule = AISCSteel
 
 # AISCSteel
 
-Documentation for [AISCSteel](https://github.com/co1emi11er2/AISCSteel.jl).
+[![Build Status](https://github.com/co1emi11er2/AISCSteel.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/co1emi11er2/AISCSteel.jl/actions/workflows/CI.yml?query=branch%3Amain)
+[![Build Status](https://ci.appveyor.com/api/projects/status/github/co1emi11er2/AISCSteel.jl?svg=true)](https://ci.appveyor.com/project/co1emi11er2/AISCSteel-jl)
+[![Coverage](https://codecov.io/gh/co1emi11er2/AISCSteel.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/co1emi11er2/AISCSteel.jl)
+[![Coverage](https://coveralls.io/repos/github/co1emi11er2/AISCSteel.jl/badge.svg?branch=main)](https://coveralls.io/github/co1emi11er2/AISCSteel.jl?branch=main)
 
-```@index
+# AISCSteel.jl
+
+AISCSteel is a Julia package that follows the American Institute of Steel Construction Manual (Sixteenth Edition). You can use this package to help design steel members. This is currently in active development.
+
+# Contents
+
+```@contents
+Pages = [
+    "ChapterDTension.md",
+    "ChapterECompression.md",
+    "ChapterFFlexure.md",
+    "ChapterGShear.md",
+    "Classifications.md",
+    "Utils.md",
+]
+Depth = 1
 ```
 
 ```@autodocs
 Modules = [AISCSteel]
 ```
+
+# Roadmap
+
+- **Steel Shapes Database**
+  - [x] W Shapes
+  - [x] M Shapes
+  - [x] S Shapes
+  - [x] HP Shapes
+  - [x] C Shapes
+  - [x] MC Shapes
+  - [x] L Shapes
+  - [x] WT Shapes
+  - [x] MT Shapes
+  - [x] ST Shapes
+  - [x] HSS Shapes
+  - [x] HSS_R Shapes
+  - [x] PIPE Shapes
+  - [x] 2L Shapes
+- **Structs**
+  - [x] WShape
+  - [ ] BuiltUpIShape
+  - [x] M Shape
+  - [x] S Shape
+  - [x] HP Shape
+  - [x] C Shape
+  - [x] MC Shape
+  - [ ] L Shape
+  - [ ] WT Shape
+  - [ ] MT Shape
+  - [ ] ST Shape
+  - [ ] HSS Shape
+  - [ ] HSS_R Shape
+  - [ ] PIPE Shape
+  - [ ] 2L Shape
+- **Compression Design** (Chapter E)
+  - [ ] Calculate based on E2
+  - [ ] Calculate based on E3
+  - [ ] Calculate based on E4
+  - [ ] Calculate based on E5
+  - [ ] Calculate based on E6
+  - [ ] Calculate based on E7
+- **Flexure Design** (Chapter F)
+  - [x] Calculate based on F2
+  - [x] Calculate based on F3
+  - [x] Calculate based on F4
+  - [x] Calculate based on F5
+  - [ ] Calculate based on F6
+  - [ ] Calculate based on F7
+  - [ ] Calculate based on F8
+  - [ ] Calculate based on F9
+  - [ ] Calculate based on F10
+  - [ ] Calculate based on F11
+  - [ ] Calculate based on F12
+- **Shear Design** (Chapter G)
+  - [ ] Calculate based on G2
+  - [ ] Calculate based on G3
+  - [ ] Calculate based on G4
+  - [ ] Calculate based on G5
+  - [ ] Calculate based on G6
+  - [ ] Calculate based on G7