Skip to content

docs(readme): squash titles into one line #1339

docs(readme): squash titles into one line

docs(readme): squash titles into one line #1339

Workflow file for this run

name: deploy docs
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
name: build-docusaurus
runs-on: ubuntu-latest
if: github.repository == 'ulab-uiuc/research-town'
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: actions/setup-node@v4
with:
node-version: 18
cache: npm
cache-dependency-path: docs/package-lock.json
- name: set up python
uses: actions/setup-python@v5
with:
python-version: "3.11"
- name: generate python docs
run: rm -rf docs/modules/python && pip install pydoc-markdown && pydoc-markdown
- name: install dependencies
run: cd docs && npm ci
- name: Build website
run: cd docs && npm run build
- name: upload build artifact
if: github.ref == 'refs/heads/main'
uses: actions/upload-pages-artifact@v3
with:
path: docs/build
deploy:
name: deploy-to-github-pages
needs: build
if: github.ref == 'refs/heads/main' && github.repository == 'ulab-uiuc/research-town'
# Grant GITHUB_TOKEN the permissions required to make a Pages deployment
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
# Deploy to the github-pages environment
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: deploy to gitHub pages
id: deployment
uses: actions/deploy-pages@v4