From 9f339b79642dc0ae04c764cbf1e1da20deff5bf6 Mon Sep 17 00:00:00 2001 From: Evan Tahler Date: Fri, 26 Sep 2025 15:30:52 -0700 Subject: [PATCH] docs build commands for arcade-mcp (#587) --- .github/workflows/test-docs.yml | 22 ++++++++++++++++++++++ .gitignore | 3 +++ libs/arcade-mcp-server/Makefile | 10 +++++----- 3 files changed, 30 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/test-docs.yml diff --git a/.github/workflows/test-docs.yml b/.github/workflows/test-docs.yml new file mode 100644 index 00000000..2c85533d --- /dev/null +++ b/.github/workflows/test-docs.yml @@ -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 diff --git a/.gitignore b/.gitignore index 4865054a..bc9b486a 100644 --- a/.gitignore +++ b/.gitignore @@ -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/* diff --git a/libs/arcade-mcp-server/Makefile b/libs/arcade-mcp-server/Makefile index 05e3a63e..64e00c6e 100644 --- a/libs/arcade-mcp-server/Makefile +++ b/libs/arcade-mcp-server/Makefile @@ -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