-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Raphael Krupinski
committed
Jan 18, 2024
1 parent
e673611
commit 56660e8
Showing
2 changed files
with
54 additions
and
0 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
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 'mkdocstrings[python]' | ||
- 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 | ||
cname: lapidary.dev |
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
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 |