Update CLI app docs (#48) #15
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: docs | |
| on: | |
| push: | |
| branches: ["master"] | |
| workflow_dispatch: | |
| jobs: | |
| docs: | |
| name: "docs (os: ${{ matrix.os }}, ghc: ${{ matrix.ghc }}, cabal: ${{ matrix.cabal }}, llvm: ${{ matrix.llvm }})" | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ubuntu-24.04] | |
| ghc: ["9.4.8"] | |
| cabal: ["3.8"] | |
| llvm: ["18"] | |
| steps: | |
| - name: Checkout code | |
| uses: actions/checkout@v4 | |
| - name: Set up Haskell | |
| uses: haskell-actions/setup@v2 | |
| id: setup-hs | |
| with: | |
| ghc-version: ${{ matrix.ghc }} | |
| cabal-version: ${{ matrix.cabal }} | |
| - name: Configure the build | |
| # The last step generates "dist-newstyle/cache/plan.json" for the cache key | |
| run: | | |
| cabal configure --disable-tests --disable-benchmarks --enable-documentation | |
| cabal build all --dry-run | |
| - name: Cache Cabal | |
| uses: actions/cache@v4 | |
| env: | |
| key-prefix: docs-cache-cabal-os-${{ runner.os }}-ghc-${{ steps.setup-hs.outputs.ghc-version }}-cabal-${{ steps.setup-hs.outputs.cabal-version }}-llvm-${{ matrix.llvm }} | |
| with: | |
| path: ${{ steps.setup-hs.outputs.cabal-store }} | |
| key: ${{ env.key-prefix }}-plan-${{ hashFiles('**/plan.json') }} | |
| restore-keys: ${{ env.key-prefix }}- | |
| - name: Install LLVM | |
| run: sudo apt install -y llvm-${{ matrix.llvm }} llvm-${{ matrix.llvm }}-dev | |
| - name: Build docs | |
| run: > | |
| cabal haddock | |
| --haddock-html-location='https://hackage.haskell.org/package/$pkg-$version/docs' | |
| --haddock-hyperlink-source | |
| --haddock-options=--quickjump | |
| - name: Deploy docs | |
| uses: peaceiris/actions-gh-pages@v3 | |
| with: | |
| github_token: ${{ secrets.GITHUB_TOKEN }} | |
| publish_branch: docs | |
| publish_dir: ./dist-newstyle/build/x86_64-linux/ghc-${{ matrix.ghc }}/mini-ml-0.1.0.0/doc/html/mini-ml |