docs build commands for arcade-mcp (#587)

This commit is contained in:
Evan Tahler 2025-09-26 15:30:52 -07:00 committed by GitHub
parent 74024c408e
commit 9f339b7964
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 30 additions and 5 deletions

22
.github/workflows/test-docs.yml vendored Normal file
View file

@ -0,0 +1,22 @@
name: Test Docs
on:
push:
branches:
- main
pull_request:
types: [opened, synchronize, reopened, ready_for_review]
jobs:
test-docs:
runs-on: ubuntu-latest
steps:
- name: Check out
uses: actions/checkout@v4
- name: Install uv
uses: astral-sh/setup-uv@v6
- name: Test docs
working-directory: libs/arcade-mcp-server
run: make sync && make docs-build

3
.gitignore vendored
View file

@ -173,3 +173,6 @@ cython_debug/
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
#.idea/
# Docs
libs/arcade-mcp-server/site/*

View file

@ -31,10 +31,10 @@ docs: ## Build docs
uv run mkdocs build
uv run mkdocs serve
.PHONY: serve-docs
serve-docs: ## Serve docs locally
.PHONY: docs-serve
docs-serve: ## Serve docs locally
uv run mkdocs serve
.PHONY: deploy-docs
deploy-docs: ## Deploy docs to GitHub Pages
uv run mkdocs gh-deploy --force --verbose
.PHONY: docs-build
docs-build: ## Build docs
uv run mkdocs build