Skip to content

mkdocs wkfl install --only docs #728

mkdocs wkfl install --only docs

mkdocs wkfl install --only docs #728

Workflow file for this run

name: Doc pages
on:
push:
paths:
- "docs/**"
- "mkdocs.yml"
- ".github/workflows/mkdocs-deploy.yml"
branches:
- main
- simpler_doc_linking
permissions:
contents: write
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: 3.11 # Replace with your desired Python version
- name: Install Poetry
uses: Gr1N/setup-poetry@v8
- name: Install Poetry dependencies
run: |
poetry --version
echo "$HOME/.local/bin" >> $GITHUB_PATH
python -m pip install --upgrade pip
poetry install --only docs
- name: Build MkDocs documentation
# change this to -b gh-pages when ready to make docs public
run: poetry run mkdocs gh-deploy -b gh-pages --force
# - name: Deploy to GitHub Pages
# uses: peaceiris/actions-gh-pages@v3
# with:
# deploy_key: ${{ secrets.GITHUB_TOKEN }}
# publish_branch: gh-pages
# publish_dir: ./site