Merge branch 'OpenSees:master' into model

.github/workflows/sphinx.yml

@@ -0,0 +1,60 @@
+name: Sphinx build
+
+on: 
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Build HTML
+      uses: ammaraskar/sphinx-action@master
+      with:
+        docs-folder: "."
+
+#   - name: Add NoJekyll
+#     run: touch build/html/.nojekyll
+
+#   - name: Upload artifacts
+#     uses: actions/upload-artifact@v4
+#     with:
+#       name: html-docs
+#       path: build/html/
+
+    - name: Upload static files as artifact
+      id: deployment
+      uses: actions/upload-pages-artifact@v3 # or specific "vX.X.X" version tag for this action
+      with:
+        path: build/html/
+
+
+#   - name: Deploy
+#     uses: peaceiris/actions-gh-pages@v3
+#     if: github.ref == 'refs/heads/main'
+#     with:
+#       github_token: ${{ secrets.GITHUB_TOKEN }}
+#       publish_dir: _build/html
+#
+  # Deployment job
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Set permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    needs: build
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      if: github.ref == 'refs/heads/master'
+      uses: actions/deploy-pages@v4
+

requirements.txt

@@ -0,0 +1,3 @@
+Sphinx>=6.0
+sphinx_rtd_theme>=3.0.0
+

source/conf.py

@@ -10,6 +10,7 @@
 #
 import os
 import sys
+import sphinx_rtd_theme
 sys.path.append(os.path.abspath('./sphinx_ext/'))
 
 
@@ -64,7 +65,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'toctree_filter'
+    'toctree_filter',
+    'sphinx_rtd_theme'
 ]
 
 # Add any paths that contain templates here, relative to this directory.

source/user/manual/analysis/integrator/GeneralizedAlpha.rst

@@ -1,24 +1,25 @@
 .. _GeneralizedAlphaMethod:
 
 Generalized Alpha Method
---------------------------------
+------------------------
+
 .. function:: integrator GeneralizedAlpha $alphaM $alphaF <$gamma $beta> 
 
-This command is used to construct a Generalized :math:`\alpha` integration object. This is an implicit method that like the HHT method allows for high frequency energy dissipation and second order accuracy, i.e. :math:`\Delta t^2`. Depending on choices of input parameters, the method can be unconditionally stable. 
+This command is used to define a Generalized :math:`\alpha` integration scheme. This is an implicit method that like the HHT method allows for high frequency energy dissipation and second order accuracy, i.e. :math:`\Delta t^2`. Depending on choices of input parameters, the method can be unconditionally stable. 
 
 .. admonition:: Example 
 
    1. **Tcl Code**
 
    .. code-block:: tcl
 
-      integrator Explicitdifference 
+      integrator GeneralizedAlpha 1.0 1.0
 
    2. **Python Code**
 
    .. code-block:: python
 
-       integrator('ExplicitDifference')
+       model.integrator('GeneralizedAlpha', 1.0, 1.0)
 
 .. note:: 
     * :math:` \alpha_F` and :math:`\alpha_M` are defined differently that in the paper, we use :math:`\alpha_F = (1-\alpha_f)` and :math:`\alpha_M=(1-\gamma_m)` where :math:`\alpha_f` and :math:`\alpha_m` are those used in the paper.
@@ -92,4 +93,5 @@ and
     R_{t+\Delta t}^i = F_{t + \Delta t}^{ext} - F(U_{t + \alpha F \Delta t}^{i-1})^{int} - C \dot U_{t+\alpha F \Delta t}^{i-1} - M \ddot U_{t+ \alpha M \Delta t}^{i-1}
 
 
-The linear equations are used to solve for :math:`U_{t+\alpha F \Delta t}, \dot U_{t + \alpha F \Delta t} \ddot U_{t+ \alpha M \Delta t}`. Once convergence has been achieved the displacements, velocities and accelerations at time :math:`t + \Delta t` can be computed. 
+The linear equations are used to solve for :math:`U_{t+\alpha F \Delta t}, \dot U_{t + \alpha F \Delta t} \ddot U_{t+ \alpha M \Delta t}`. Once convergence has been achieved the displacements, velocities and accelerations at time :math:`t + \Delta t` can be computed. 
+