.github/workflows/cargo-doc-pages.yml

name: Deploy `cargo doc` to GitHub Pages

on:
  push:
    branches:
      - main

  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  deploy-doc:
    runs-on: ubuntu-latest

    environment:
      name: github-pages
      url: ${{steps.deployment.outputs.page_url}}

    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Setup Pages
        uses: actions/configure-pages@v3

      - uses: actions/cache@v4
        with:
          path: |
            ~/.cargo/bin/
            ~/.cargo/registry/index/
            ~/.cargo/registry/cache/
            ~/.cargo/git/db/
            target/
          key: cargo-doc-${{ hashFiles('Cargo.lock') }}
          restore-keys: |
            cargo-doc-${{ hashFiles('Cargo.lock') }}
            cargo-doc-
            cargo-


      - name: Run `cargo doc`
        run: cargo doc --lib --no-deps

      - name: Patch root index.html
        run: echo '<head><meta http-equiv="refresh" content="0; url=theme_parser/index.html" /></head>' > target/doc/index.html

      - name: Upload Artifact
        uses: actions/upload-pages-artifact@v1
        with:
          path: 'target/doc'

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v2