brkrs 0.0.1

Breakout/Arkanoid-style game built in Rust using the Bevy engine, with physics powered by bevy_rapier3d
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

# Fast documentation validation for pull requests
# Target: Complete in under 60 seconds
# Skips rustdoc generation for speed

name: Docs PR Validation

on:
  pull_request:
    paths:
      - "docs/**"
      - ".github/workflows/docs-pr.yml"
      - "readthedocs.yml"

jobs:
  validate-docs:
    name: Validate Documentation
    runs-on: ubuntu-latest
    timeout-minutes: 2

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: "pip"
          cache-dependency-path: docs/requirements.txt

      - name: Install dependencies
        run: pip install -r docs/requirements.txt

      - name: Build documentation (no rustdoc)
        run: sphinx-build -W -b html docs/ docs/_build/html
        env:
          # Skip rustdoc check in PR validation for speed
          SPHINX_SKIP_RUSTDOC: "1"

      - name: Check links
        run: sphinx-build -W -b linkcheck docs/ docs/_build/linkcheck
        continue-on-error: true  # Don't fail on external link issues