Adding documentation for the STOMMS

.github/workflows/doxygen-sphinx-gh-pages.yml

@@ -0,0 +1,58 @@
+name: Deploy Doxygen-Sphinx-Github Pages for STOMMS documentation
+
+# For push actions in the docs branch. Once this is merged to main,
+# change the branch here.
+on:
+  push:
+    branches:
+      - documentation
+
+# Deploy github pages for the documentation
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    steps:
+      # Step 1: Check out repo
+      - name: Check out STOMMS
+        uses: actions/checkout@v4
+
+      # Step 2: Install the desired python version
+      - name: Setup Python 3.10.10
+        uses: actions/setup-python@v4
+        with: 
+          python-version: 3.10.10
+
+      # Step 3: Install the dependencies (from requirements.txt file)
+      - name: Install dependencies
+        run: | 
+             sudo apt update
+             sudo apt install gcc-10 g++-10 mpich doxygen 
+             python -m pip install --upgrade pip 
+             pip install -r docs/requirements.txt
+
+      # Step 4: Run doxygen and sphinx to finalize the document.
+      - name: Run Doxygen and Sphnix 
+        run: | 
+             mkdir build
+             cd build
+             cmake ..
+             doxygen Doxyfile
+             cd ../docs
+             sphinx-build -b html source build/html
+             cd ..
+
+      # Step 5: Upload the document
+      - name: Upload the document
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build/html
+
+      # Step 6: Deployment
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -41,3 +41,5 @@ install
 *.bp
 *.log
 
+# Documentation
+pyEnv

CMakeLists.txt

@@ -18,6 +18,9 @@ option(ENABLE_STOMMS_READER "Enable Stomms Mesh Reader" OFF)
 message (STATUS "ENABLE_STOMMS_MESHGEN:  ${ENABLE_STOMMS_MESHGEN} ")
 message (STATUS "ENABLE_STOMMS_READER:  ${ENABLE_STOMMS_READER} ")
 
+# Configure file for the documentation (Doxygen)
+configure_file( ${CMAKE_SOURCE_DIR}/docs/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY)
+
 # Build stomms_meshgen
 if (ENABLE_STOMMS_MESHGEN)
   message(STATUS "Compiling stomms_meshgen")