From 32c31ec82aebfbec6cf790b5db5597a24ba026c4 Mon Sep 17 00:00:00 2001 From: Matthew Barber Date: Wed, 20 Mar 2024 12:40:57 +0000 Subject: [PATCH] Build docs to `docs/` in GitHub pages --- .github/workflows/docs.yml | 10 +++++++++- mkdocs.yml | 1 + 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 1091824e0..359281d4e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -13,4 +13,12 @@ jobs: with: python-version: "3.10" - run: pip install mkdocs mkdocs-material - - run: mkdocs gh-deploy --force --clean --verbose + # mkdocs gh-deploy command only builds to the top-level, hence building then deploying ourselves + - run: mkdocs build + - name: Deploy docs + uses: peaceiris/actions-gh-pages@v3 + if: ${{ github.ref == 'refs/heads/develop' }} + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: ./site + destination_dir: docs/ diff --git a/mkdocs.yml b/mkdocs.yml index cd23bd892..74a18a5bb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ site_name: OpenBLAS +site_url: https://openblas.net/docs/ theme: name: material logo: logo.svg