From abe04abee7b0d55c0d131aa358b95b96bd6dbc5f Mon Sep 17 00:00:00 2001 From: kunal-10-cloud Date: Thu, 27 Nov 2025 16:12:23 +0530 Subject: [PATCH 1/2] Add GitHub Action to test mkdocs documentation build - Addresses issue #7627 - Workflow triggers on push/PR to live-docs branch - Uses uv package manager for Python dependencies - Builds examples, reference docs, and mkdocs site - Uploads build artifacts for review - Includes strict mode for mkdocs to catch errors --- .github/workflows/mkdocs-build.yml | 91 ++++++++++++++++++++++++++++++ 1 file changed, 91 insertions(+) create mode 100644 .github/workflows/mkdocs-build.yml diff --git a/.github/workflows/mkdocs-build.yml b/.github/workflows/mkdocs-build.yml new file mode 100644 index 00000000000..93ae60c623f --- /dev/null +++ b/.github/workflows/mkdocs-build.yml @@ -0,0 +1,91 @@ +name: MkDocs Documentation Build + +# Trigger on pushes and pull requests to the live-docs branch +# This is where the mkdocs documentation is being developed +on: + push: + branches: + - live-docs + pull_request: + branches: + - live-docs + # Allow manual workflow dispatch for testing + workflow_dispatch: + +jobs: + build-docs: + name: Build MkDocs Documentation + runs-on: ubuntu-latest + timeout-minutes: 20 + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.12' + + - name: Install uv (Python package manager) + uses: astral-sh/setup-uv@v5 + with: + enable-cache: true + + - name: Display uv version + run: uv --version + + - name: Install Python dependencies + working-directory: docs + run: | + uv pip install --system -r requirements.txt + + - name: Display installed packages + run: uv pip list --system + + - name: Build documentation examples + working-directory: docs + run: | + make examples + + - name: Build documentation reference + working-directory: docs + run: | + make reference + + - name: Build MkDocs site + working-directory: docs + run: | + uv run mkdocs build --strict + + - name: Check build output + working-directory: docs + run: | + if [ -d "build" ]; then + echo "✅ Documentation built successfully!" + echo "📊 Build statistics:" + du -sh build + find build -type f | wc -l | xargs echo "Total files:" + else + echo "❌ Documentation build failed - output directory not found" + exit 1 + fi + + - name: Upload documentation artifacts + if: always() + uses: actions/upload-artifact@v4 + with: + name: mkdocs-build-output + path: docs/build/ + retention-days: 7 + if-no-files-found: warn + + - name: Upload build logs on failure + if: failure() + uses: actions/upload-artifact@v4 + with: + name: build-logs + path: | + docs/tmp/ + retention-days: 7 + if-no-files-found: ignore From c4f175e6474846ec2c920832cb5dd17498899d0a Mon Sep 17 00:00:00 2001 From: kunal-10-cloud Date: Thu, 27 Nov 2025 19:18:46 +0530 Subject: [PATCH 2/2] Add draft log for mkdocs workflow --- draftlogs/7627_add.md | 1 + 1 file changed, 1 insertion(+) create mode 100644 draftlogs/7627_add.md diff --git a/draftlogs/7627_add.md b/draftlogs/7627_add.md new file mode 100644 index 00000000000..f4e35d7ccc3 --- /dev/null +++ b/draftlogs/7627_add.md @@ -0,0 +1 @@ +- Add GitHub Action to test mkdocs documentation build [[#7627](https://github.com/plotly/plotly.js/issues/7627)]