update documentation

Author: PetrKryslUCSD

docs/Manifest.toml

@@ -3,13 +3,14 @@ using Documenter, FinEtoolsFlexStructures
 makedocs(
 	modules = [FinEtoolsFlexStructures],
 	doctest = false, clean = true,
+	warnonly = Documenter.except(:linkcheck, :footnote),
 	format = Documenter.HTML(prettyurls = false),
 	authors = "Petr Krysl",
 	sitename = "FinEtoolsFlexStructures.jl",
 	pages = Any[
 			"Home" => "index.md",
 			"How to guide" => "guide/guide.md",
-			"Reference" => "man/reference.md"	
+			"Reference" => "man/man.md"	
 		],
 	)
 

docs/make.jl

@@ -9,11 +9,13 @@ The basic functionality is provided by the [`FinEtools`]
 (https://github.com/PetrKryslUCSD/FinEtools.jl)
 package.
 
-To understand how the package works, we would suggest inspecting the examples.
+
+Tutorials  are provided in the form of Julia scripts and Markdown files in a dedicated folder: [`index of tutorials`](https://github.com/PetrKryslUCSD/FinEtoolsFlexStructures.jl/blob/main/tutorials/index.md). 
+
+
+
+To understand how the package works in depth, we would suggest inspecting the examples.
 The examples are organized by category: statics, dynamics, etc. There is
 usually an indication of what the correct answer should be
 (frequencies, deflections, buckling factors, ...). Many examples correspond to
 well-known benchmarks.
-
-
-

docs/src/guide/guide.md

@@ -1,17 +1,32 @@
 # FinEtoolsFlexStructures Documentation
 
 
-The [tutorials](https://github.com/PetrKryslUCSD/FinEtoolsFlexStructuresTutorials.jl) are provided in the form of Julia scripts and Markdown files in a separate [package](https://github.com/PetrKryslUCSD/FinEtoolsFlexStructuresTutorials.jl). 
+```@contents
+```
+
+## Conceptual guide
 
+The construction of the toolkit is described: the composition of modules, the basic data structures, the methodology of computing quantities required in the finite element methodology, and more.
+
+```@contents
+Pages = [
+    "guide/guide.md",
+]
+Depth = 1
+```
 
 ## Manual
 
 The description of the types and the functions, organized by module and/or other logical principle.
 
 ```@contents
 Pages = [
-    "man/types.md",
-    "man/functions.md",
+    "man/man.md",
 ]
 Depth = 2
 ```
+
+## Index
+
+```@index
+```

docs/src/index.md

@@ -0,0 +1,150 @@
+# Manual
+
+
+```@meta
+CurrentModule = FinEtoolsFlexStructures
+```
+
+
+## Composite Layup 
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.CompositeLayupModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Cross Section 
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.CrossSectionModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Meshing of Frame Members 
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.MeshFrameMemberModule]
+Private = true
+Order = [:function, :type]
+```
+
+## FE Set for two-node Beams
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FESetL2BeamModule]
+Private = true
+Order = [:function, :type]
+```
+
+## FE Set for Shell T3 shapes
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FESetShellT3Module]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for Corotational Beams 
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMCorotBeamModule]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for linear beams with eccentric connections
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMLinBeamModule]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for reduced-integration Timoshenko beams
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMRITBeamModule]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for Shell T3FF with homogeneous composition
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMShellT3FFModule]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for Shell T3FF with layered composition
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMShellT3FFCompModule]
+Private = true
+Order = [:function, :type, :constant]
+```
+
+## FEMM for point masses
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMPointMassModule]
+Private = true
+Order = [:function, :type]
+```
+
+## FEMM for Grounded springs
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.FEMMPointGroundedSpringModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Rotation utilities
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.RotUtilModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Transformer functions
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.TransformerModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Assembly of special matrices
+
+```@autodocs
+Modules = [FinEtoolsFlexStructures.AssemblyModule]
+Private = true
+Order = [:function, :type]
+```
+
+## Modules
+
+```@docs
+FinEtoolsFlexStructures.FinEtoolsFlexStructures
+FinEtoolsFlexStructures.CompositeLayupModule
+FinEtoolsFlexStructures.CrossSectionModule
+FinEtoolsFlexStructures.MeshFrameMemberModule
+FinEtoolsFlexStructures.FESetL2BeamModule
+FinEtoolsFlexStructures.FESetShellT3Module
+FinEtoolsFlexStructures.FESetShellQ4Module
+FinEtoolsFlexStructures.FEMMCorotBeamModule
+FinEtoolsFlexStructures.FEMMLinBeamModule
+FinEtoolsFlexStructures.FEMMRITBeamModule
+FinEtoolsFlexStructures.FEMMShellT3FFModule
+FinEtoolsFlexStructures.FEMMShellT3FFCompModule
+FinEtoolsFlexStructures.FEMMPointMassModule
+FinEtoolsFlexStructures.FEMMPointGroundedSpringModule
+FinEtoolsFlexStructures.RotUtilModule
+FinEtoolsFlexStructures.TransformerModule
+FinEtoolsFlexStructures.AssemblyModule
+```
+