simopt-admin · Grochocinski · Mar 5, 2025 · Mar 5, 2025 · Mar 5, 2025 · Mar 5, 2025
diff --git a/.github/workflows/sphinx.yml b/.github/workflows/sphinx.yml
@@ -0,0 +1,33 @@
+name: Sphinx Docs Build
+
+on:
+  push:
+    branches: [ "master", "development" ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          ref: ${{ github.ref }}
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.9'
+
+      - name: Install dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build documentation
+        run: sphinx-build -b html docs/source docs/_build/html
+
+      - name: Commit and push changes
+        run: |
+          git config --global user.name "github-actions[bot]"
+          git config --global user.email "github-actions[bot]@users.noreply.github.com"
+          git add docs/_build/html
+          git diff --quiet && echo "No changes to commit" || (git commit -m "Automated documentation update" && git push origin HEAD:${GITHUB_REF#refs/heads/})
diff --git a/docs/amusementpark.png → docs/_static/amusementpark.png b/docs/amusementpark.png → docs/_static/amusementpark.png
diff --git a/docs/contam.PNG → docs/_static/contam.PNG b/docs/contam.PNG → docs/_static/contam.PNG
diff --git a/docs/hotel.PNG → docs/_static/hotel.PNG b/docs/hotel.PNG → docs/_static/hotel.PNG
diff --git a/docs/hotel2.PNG → docs/_static/hotel2.PNG b/docs/hotel2.PNG → docs/_static/hotel2.PNG
diff --git a/docs/san.PNG → docs/_static/san.PNG b/docs/san.PNG → docs/_static/san.PNG
diff --git a/docs/sscont.png → docs/_static/sscont.png b/docs/sscont.png → docs/_static/sscont.png
diff --git a/docs/model_template.rst → docs/_templates/model_template.rst b/docs/model_template.rst → docs/_templates/model_template.rst
@@ -1,104 +1,104 @@
-Model: <model_name> (<model_abbreviation>)
-==========================================
-
-Description:
-------------
-<A paragraph describing the stochastic model. Use math if it is helpful.>
-
-Sample math... :math:`S = 1500`
-
-Sample math... 
-
-.. math::
-
-   \frac{ \sum_{t=0}^{N}f(t,k) }{N}
-
-Sources of Randomness:
-----------------------
-<The number and nature of sources of randomness.>
-
-Model Factors:
---------------
-* <factor1name>: <short description>
-
-    * Default: <default value>
-
-* <factor2name>: <short description>
-
-    * Default: <default value>
-
-* <factor3name>: <short description>
-
-    * Default: <default value>
-
-Responses:
-----------
-* <response1name>: <short description>
-
-* <response2name>: <short description>
-
-* <response3name>: <short description>
-
-
-References:
-===========
-This model is adapted from the article <article name with full citation + hyperlink to journal/arxiv page> 
-
-
-
-
-Optimization Problem: <problem_name> (<problem_abbrev>)
-========================================================
-
-Decision Variables:
--------------------
-* <dv1name that matches model factor name>
-* <dv2name that matches model factor name>
-
-Objectives:
------------
-<Description using response names. Use math if it is helpful.>
-
-Constraints:
-------------
-<Description using response names. Use math if it is helpful.>
-
-Problem Factors:
-----------------
-* <factor1name>: <short description>
-
-  * Default: <default value>
-
-* <factor2name>: <short description>
-
-  * Default: <default value>
-
-Fixed Model Factors:
---------------------
-* <factor1name>: <fixed value>
-
-* <factor2name>: <fixed value>
-
-Starting Solution: 
-------------------
-* <dv1name>: <dv1initialvalue>
-
-* <dv2name>: <dv2initialvalue>
-
-Random Solutions: 
-------------------
-<description of how to generate random solutions>
-
-Optimal Solution:
------------------
-<if known, otherwise unknown>
-
-Optimal Objective Function Value:
----------------------------------
-<if known, otherwise unknown>
-
-
-Optimization Problem: <problem_name> (<problem_abbrev>)
-========================================================
-
-...
+Model: <model_name> (<model_abbreviation>)
+==========================================
+
+Description:
+------------
+<A paragraph describing the stochastic model. Use math if it is helpful.>
+
+Sample math... :math:`S = 1500`
+
+Sample math... 
+
+.. math::
+
+   \frac{ \sum_{t=0}^{N}f(t,k) }{N}
+
+Sources of Randomness:
+----------------------
+<The number and nature of sources of randomness.>
+
+Model Factors:
+--------------
+* <factor1name>: <short description>
+
+    * Default: <default value>
+
+* <factor2name>: <short description>
+
+    * Default: <default value>
+
+* <factor3name>: <short description>
+
+    * Default: <default value>
+
+Responses:
+----------
+* <response1name>: <short description>
+
+* <response2name>: <short description>
+
+* <response3name>: <short description>
+
+
+References:
+===========
+This model is adapted from the article <article name with full citation + hyperlink to journal/arxiv page> 
+
+
+
+
+Optimization Problem: <problem_name> (<problem_abbrev>)
+========================================================
+
+Decision Variables:
+-------------------
+* <dv1name that matches model factor name>
+* <dv2name that matches model factor name>
+
+Objectives:
+-----------
+<Description using response names. Use math if it is helpful.>
+
+Constraints:
+------------
+<Description using response names. Use math if it is helpful.>
+
+Problem Factors:
+----------------
+* <factor1name>: <short description>
+
+  * Default: <default value>
+  
+* <factor2name>: <short description>
+
+  * Default: <default value>
+
+Fixed Model Factors:
+--------------------
+* <factor1name>: <fixed value>
+
+* <factor2name>: <fixed value>
+
+Starting Solution: 
+------------------
+* <dv1name>: <dv1initialvalue>
+
+* <dv2name>: <dv2initialvalue>
+
+Random Solutions: 
+------------------
+<description of how to generate random solutions>
+
+Optimal Solution:
+-----------------
+<if known, otherwise unknown>
+
+Optimal Objective Function Value:
+---------------------------------
+<if known, otherwise unknown>
+
+
+Optimization Problem: <problem_name> (<problem_abbrev>)
+========================================================
+
+...
diff --git a/docs/solver_template.rst → docs/_templates/solver_template.rst b/docs/solver_template.rst → docs/_templates/solver_template.rst
@@ -1,42 +1,42 @@
-Solver: <solver_name> (<solver_abbreviation>)
-=============================================
-
-Description:
-------------
-<A paragraph describing the solver algorithm. Use math if it is helpful.>
-
-Sample math... :math:`S = 1500`
-
-Sample math... 
-
-.. math::
-
-   \frac{ \sum_{t=0}^{N}f(t,k) }{N}
-
-
-Modifications & Implementation:
--------------------------------
-<What changed from the original algorithm? Other implementation choices like how initial points are chosen, etc.>
-
-Scope:
-------
-<The types of models that can be solved (i.e. objective_type, constraint_type, and variable_type).>
-
-Solver Factors:
----------------
-* <factor1name>: <short description>
-
-    * Default: <default value>
-
-* <factor2name>: <short description>
-
-    * Default: <default value>
-
-* <factor3name>: <short description>
-
-    * Default: <default value>
-
-
-References:
-===========
+Solver: <solver_name> (<solver_abbreviation>)
+=============================================
+
+Description:
+------------
+<A paragraph describing the solver algorithm. Use math if it is helpful.>
+
+Sample math... :math:`S = 1500`
+
+Sample math... 
+
+.. math::
+
+   \frac{ \sum_{t=0}^{N}f(t,k) }{N}
+
+
+Modifications & Implementation:
+-------------------------------
+<What changed from the original algorithm? Other implementation choices like how initial points are chosen, etc.>
+
+Scope:
+------
+<The types of models that can be solved (i.e. objective_type, constraint_type, and variable_type).>
+
+Solver Factors:
+---------------
+* <factor1name>: <short description>
+
+    * Default: <default value>
+
+* <factor2name>: <short description>
+
+    * Default: <default value>
+
+* <factor3name>: <short description>
+
+    * Default: <default value>
+
+
+References:
+===========
 This solver is adapted from the article <article name with full citation + hyperlink to journal/arxiv page>
diff --git a/docs/GUI.rst → docs/source/GUI.rst b/docs/GUI.rst → docs/source/GUI.rst
@@ -1,7 +1,7 @@
-GUI module
-==========
-
-.. automodule:: GUI
-   :members:
-   :undoc-members:
-   :show-inheritance:
+GUI module
+==========
+
+.. automodule:: GUI
+   :members:
+   :undoc-members:
+   :show-inheritance: