deploy docs on github.io

Author: Gauthameshwar

.github/workflows/CI.yml

@@ -13,7 +13,7 @@ concurrency:
   cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
 jobs:
   test:
-    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }}
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     timeout-minutes: 60
     permissions: # needed to allow julia-actions/cache to proactively delete old caches that it has created
@@ -29,14 +29,11 @@ jobs:
           - ubuntu-latest
           - macOS-latest
           - windows-latest
-        arch:
-          - x64
     steps:
       - uses: actions/checkout@v6
       - uses: julia-actions/setup-julia@v2
         with:
           version: ${{ matrix.version }}
-          arch: ${{ matrix.arch }}
       - uses: julia-actions/cache@v3
       - uses: julia-actions/julia-buildpkg@v1
       - uses: julia-actions/julia-runtest@v1
@@ -46,28 +43,36 @@ jobs:
           files: lcov.info
           token: ${{ secrets.CODECOV_TOKEN }}
           fail_ci_if_error: false
-  # docs:
-  #   name: Documentation
-  #   runs-on: ubuntu-latest
-  #   permissions:
-  #     actions: write # needed to allow julia-actions/cache to delete old caches
-  #     contents: write
-  #     statuses: write
-  #   steps:
-  #     - uses: actions/checkout@v6
-  #     - uses: julia-actions/setup-julia@v2
-  #       with:
-  #         version: '1'
-  #     - uses: julia-actions/cache@v3
-  #     - uses: julia-actions/julia-buildpkg@v1
-  #     - uses: julia-actions/julia-docdeploy@v1
-  #       env:
-  #         GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-  #         DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
-  #     - name: Run doctests
-  #       shell: julia --project=docs --color=yes {0}
-  #       run: |
-  #         using Documenter: DocMeta, doctest
-  #         using QILaplace
-  #         DocMeta.setdocmeta!(QILaplace, :DocTestSetup, :(using QILaplace); recursive=true)
-  #         doctest(QILaplace)
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    permissions:
+      actions: write # needed to allow julia-actions/cache to delete old caches
+      contents: write
+      statuses: write
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v2
+        with:
+          version: '1'
+      - uses: julia-actions/cache@v3
+      - name: Install docs dependencies
+        shell: julia --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.activate("docs")
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()
+      - name: Run doctests
+        shell: julia --color=yes {0}
+        run: |
+          using Pkg
+          Pkg.activate("docs")
+          using Documenter: DocMeta, doctest
+          using QILaplace
+          DocMeta.setdocmeta!(QILaplace, :DocTestSetup, :(using QILaplace); recursive=true)
+          doctest(QILaplace)
+      - uses: julia-actions/julia-docdeploy@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

README.md

@@ -26,11 +26,7 @@
   </a>
 </p>
 
-<p align="center">
-  <a href="https://SUTD-MDQS.github.io/QILaplace.jl">
-    <img src="https://img.shields.io/badge/Read%20the%20Documentation-QILaplace%20Docs-9558B2?style=for-the-badge&logo=julia&logoColor=white" alt="Read the Documentation">
-  </a>
-</p>
+[![Read the Documentation](https://img.shields.io/badge/Read%20the%20Documentation-QILaplace%20Docs-9558B2?style=for-the-badge&logo=julia&logoColor=white)](https://SUTD-MDQS.github.io/QILaplace.jl)
 
 <p align="center">
   <a href="#what-this-package-provides">What this package provides</a> •
@@ -40,7 +36,7 @@
   <a href="#authorship-and-maintenance">Authorship</a>
 </p>
 
-QILaplace.jl is a Julia package for running Fourier- and Laplace-family transforms with tensor networks on classical hardware. It is designed for large, structured signals where compressed MPS/MPO representations make dense workflows impractical.
+QILaplace.jl is a Julia package for Fourier- and Laplace-style transforms using tensor networks on classical hardware. It is built for large, structured signals, where compressed MPS/MPO representations keep these transforms practical when dense workflows become too expensive.
 
 The package includes QFT, damping-transform (DT), and full z-transform (zT) pipelines, together with MPS compression, MPO construction, and direct coefficient extraction tools.
 
@@ -70,16 +66,17 @@ DT and zT use the same high-level API style as QFT, so moving between Fourier an
 - Build compressed transform operators with `build_qft_mpo`, `build_dt_mpo`, and `build_zt_mpo`
 - Apply through the same contraction interface (`W * ψ`)
 - Keep transform accuracy under explicit truncation control
+- The circuit-compression construction is strictly optimal for these transform circuits.
 
 <p align="center">
   <img src="docs/src/animations/assets/CircuitCompression.gif" alt="QFT circuit compression animation" width="390">
   <img src="docs/src/animations/assets/DTCircuitCompression.gif" alt="DT circuit compression animation" width="390">
 </p>
 
 For full circuit diagrams and examples, see:
-- https://SUTD-MDQS.github.io/QILaplace.jl/tutorials/dft/
-- https://SUTD-MDQS.github.io/QILaplace.jl/tutorials/dt/
-- https://SUTD-MDQS.github.io/QILaplace.jl/tutorials/zt/
+- [Discrete Fourier Transform](https://SUTD-MDQS.github.io/QILaplace.jl/dev/tutorials/dft/)
+- [Damping Transform](https://SUTD-MDQS.github.io/QILaplace.jl/dev/tutorials/dt/)
+- [Complex Laplace Transform](https://SUTD-MDQS.github.io/QILaplace.jl/dev/tutorials/zt/)
 
 ### 3) z-domain analysis and pole scanning
 
@@ -148,7 +145,7 @@ T_{\mathrm{apply}} \sim O\left( \chi_s^2 \log N \right).
 $$
 
 For full benchmarks and runtime plots, see:
-**https://SUTD-MDQS.github.io/QILaplace.jl/benchmarking/**
+**https://SUTD-MDQS.github.io/QILaplace.jl/dev/benchmarking/**
 
 ## Authorship and maintenance