Browse Source

Build docs to `docs/` in GitHub pages

tags/v0.3.28^2
Matthew Barber 1 year ago
parent
commit
32c31ec82a
2 changed files with 10 additions and 1 deletions
  1. +9
    -1
      .github/workflows/docs.yml
  2. +1
    -0
      mkdocs.yml

+ 9
- 1
.github/workflows/docs.yml View File

@@ -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/

+ 1
- 0
mkdocs.yml View File

@@ -1,4 +1,5 @@
site_name: OpenBLAS
site_url: https://openblas.net/docs/
theme:
name: material
logo: logo.svg


Loading…
Cancel
Save