README.md

Mission Pinball Framework Documentation (mpf-docs)

This repo is the user documentation for the Mission Pinball Framework.

These docs are static HTML, generated from the files in this repo via the Sphinx Python Documentation Generator project.

The rendered HTML docs are hosted by Read the Docs at http://docs.missionpinball.org. You can also download PDF and HTML versions from, there.

The "latest" branch of these docs corresponds to the latest released branch recent version of MPF. There are numbered branches for specific released versions (e.g. 0.55, etc.). There's also a dev branch which corresponds to the dev branch which is the next upcoming release.

Building Docs Locally

You can build the docs using Sphinx. You will first need to install Python 3.x. Then install the packages used by this repo. From the root folder of this repo, run the following command:

pip3 install -r requirements.txt

You can view the contents of the requirements.txt file to see which packages will be installed.

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.