Explicitly mention aws repo extra url in documentation (#277) #150
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Build documentation | |
on: | |
push: | |
branches: | |
- main | |
tags: | |
- 'v[0-9]+.[0-9]+.[0-9]+' | |
paths: | |
- 'docs/source/**' | |
- 'docs/assets/**' | |
- 'optimum/**' | |
- '.github/workflows/doc-build.yml' | |
workflow_dispatch: | |
jobs: | |
build_documentation: | |
runs-on: ubuntu-latest | |
env: | |
COMMIT_SHA: ${{ github.event.pull_request.head.sha }} | |
PR_NUMBER: ${{ github.event.number }} | |
EVENT_CONTEXT: ${{ toJSON(github.event) }} | |
PR_CLONE_URL: ${{ github.event.pull_request.head.repo.clone_url }} | |
steps: | |
- uses: actions/checkout@v3 | |
- uses: actions/setup-node@v3 | |
with: | |
node-version: '18' | |
cache-dependency-path: "kit/package-lock.json" | |
- name: Set environment variables | |
run: | | |
cd optimum | |
version=`echo "$(grep '^__version__ =' neuron/version.py | cut -d '=' -f 2- | xargs)"` | |
if [[ $version == *.dev0 ]] | |
then | |
echo "VERSION=main" >> $GITHUB_ENV | |
else | |
echo "VERSION=v$version" >> $GITHUB_ENV | |
fi | |
cd .. | |
- name: Setup environment | |
run: | | |
pip install ".[quality, diffusers]" | |
- name: Make documentation | |
shell: bash | |
run: | | |
doc-builder build optimum.neuron docs/source/ --build_dir neuron-doc-build/ --version ${{ env.VERSION }} --version_tag_suffix "" --html --clean | |
cd neuron-doc-build/ | |
mv optimum.neuron optimum-neuron | |
doc-builder push optimum-neuron --doc_build_repo_id "hf-doc-build/doc-build" --token "${{ secrets.HF_DOC_BUILD_PUSH }}" --commit_msg "Updated with commit $COMMIT_SHA See: https://github.com/huggingface/optimum-neuron/commit/$COMMIT_SHA" --n_retries 5 |