Update documentation

wenbinyugroup · Apr 21, 2024 · bbe05fe · bbe05fe
1 parent 8cdf5fb
commit bbe05fe
Show file tree

Hide file tree

Showing 136 changed files with 10,019 additions and 3,000 deletions.
diff --git a/_sources/examples/tutorial/index.rst.txt b/_sources/examples/tutorial/index.rst.txt
@@ -11,14 +11,14 @@ Tutorials
 ..    prepare_cs_template
 
 
-..  grid:: 1 2 3 4
+.. ..  grid:: 1 2 3 4
 
-    ..  grid-item-card::
-        :margin: 2 2 0 0
-        :link: tutorial-opt_cs_airfoil_box_spar_geo
-        :link-type: ref
-        :img-bottom: opt_cs_airfoil_box_spar_geo/figures/cs_param_geo.png
+..     ..  grid-item-card::
+..         :margin: 2 2 0 0
+..         :link: tutorial-opt_cs_airfoil_box_spar_geo
+..         :link-type: ref
+..         :img-bottom: opt_cs_airfoil_box_spar_geo/figures/cs_param_geo.png
 
-        :ref:`tutorial-opt_cs_airfoil_box_spar_geo`
+..         :ref:`tutorial-opt_cs_airfoil_box_spar_geo`
 
 
diff --git a/_sources/guide/input/index.rst.txt b/_sources/guide/input/index.rst.txt
@@ -9,19 +9,31 @@ The main input file uses the format `YAML <https://yaml.org/>`_.
 
 Overall layout of the main input file:
 
-..  code-block:: yaml
-
-    version: "0.9"
-    structure:
-        # Global structure definition block
-    sg:
-        # SG block
-    function:
-        # Function block
-    analysis:
-        # Analysis steps block
-    study:
-        # Design study block
+..  only:: ivabs
+
+    ..  code-block:: yaml
+
+        version: "a.b.c"
+
+        # Global structure specification
+        structure:
+            ...
+
+        # Cross-sections design specification
+        cs:
+            ...
+
+        # Functions specification
+        function:
+            ...
+
+        # Analysis steps specification
+        analysis:
+            ...
+
+        # Design study specification
+        study:
+            ...
 
 
 

diff --git a/_sources/guide/input/sg.rst.txt b/_sources/guide/input/sg.rst.txt
@@ -2,7 +2,7 @@
 
 .. _section-input_guide_sg:
 
-Structure Gene
+|Structure gene|
 =============================
 
 This block stores |structure gene| definitions.

diff --git a/_sources/index.rst.txt b/_sources/index.rst.txt
@@ -0,0 +1,24 @@
+
+..  only:: msg
+
+    ..  include:: main_msg.rst
+
+
+..  only:: ivabs
+
+    ..  include:: main_ivabs.rst
+
+
+..  only:: dev
+
+    ..  include:: main_dev.rst
+
+
+.. Indices and tables
+.. ==================
+
+.. * :ref:`genindex`
+.. * :ref:`modindex`
+.. * :ref:`search`
+
+
diff --git a/_sources/main_ivabs.rst.txt b/_sources/main_ivabs.rst.txt
@@ -44,11 +44,11 @@ This code can be replaced with more sophicated codes such as `MBDyn <https://pub
 SGIO is a collection of python scripts for integrating the codes needed in iVABS and the scripts can be modified to integrate other codes.
 To make use of SGIO, `Python3 <https://www.python.org/>`_ along with necessary packages (particularly ``numpy``, ``scipy``, and ``pyyaml``) should be installed and working on your computer.
 
-..  figure:: /figures/ivabs_components.png
-    :width: 6in
-    :align: center
+.. ..  figure:: /figures/ivabs_components.png
+..     :width: 6in
+..     :align: center
 
-    The iVABS integration.
+..     The iVABS integration.
 
 
 

diff --git a/_sources/ref/keyword/builder.rst.txt b/_sources/ref/keyword/builder.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-builder:
+
 builder
 =========
 

diff --git a/_sources/ref/keyword/data.rst.txt b/_sources/ref/keyword/data.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-data:
+
 data
 ======
 

diff --git a/_sources/ref/keyword/data_form.rst.txt b/_sources/ref/keyword/data_form.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-data_form:
+
 data_form
 =============
 
diff --git a/_sources/ref/keyword/distribution.rst.txt b/_sources/ref/keyword/distribution.rst.txt
@@ -9,6 +9,7 @@ Specification
 -------------
 
 **Arguments**: List of distribution specifications
+
 **Default**: None
 
 

diff --git a/_sources/ref/keyword/index.rst.txt b/_sources/ref/keyword/index.rst.txt
@@ -6,7 +6,6 @@ Main Input Keywords
 ..  only:: ivabs
 
     ..  code-block:: yaml
-        :linenos:
 
         version:
             ...

diff --git a/_sources/ref/keyword/kind.rst.txt b/_sources/ref/keyword/kind.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-kind:
+
 kind
 ======
 
diff --git a/_sources/ref/keyword/location.rst.txt b/_sources/ref/keyword/location.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-location:
+
 location
 =========
 
diff --git a/_sources/ref/keyword/main_file.rst.txt b/_sources/ref/keyword/main_file.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-main_file:
+
 main_file
 ===========
 

