Merge pull request #10 from sandialabs/main

Pull recent main changes into develop

Author: spcarte

.github/workflows/deploy_documentation.yml

@@ -33,17 +33,20 @@ jobs:
         uses: actions/setup-python@v6
         with:
           python-version: "3.11"
-          cache: pip # Implicitly uses requirements.txt for cache key
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install -e .[dev]
-
+      
+      - name: Debug jupyter-book installation
+        run: |
+          which jupyter-book || echo "no jupyter-book script on PATH"
+          python -m pip show jupyter-book || echo "jupyter-book not installed?"
+          
       # Build the book
       - name: Build the book
-        run: |
-          jupyter-book build .
+        run: jupyter-book build docs/theory_api_documentation
 
       - name: Configure GitHub Pages
         uses: actions/configure-pages@v5
@@ -52,7 +55,7 @@ jobs:
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v4
         with:
-          path: _build/html
+          path: docs/theory_api_documentation/_build/html
 
       # Deploy the book's HTML to GitHub Pages
       - name: Deploy to GitHub Pages

README.md

@@ -16,6 +16,9 @@ The main features of ForceFinder are:
 
 The SourcePathReceiver object has also been built into a Rattlesnake control law for random vibration control, meaning that the same exact code can be used in offline predictions and online control during a multiple-input/multiple-output (MIMO) vibration test. Note that the control law is included with this package for completeness, but are not imported to the Python environment when ForceFinder is used.
 
+## Documentation 
+The [theory and API documentation](https://sandialabs.github.io/forcefinder) provides useful information for theory and programming interface that is used in ForceFinder. Examples will be added to this documentation over time. 
+
 ## Goals
 The ForceFinder project has two main goals:
 
@@ -58,3 +61,4 @@ import forcefinder as ff
 
 
 
+

setup.py

@@ -9,6 +9,7 @@
     long_description=open("README.md").read(),
     long_description_content_type="text/markdown",
     url="https://github.com/sandialabs/forcefinder",
+    project_urls={"documentation":"https://sandialabs.github.io/forcefinder"},
     packages=find_packages(where='src'),  # Tell setuptools to look in the src/ folder
     package_dir={"": "src"},  # Set the base folder for the packages to src/
     classifiers=["Programming Language :: Python :: 3.11",
@@ -33,11 +34,15 @@
             "sdynpy>=0.18.6",
             "pytest",
             "pytest-cov",
-            "jupyter-book",
+            "jupyter-book==1.0.4",
             "sphinx-autoapi"
         ]
     }
 )
 
 
 
+
+
+
+