docs: Add note about llms.txt
link
#68
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
on: | |
push: | |
branches: | |
- main | |
paths: | |
- "docs/**/*" | |
- .github/workflows/docs-publish.yml | |
workflow_dispatch: | |
name: Docs - Publish | |
env: | |
UV_VERSION: "0.4.x" | |
PYTHON_VERSION: 3.13 | |
QUARTO_VERSION: 1.6.35 | |
jobs: | |
docs-publish: | |
runs-on: ubuntu-latest | |
steps: | |
- name: Check out repository | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 # full history needed for correct versioning of py pkg | |
- name: π΅ Set up Quarto | |
uses: quarto-dev/quarto-actions/setup@v2 | |
with: | |
version: ${{ env.QUARTO_VERSION }} | |
- name: π Install uv | |
uses: astral-sh/setup-uv@v3 | |
with: | |
version: ${{ env.UV_VERSION }} | |
- name: π Set up Python ${{ env.PYTHON_VERSION }} | |
run: uv python install ${{ env.PYTHON_VERSION }} | |
- name: π¦ Install brand_yml and dependencies | |
run: uv sync --python ${{ env.PYTHON_VERSION }} --no-dev --extra docs | |
# From https://github.com/r-lib/actions/tree/v2-branch/setup-r | |
# - name: Setup R | |
# uses: r-lib/actions/setup-r@v2 | |
- name: π Activate venv | |
run: | | |
source .venv/bin/activate | |
echo "$VIRTUAL_ENV/bin" >> $GITHUB_PATH | |
echo "VIRTUAL_ENV=$VIRTUAL_ENV" >> $GITHUB_ENV | |
- name: π Update Python docs | |
run: make py-docs | |
- name: π’ Publish to GitHub Pages (and render) | |
uses: quarto-dev/quarto-actions/publish@v2 | |
with: | |
target: gh-pages | |
path: docs |