Skip to content
User documentation for the Mission Pinball Framework.
Python Makefile Batchfile CSS
Branch: dev
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_doc_tools
_not_updated_yet
_static
about
assets
config
config_players
cookbook
developer
displays
events/overview
example_games
faq
finalization
flowcharts
game_design
game_logic
game_vars
glossary
hardware
install
logs
machine_management
machine_vars
machines
mechs
player_vars
running
shows
sound
start
testing
tools
troubleshooting
tutorial
versions
.editorconfig
.gitignore
.readthedocs.yaml
.travis.yml
LICENSE.md
Makefile
MpfDocsTestCase.py
README.md
conf.py
index.rst
make.bat
not_updated_yet.rst
requirements.txt
setup.py

README.md

Mission Pinball Framework Documentation (mpf-docs)

This repo is the documentation for the Mission Pinball Framework.

Docs are hosted by Read the Docs at http://docs.missionpinball.org. You can download PDF, HTML, and Epub versions.

The "latest" branch of these docs corresponds to the latest released branch recent version of MPF. (We note which features have been added, changed, and removed as needed.)

Building Docs Locally

You can build the docs using Sphinx. You will first need to install Python 3.x and pip. Then add these libraries:

pip install sphinx
pip install gitpython
pip install sphinx_rtd_theme

Running Unit Tests

To test that MPF can run all the config snippets in the docs and run the corresponding unit tests inside the docs (if there is one) type:

make unit

Compiling HTML

Compile the docs to ./_build/html/ with the command:

make html

Licensing

These docs are licensed CC BY 4.0. MPF and all code licensed MIT.

You can’t perform that action at this time.