Skip to content

docs: add development install and update instructions #6

docs: add development install and update instructions

docs: add development install and update instructions #6

Workflow file for this run

# Build the MkDocs site and publish it to GitHub Pages.
#
# One-time setup: in the repository settings, set Pages -> "Build and deployment"
# -> Source to "GitHub Actions". The site is then served at
# https://nely-epfl.github.io/deeperfly/ and rebuilt on every push to main.
name: docs
on:
push:
branches: [main]
paths:
- "docs/**"
- "mkdocs.yml"
- "src/**"
- ".github/workflows/docs.yml"
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment; don't cancel an in-progress run.
concurrency:
group: pages
cancel-in-progress: false
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: astral-sh/setup-uv@v5
- name: Build site
run: uv run --group docs mkdocs build --strict
- uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- id: deployment
uses: actions/deploy-pages@v4