Fix naming and dataset URLs #1222
Workflow file for this run
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: L5Kit-docs | |
on: | |
push: | |
branches: [ master ] | |
pull_request: | |
branches: [ master ] | |
jobs: | |
build: | |
runs-on: ubuntu-20.04 | |
steps: | |
- uses: actions/checkout@v2 | |
- name: Set up Python 3.8 | |
uses: actions/setup-python@v1 | |
with: | |
python-version: 3.8 | |
- name: Install dependencies | |
working-directory: l5kit | |
run: | | |
pip install --upgrade pip | |
pip install pipenv | |
pipenv sync --dev | |
- name: Build docs | |
working-directory: l5kit | |
run: | | |
pipenv run sphinx-apidoc --module-first --separate -o ../docs/API/ l5kit l5kit/tests* | |
pipenv run sphinx-build ../docs ../docs_built | |
- name: Deploy docs | |
uses: JamesIves/github-pages-deploy-action@releases/v3 | |
with: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
BASE_BRANCH: master # The branch the action should deploy from. | |
BRANCH: gh-pages # The branch the action should deploy to. | |
FOLDER: docs_built # The folder the action should deploy (only stuff inside will be copied). | |
if: github.event_name == 'push' |