docs.yaml

name: Docs
on:
  push:
    branches: ["main"]
    tags: ["v*"]
  workflow_dispatch:
permissions:
    contents: write
jobs:
  docs:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      with:
        persist-credentials: false

    - name: Set up Python
      uses: actions-ext/python/setup@ec67f82b3bd863948308a41ecb9e70547cbb19c7
      with:
        version: '3.11'

    - name: Setup Node.js
      uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
      with:
        node-version: '22'

    - name: Setup Rust
      uses: actions-ext/rust/setup@0f0b7c9ab3cdb6e9a1f79e2147974d6762ddafea

    # sphinxcontrib-rust shells out to this binary. Installing the Python
    # package only builds it as a side effect, which a cached wheel skips.
    - name: Install sphinx-rustdocgen
      run: cargo install sphinx-rustdocgen --version 1.2.1

    - name: Install JSDoc/TypeDoc
      run: npm install -g jsdoc typedoc

    - name: Install doxygen
      run: sudo apt-get install -y doxygen

    # Build with the working copy (not the released yardang) so that the docs,
    # and the per-theme previews below, exercise the version in this repo.
    - name: Install self
      run: pip install -e .[develop]

    - name: Build docs
      run: yardang build

    # Render the full site once per bundled theme into docs/html/_previews/<theme>/
    # so each theme is browsable live at a suburl of the published site.
    - name: Build theme previews
      run: yardang preview

    - name: Publish to GitHub Pages
      uses: peaceiris/actions-gh-pages@84c30a85c19949d7eee79c4ff27748b70285e453 # v4.1.0
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_branch: gh-pages
        publish_dir: docs/html
        force_orphan: true

    - name: Build Wiki
      run: yardang wiki --output-dir docs/wiki

    - name: Upload Documentation to Wiki
      uses: Andrew-Chen-Wang/github-wiki-action@v5
      with:
        path: docs/wiki