Merge pull request #40 from UBC-MDS/ali-docs

fixing docs

Author: JeffHDing

.github/workflows/quarto-publish.yml

@@ -0,0 +1,43 @@
+name: Publish Quarto Docs
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: write
+
+jobs:
+  publish-docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up conda environment
+        uses: conda-incubator/setup-miniconda@v3
+        with:
+          environment-file: environment.yml
+          activate-environment: tame_your_files_env
+          auto-activate-base: false
+
+      - name: Set up Quarto
+        uses: quarto-dev/quarto-actions/setup@v2
+
+      - name: Install package
+        shell: bash -l {0}
+        run: python -m pip install -e .
+
+      - name: Render Quarto site
+        shell: bash -l {0}
+        run: quarto render docs
+
+      - name: Publish to gh-pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_site
+

.gitignore

@@ -155,6 +155,7 @@ instance/
 # Sphinx documentation
 docs/_build/
 docs/api
+docs/_site/
 
 # PyBuilder
 .pybuilder/

README.md

@@ -44,6 +44,13 @@ quarto render docs
 
 ## Deploying documentation (automated)
 
-![Build Status](https://github.com/UBC-MDS/group_16_tame_your_files.git/actions/workflows/publish-test-pypi.yml/badge.svg)
-Documentation is built and deployed automatically to GitHub Pages via GitHub Actions.
-Live site: https://github.com/UBC-MDS/group_16_tame_your_files
+Documentation is built by GitHub Actions and published to the `gh-pages` branch.
+To enable GitHub Pages:
+
+1. Go to `Settings` → `Pages`.
+2. Set **Source** to **Deploy from a branch**.
+3. Select branch `gh-pages` and folder `/(root)`, then save.
+4. After the first workflow run, the Pages URL will appear on the same screen.
+
+To force a rebuild, run the `quarto-publish` workflow from the **Actions** tab
+using **Run workflow**.