Skip to content
Build and Deploy Documentation

docs: configure mkdocs for documentation deployment and GitHub Pages … #1

Sign in to view logs

docs: configure mkdocs for documentation deployment and GitHub Pages …

docs: configure mkdocs for documentation deployment and GitHub Pages … #1

Workflow file for this run

.github/workflows/deploy-docs.yml at 2b5e377
name: Build and Deploy Documentation
on:
push:
branches:
- gh-pages
pull_request:
branches:
- gh-pages
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.12'
- name: Install dependencies
run: |
pip install -r docs-requirements.txt
- name: Build documentation
run: |
mkdocs build
- name: Deploy to GitHub Pages
if: github.event_name == 'push' && github.ref == 'refs/heads/gh-pages'
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site
cname: hacktoolkit.github.io