Merge pull request #18 from olcf/11-update-docs-to-be-better-for-new-…

…container-users 11 update docs to be better for new container users
olcf · Sep 30, 2024 · e386a55 · e386a55
2 parents c4b3470 + 06a4e14
commit e386a55
Show file tree

Hide file tree

Showing 80 changed files with 672 additions and 9,059 deletions.
diff --git a/.github/workflows/static.yml → .github/workflows/documentation.yml b/.github/workflows/static.yml → .github/workflows/documentation.yml
@@ -1,12 +1,10 @@
-# Simple workflow for deploying static content to GitHub Pages
-name: Deploy static content to Pages
+# Deploy Velocity documentation
+name: Deploy documentation to Pages
 
 on:
-  # Runs on pushes targeting the default branch
+  # trigger on push to develop also allow manual runs
   push:
     branches: ["develop"]
-
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
 # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
@@ -22,7 +20,6 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
-  # Single deploy job since we're just deploying
   deploy:
     environment:
       name: github-pages
@@ -32,7 +29,7 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: "release/0.1"
+          ref: "develop"
       - name: Setup Pages
         uses: actions/configure-pages@v5
       - name: Set up Python
@@ -46,10 +43,9 @@ jobs:
       - name: Build Docs
         run: |
           cd docs && make html
-      - name: Upload artifact
+      - name: Upload documentation HTML files
         uses: actions/upload-pages-artifact@v3
         with:
-          # Upload entire repository
           path: './docs/build/html'
       - name: Deploy to GitHub Pages
         id: deployment

diff --git a/.gitignore b/.gitignore
@@ -11,3 +11,4 @@ tmp
 *__pycache__
 dist
 *\.egg-info
+docs/build
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/reference/build.doctree b/docs/build/doctrees/reference/build.doctree
diff --git a/docs/build/doctrees/reference/config.doctree b/docs/build/doctrees/reference/config.doctree
diff --git a/docs/build/doctrees/reference/index.doctree b/docs/build/doctrees/reference/index.doctree
diff --git a/docs/build/doctrees/reference/specs.doctree b/docs/build/doctrees/reference/specs.doctree
diff --git a/docs/build/doctrees/reference/vtmp.doctree b/docs/build/doctrees/reference/vtmp.doctree
diff --git a/docs/build/doctrees/starting/basic.doctree b/docs/build/doctrees/starting/basic.doctree
diff --git a/docs/build/doctrees/starting/index.doctree b/docs/build/doctrees/starting/index.doctree
diff --git a/docs/build/doctrees/starting/tutorial.doctree b/docs/build/doctrees/starting/tutorial.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
diff --git a/docs/build/html/_sources/reference/build.rst.txt b/docs/build/html/_sources/reference/build.rst.txt
diff --git a/docs/build/html/_sources/reference/config.rst.txt b/docs/build/html/_sources/reference/config.rst.txt
diff --git a/docs/build/html/_sources/reference/index.rst.txt b/docs/build/html/_sources/reference/index.rst.txt
diff --git a/docs/build/html/_sources/reference/specs.rst.txt b/docs/build/html/_sources/reference/specs.rst.txt