diff --git a/_sources/ref/keyword/step.rst.txt b/_sources/ref/keyword/step.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-step:
+
 step
 =======
 

diff --git a/_sources/ref/keyword/steps.rst.txt b/_sources/ref/keyword/steps.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-steps:
+
 steps
 ======
 

diff --git a/_sources/ref/keyword/tool.rst.txt b/_sources/ref/keyword/tool.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-tool:
+
 tool
 ======
 
diff --git a/_sources/ref/keyword/type.rst.txt b/_sources/ref/keyword/type.rst.txt
@@ -1,3 +1,5 @@
+.. _kw-type:
+
 type
 ======
 

diff --git a/examples/anl_box_beam_eigen/anl_box_beam_eigen.html b/examples/anl_box_beam_eigen/anl_box_beam_eigen.html
@@ -98,6 +98,12 @@
   <span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
 </form></div>
   </div>
+
+
+  <div class="bd-header-announcement container-fluid bd-header-announcement">
+    <div class="bd-header-announcement__content">Documentation is under construction. Please use examples as the main reference.</div>
+  </div>
+
 
     <header class="bd-header navbar navbar-expand-lg bd-navbar">
 <div class="bd-header__inner bd-page-width">
@@ -112,7 +118,7 @@
 
 
 
-<a class="navbar-brand logo" href="../../main_ivabs.html">
+<a class="navbar-brand logo" href="../../index.html">
 
 
 
@@ -141,6 +147,20 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../ref/keyword/index.html">
+                        Main Input Keywords
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../ref/beam_properties.html">
+                        Beam Properties
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../start/index.html">
                         Getting Started
@@ -161,26 +181,26 @@
                       </a>
                     </li>
 
-
+            <li class="nav-item dropdown">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
+                    More
+                </button>
+                <ul id="pst-nav-more-links" class="dropdown-menu">
+
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../index.html">
                         Examples
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../ref/index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/index.html">
                         Reference
                       </a>
                     </li>
 
-            <li class="nav-item dropdown">
-                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links">
-                    More
-                </button>
-                <ul id="pst-nav-more-links" class="dropdown-menu">
-
+
                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../benchmark/index.html">
                         Benchmark
@@ -194,6 +214,20 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/vabs/index.html">
+                        VABS Manual
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/swiftcomp/index.html">
+                        SwiftComp Manual
+                      </a>
+                    </li>
+
                 </ul>
             </li>
 
@@ -281,6 +315,20 @@
 <nav class="navbar-nav">
   <ul class="bd-navbar-elements navbar-nav">
 
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../ref/keyword/index.html">
+                        Main Input Keywords
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link nav-internal" href="../../ref/beam_properties.html">
+                        Beam Properties
+                      </a>
+                    </li>
+
+
                     <li class="nav-item">
                       <a class="nav-link nav-internal" href="../../start/index.html">
                         Getting Started
@@ -301,26 +349,26 @@
                       </a>
                     </li>
 
-
+            <li class="nav-item dropdown">
+                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2">
+                    More
+                </button>
+                <ul id="pst-nav-more-links-2" class="dropdown-menu">
+
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../index.html">
                         Examples
                       </a>
                     </li>
 
 
                     <li class="nav-item">
-                      <a class="nav-link nav-internal" href="../../ref/index.html">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/index.html">
                         Reference
                       </a>
                     </li>
 
-            <li class="nav-item dropdown">
-                <button class="btn dropdown-toggle nav-item" type="button" data-bs-toggle="dropdown" aria-expanded="false" aria-controls="pst-nav-more-links-2">
-                    More
-                </button>
-                <ul id="pst-nav-more-links-2" class="dropdown-menu">
-
+
                     <li class="nav-item">
                       <a class="nav-link dropdown-item nav-internal" href="../benchmark/index.html">
                         Benchmark
@@ -334,6 +382,20 @@
                       </a>
                     </li>
 
+
+                    <li class="nav-item">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/vabs/index.html">
+                        VABS Manual
+                      </a>
+                    </li>
+
+
+                    <li class="nav-item">
+                      <a class="nav-link dropdown-item nav-internal" href="../../ref/swiftcomp/index.html">
+                        SwiftComp Manual
+                      </a>
+                    </li>
+
                 </ul>
             </li>
 
@@ -390,7 +452,7 @@
   <ul class="bd-breadcrumbs">
 
     <li class="breadcrumb-item breadcrumb-home">
-      <a href="../../main_ivabs.html" class="nav-link" aria-label="Home">
+      <a href="../../index.html" class="nav-link" aria-label="Home">
         <i class="fa-solid fa-home"></i>
       </a>
     </li>
@@ -411,9 +473,7 @@
 <div id="searchbox"></div>
                 <article class="bd-article">
 
-  <blockquote>
-<div></div></blockquote>
-<section id="eigenvalue-analysis-of-a-box-beam">
+  <section id="eigenvalue-analysis-of-a-box-beam">
 <span id="example-anl-box-beam-eigen"></span><h1>Eigenvalue analysis of a box beam<a class="headerlink" href="#eigenvalue-analysis-of-a-box-beam" title="Link to this heading">#</a></h1>
 <p>Caluclate the first ten eigenvalues of a box beam.</p>
 <section id="results">