diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml index 0ee870f..579e77a 100644 --- a/.github/workflows/deploy_docs.yml +++ b/.github/workflows/deploy_docs.yml @@ -4,16 +4,21 @@ on: push: branches: - master + pull_request: + branches: + - master permissions: contents: write jobs: - build-deploy: - runs-on: ubuntu-latest + build: + runs-on: ubuntu-22.04 steps: - name: Checkout code uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Setup Python uses: actions/setup-python@v5 @@ -22,9 +27,37 @@ jobs: - name: Install dependencies run: | - pip install mkdocs-material - pip install mkdocstrings[python] - pip install mkdocs-git-revision-date-localized-plugin + pip install --upgrade pip + pip install mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin + + - name: Set PYTHONPATH + run: echo "PYTHONPATH=$(pwd)" >> $GITHUB_ENV + + - name: Build docs + run: mkdocs build + + deploy: + needs: build + if: github.event_name == 'push' && github.ref == 'refs/heads/master' + runs-on: ubuntu-22.04 + steps: + - name: Checkout code + uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.10' + + - name: Install dependencies + run: | + pip install --upgrade pip + pip install mkdocs-material mkdocstrings[python] mkdocs-git-revision-date-localized-plugin + + - name: Set PYTHONPATH + run: echo "PYTHONPATH=$(pwd)" >> $GITHUB_ENV - - name: Deploy documentation + - name: Deploy docs run: mkdocs gh-deploy --force diff --git a/docs/index.md b/docs/index.md index d954540..9bf0e8b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -14,7 +14,7 @@ hide: [![🤗 Hugging Face](https://img.shields.io/badge/🤗-Asset_Gallery-blue)](https://huggingface.co/spaces/HorizonRobotics/EmbodiedGen-Gallery-Explorer) [![中文介绍](https://img.shields.io/badge/中文介绍-07C160?logo=wechat&logoColor=white)](https://mp.weixin.qq.com/s/HH1cPBhK2xcDbyCK4BBTbw) -*EmbodiedGen*: Towards a Generative 3D World Engine for Embodied Intelligence +*EmbodiedGen*: Towards a Generative 3D World Engine for Embodied Intelligence. Overall Framework