Skip to content
Docs Build

Add missing workspace docs #3161

Sign in to view logs

Add missing workspace docs

Add missing workspace docs #3161

Workflow file for this run

.github/workflows/doc-build.yaml at 4b0c7f2
name: Docs Build
on:
push:
branches:
- main
pull_request:
permissions:
contents: write
jobs:
docbuild:
runs-on: linux.20_04.4x
steps:
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: 3.8
architecture: x64
- name: Checkout TorchX
uses: actions/checkout@v2
- name: Install Dependencies
run: |
set -eux
sudo apt-get update
sudo apt-get install -y pandoc
pip install -e .[dev]
pip install -r docs/requirements.txt
- name: Install TorchX
run: |
python setup.py develop
- name: Start Airflow
run: |
# start airflow in background
airflow standalone &
# wait 5 seconds for airflow to start
sleep 5
- name: Doc Test
run: |
cd docs
make doctest
- name: Linkcheck
run: |
cd docs
make linkcheck
- name: Doc Build
run: |
cd docs
make html
- name: Papermill
run: |
cd docs
make papermill
- name: Coverage
run: |
set -ex
cd docs
make coverage
if [ "$(wc -l build/*/coverage/python.txt)" -ne 2 ]
then
cat build/*/coverage/python.txt
echo "missing documentation coverage!"
exit 1
fi
docpush:
runs-on: linux.20_04.4x
needs: docbuild
if: ${{ github.ref == 'refs/heads/main' }}
steps:
- name: Setup Python
uses: actions/setup-python@v2
with:
python-version: 3.8
architecture: x64
- name: Checkout TorchX
uses: actions/checkout@v2
- name: Set Identity
run: |
set -ex
git config --global user.email "[email protected]"
git config --global user.name "TorchX CI Runner"
- name: Install Dependencies
run: |
set -eux
sudo apt-get install -y pandoc
pip install -r docs/requirements.txt
- name: Start Airflow
run: |
# start airflow in background
airflow standalone &
# wait 5 seconds for airflow to start
sleep 5
- name: Build
run: |
set -ex
docs/doc_push.sh --dry-run
- name: Push
run: |
set -ex
cd /tmp/torchx_docs_tmp/torchx_gh_pages
git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}
git push