CI: Build docs on PR if src/ or docs/ change + index.md typo fix (#8)

* Update plotting documentation and function comments

- Enhanced documentation for plot_param_line and calculate_param_line functions
- Updated module documentation in Linear_Algebra.jl
- Improved function docstrings for clarity and consistency
- Updated docs/src/index.md with plotting-related documentation

* fix: correct @autodocs Pages syntax error in documentation

- Fixed malformed quotes in @autodocs Pages parameter
- Changed Pages = [""linear_algebra_transform.jl"] to Pages = ["linear_algebra_transform.jl"]
- Documentation now builds successfully without parse errors

* ci: build docs on PR only if src/ or docs/ change

- Adds docs-build job for PRs
- Uses shell check to detect changes in src/ or docs/ and skips build otherwise
- Prevents docs build for unrelated file changes (e.g., copilot-instructions.md)

Author: AronT-TLV

.github/workflows/CI.yml

@@ -40,6 +40,41 @@ jobs:
         run: >
           julia --project=. --color=yes test/runtests.jl
 
+  docs-build:
+    name: Build Documentation
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Check for docs/src changes
+        id: docs-changes
+        run: |
+          git fetch origin ${{ github.base_ref }}
+          CHANGED_FILES=$(git diff --name-only origin/${{ github.base_ref }}...HEAD)
+          echo "Changed files: $CHANGED_FILES"
+          if echo "$CHANGED_FILES" | grep -qE '^(src/|docs/)'; then
+            echo "docs_changed=true" >> $GITHUB_OUTPUT
+          else
+            echo "docs_changed=false" >> $GITHUB_OUTPUT
+          fi
+      - uses: julia-actions/setup-julia@v1
+        if: steps.docs-changes.outputs.docs_changed == 'true'
+        with:
+          version: '1'
+          arch: x64
+      - uses: julia-actions/cache@v1
+        if: steps.docs-changes.outputs.docs_changed == 'true'
+      - uses: julia-actions/julia-buildpkg@v1
+        if: steps.docs-changes.outputs.docs_changed == 'true'
+      - name: Build documentation
+        if: steps.docs-changes.outputs.docs_changed == 'true'
+        run: julia --project=. --color=yes docs/make.jl
+      - name: Skip docs build (no relevant changes)
+        if: steps.docs-changes.outputs.docs_changed == 'false'
+        run: echo "No docs or src changes detected, skipping docs build."
+
   deploy-docs:
     name: Deploy Documentation
     # Only run deployment on pushes to main (after merge) or manual trigger

docs/src/index.md

@@ -19,5 +19,5 @@ This section provides the documentation for linear transformations and related o
 ```@autodocs
 Modules = [Linear_Algebra]
 Order   = [:function, :type]
-Pages   = [""linear_algebra_transform.jl"]
+Pages   = ["linear_algebra_transform.jl"]
 ```