Skip to content

#4003: Setting __all__ = [] to block whild card imports #1634

#4003: Setting __all__ = [] to block whild card imports

#4003: Setting __all__ = [] to block whild card imports #1634

name: Deploy latest docs 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:
build-deploy-docs:
strategy:
# Do not fail-fast because we need to ensure all tests go to completion
# so we try not to get hanging machines
fail-fast: false
matrix:
arch: [grayskull]
env:
TT_METAL_ENV: ${{ vars.TT_METAL_ENV }}
DOCS_VERSION: latest
ARCH_NAME: ${{ matrix.arch }}
environment: dev
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
with:
submodules: recursive
token: ${{ secrets.CHECKOUT_TOKEN }}
lfs: true
- uses: ./.github/actions/install-metal-deps
with:
os: ubuntu-20.04
- uses: ./.github/actions/install-metal-dev-deps
with:
os: ubuntu-20.04
- name: Build tt-metal
run: |
export TT_METAL_HOME=$(pwd)
make build
- name: Activate and build docs
run: |
export PYTHONPATH=$(pwd)
source build/python_env/bin/activate
cd docs/
make html
- name: Prepare artifact - move output
run: |
mkdir gh_pages
mv docs/build/html gh_pages/$DOCS_VERSION
- name: Prepare artifact - create .nojekyll
run: |
touch gh_pages/.nojekyll
- name: Prepare artifact - create root index
run: |
touch gh_pages/index.html
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: "gh_pages"
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2