Merge pull request #835 from salman1993/main #531
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: Publish Docs | |
on: | |
push: | |
tags: | |
- v* | |
workflow_dispatch: | |
env: | |
MKDOCS_SOCIAL_CARDS: ${{ vars.MKDOCS_SOCIAL_CARDS }} | |
MKDOCS_MATERIAL_INSIDERS_REPO_RO: ${{ secrets.MKDOCS_MATERIAL_INSIDERS_REPO_RO }} | |
permissions: | |
contents: write | |
jobs: | |
publish-docs: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
- uses: actions/setup-python@v5 | |
with: | |
python-version: "3.9" | |
- uses: actions/cache@v4 | |
with: | |
key: ${{ github.ref }} | |
path: .cache | |
# for now, only install mkdocs. In the future may need to install Marvin itself. | |
- name: Install dependencies for MKDocs Material | |
run: pip install \ | |
mkdocs-material \ | |
mkdocs-autolinks-plugin \ | |
mkdocs-awesome-pages-plugin \ | |
mkdocstrings[python] \ | |
mkdocs-markdownextradata-plugin \ | |
mkdocs-jupyter \ | |
pillow \ | |
cairosvg | |
- name: Publish docs | |
run: mkdocs gh-deploy --force |