docs(docs/images): add cli help screenshots (not used yet) #212
This file contains hidden or 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 documentation | |
on: | |
push: | |
branches: | |
- master | |
jobs: | |
publish-documentation: | |
runs-on: ubuntu-latest | |
steps: | |
- uses: actions/checkout@v4 | |
with: | |
token: '${{ secrets.PERSONAL_ACCESS_TOKEN }}' | |
fetch-depth: 0 | |
- name: Set up Python | |
uses: actions/setup-python@v5 | |
with: | |
python-version: '3.x' | |
- name: Install dependencies | |
run: | | |
python -m pip install -U mkdocs mkdocs-material | |
- name: Build docs | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
run: | | |
python -m mkdocs build | |
- name: Generate Sponsors 💖 | |
uses: JamesIves/github-sponsors-readme-action@v1 | |
with: | |
token: ${{ secrets.PERSONAL_ACCESS_TOKEN_FOR_ORG }} | |
file: 'docs/README.md' | |
- name: Push doc to Github Page | |
uses: peaceiris/actions-gh-pages@v2 | |
env: | |
PERSONAL_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }} | |
PUBLISH_BRANCH: gh-pages | |
PUBLISH_DIR: ./site |