Skip to content

Commit

Permalink
👷 Add deployment of mkdocs site.
Browse files Browse the repository at this point in the history
  • Loading branch information
Raphael Krupinski committed Jan 17, 2024
1 parent e673611 commit edb9416
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 0 deletions.
32 changes: 32 additions & 0 deletions .github/workflows/mkdocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Deploy MkDocs to GitHub Pages

on:
push:
branches:
- develop # Set this to your default branch

jobs:
deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v4

- name: Setup Python
uses: actions/setup-python@v5
with:
python-version: '3.x' # Set this to the Python version you're using

- name: Install dependencies
run: |
pip install mkdocs-material # or just 'mkdocs' if you're using the default theme
- name: Build site
run: mkdocs build -f config/mkdocs.yml

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./site # Set this to your 'site_dir' if you have a custom build directory
21 changes: 21 additions & 0 deletions config/mkdocs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
site_name: Lapidary
site_description: Build Web API clients with python annotations
copyright: © 2024 Rafał Krupiński
repo_url: https://github.com/python-lapidary/lapidary
repo_name: python-lapidary/lapidary

docs_dir: ../docs
site_dir: ../site

plugins:
- mkdocstrings:
handlers:
python:
paths:
- ../src
options:
docstring_style: sphinx


theme:
name: material

0 comments on commit edb9416

Please sign in to comment.