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
43
44
45
46
47
48
49
50
51
52

# Makefile for Sphinx documentation
#
# Usage:
#   make html      - Build HTML documentation
#   make clean     - Remove build artifacts
#   make linkcheck - Check external links
#   make livehtml  - Build with auto-reload (requires sphinx-autobuild)
#   make rustdoc   - Generate and stage rustdoc
#   make full      - Full build with rustdoc

SPHINXOPTS    ?= -W
SPHINXBUILD   ?= sphinx-build
SOURCEDIR     = .
BUILDDIR      = _build

# Default target
.PHONY: help
help:
	@echo "Sphinx documentation build targets:"
	@echo ""
	@echo "  html       Build HTML documentation"
	@echo "  clean      Remove build artifacts"
	@echo "  linkcheck  Check external links"
	@echo "  livehtml   Build with auto-reload (requires sphinx-autobuild)"
	@echo "  rustdoc    Generate and stage rustdoc artifacts"
	@echo "  full       Full build including rustdoc"
	@echo ""

.PHONY: html
html:
	$(SPHINXBUILD) -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

.PHONY: clean
clean:
	rm -rf $(BUILDDIR)

.PHONY: linkcheck
linkcheck:
	$(SPHINXBUILD) -b linkcheck $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/linkcheck

.PHONY: livehtml
livehtml:
	sphinx-autobuild -b html $(SPHINXOPTS) $(SOURCEDIR) $(BUILDDIR)/html

.PHONY: rustdoc
rustdoc:
	cd .. && cargo doc --no-deps --all-features
	cd .. && ./scripts/stage-rustdoc.sh

.PHONY: full
full: rustdoc html
	@echo "✓ Full documentation build complete"