Merge pull request #43 from CBIIT/feature/DATATEAM-36/update-docs

Feature/datateam 36/update docs

.github/workflows/documentation.yml

@@ -0,0 +1,35 @@
+name: documentation
+
+on: [push, pull_request, workflow_dispatch]
+
+permissions:
+  contents: write
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.8"
+      - name: Install poetry
+        uses: snok/install-poetry@v1
+      - name: Install package
+        working-directory: ./python
+        run: |
+          poetry install --all-extras
+      - name: Sphinx build
+        working-directory: ./python/docs
+        run: |
+          poetry run sphinx-build -b html . ./_build/html
+      - name: List HTML Output
+        run: ls -R ./python/docs/_build/html
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./python/docs/_build/html
+          force_orphan: true