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
53
54
55
56
57
58
59
60
61
62
63
64

# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
from pathlib import Path

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = "brkrs"
copyright = "2025, Christian Ledermann"
author = "Christian Ledermann"

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    "myst_parser",
    "sphinx_copybutton",
]

# MyST-Parser configuration
myst_enable_extensions = [
    "colon_fence",
    "deflist",
    "fieldlist",
    "tasklist",
]

templates_path = ["_templates"]
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# Source file suffixes
source_suffix = {
    ".rst": "restructuredtext",
    ".md": "markdown",
}

# -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output

html_theme = "furo"
html_static_path = ["_static"]

# Furo theme options
html_theme_options = {
    "source_repository": "https://github.com/cleder/brkrs",
    "source_branch": "main",
    "source_directory": "docs/",
}

# Include rustdoc output in the build (only if directory exists)
# Set SPHINX_SKIP_RUSTDOC=1 to skip rustdoc embedding (for fast PR builds)
_rustdoc_path = Path(__file__).parent / "_static" / "rustdoc"
if not os.environ.get("SPHINX_SKIP_RUSTDOC") and _rustdoc_path.exists():
    html_extra_path = ["_static/rustdoc"]

# Suppress expected warnings
suppress_warnings = [
    # MyST cross-reference warnings for external HTML files (rustdoc links)
    "myst.xref_missing",
]