29 lines
780 B
YAML
29 lines
780 B
YAML
name: Build Documentation with mkdocs
|
|
run-name: ${{ GITHUB.ACTOR }} is generating a Documentation from Markdown 🚀
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches:
|
|
- main
|
|
paths:
|
|
- ".github/workflows/docs-mkdocs.yml"
|
|
- "docs/**"
|
|
jobs:
|
|
build_markdown_documentation:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Set up Git repository
|
|
uses: actions/checkout@v3
|
|
with:
|
|
fetch-depth: 0
|
|
- name: Generate HTML from Markdown
|
|
uses: actions/setup-python@v4
|
|
- run: pip install -r requirements.txt
|
|
- run: mkdocs build --clean
|
|
- run: mkdocs gh-deploy
|
|
# - name: Deploy GitHub Pages
|
|
# uses: peaceiris/actions-gh-pages@v3
|
|
# with:
|
|
# publish_dir: ./gh-pages
|
|
# github_token: ${{ secrets.GITHUB_TOKEN }}
|