Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 16 additions & 11 deletions .github/workflows/release_docs.yml
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
name: Release docs
on:
pull_request:
types: [closed]
push:
branches: [ main ]

permissions:
contents: write
contents: read
pages: write
id-token: write

jobs:
deploy:
if: ${{ github.event_name == 'workflow_dispatch' || (github.event_name == 'pull_request' && github.event.pull_request.merged == true) }}
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- uses: actions/configure-pages@45bfe0192ca1faeb007ade9deae92b16b8254a0d # v6.0.0
- uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
with:
persist-credentials: true

- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
fetch-depth: 0

- uses: astral-sh/setup-uv@fac544c07dec837d0ccb6301d7b5580bf5edae39 # v8.2.0
with:
Expand All @@ -28,5 +28,10 @@ jobs:
version: "latest"
- name: Install Dependencies
run: uv sync --only-group docs
- name: Deploy Docs
run: uv run mkdocs gh-deploy --force
- name: Build Docs
run: uv run zensical build --clean
- uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5.0.0
with:
path: site
- uses: actions/deploy-pages@368f82528645a54fb793d4d04e342629a3f51346 # v5.0.1
id: deployment
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ init: ## Install all project dependencies with extras

.PHONY: run_docs
run_docs: ## Run documentation server
@uv run mkdocs serve --livereload
@uv run zensical serve

.PHONY: run_infra
run_infra: ## Run rabbitmq in docker for integration tests
Expand Down
125 changes: 0 additions & 125 deletions mkdocs.yml

This file was deleted.

2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ test = [
"uvloop>=0.22.1",
]
docs = [
"mkdocs-material>=9.7.7",
"mkdocstrings-python>=2.0.8",
"zensical>=0.0.62",
]

[build-system]
Expand Down
Loading
Loading