This is the documentation the latest work-in-progress version of MPF!

This is the documentation for MPF 0.57, which is the “dev” (next) release of MPF that is a work-in-progress. This is probably ok, and means you’ll be on the latest, cutting-edge version of MPF.

However, if you want a more stable version, select the v:stable version from the lower-left corner of this page. You can always update to the latest at any time.

Contributing to MPF’s Documentation

Want to help make these docs better! Great! We’d love any help, whether it’s as small as correcting a typo, adding to a section that isn’t clear, adding your own How To guide, or whatever else you want to change.

Video about contributing to the documentation:

If you got any questions please ask in the MPF Users Google Group. We are happy to help you with any contribution.

To make a quick change to an existing page

Quick changes to existing pages can be done right on the web!

To do that:

  1. Browse to the page you want to update, and click the “Edit on GitHub” link in the upper right corner of the page.
  2. Click the pencil icon in the upper-right corner of the page’s text. (If this is grayed out, that means you need to create a GitHub account and/or login.) This will create a fork of mpf-docs in your GitHub account.
  3. Make your change, and click the “Propose file change”. This will create a pull request. Type a name describing your change, and click “Create pull request”.
  4. Details and screen shots of this entire process are here.

To make a suggestion for a new doc (or to point out an error)

Even if you don’t feel comfortable actually changing or editing docs, you can still tell us about an error in the documentation or suggest new documentation that we should add. To do this:

  1. Go to the “Issues” page of the mpf-docs repository on GitHub.
  2. Create a GitHub account if you don’t have one, and/or login.
  3. Click the “New Issue” button and describe what you’d like us to fix or add!

How does the layout work?

The documentation uses reStructuredText (rst). You can read about possible elements in the rst documentation.

Some excerpts from the documentation above:

A bulleted list of items:

* element 1
* element 2

Looks like:

  • element 1
  • element 2

Highlighted yaml:

.. code-block:: yaml

    subelement: value

Looks like:

  subelement: value

To clone the mpf-docs repo locally to make bigger changes

If you want to make bigger changes to the docs, or if you want to download the mpf-docs repo so you can work on it offline, do the following:

  1. Clone the mpf-docs repo from GitHub.
  2. Switch to the branch corresponding to the version of the docs you want to work with (usually dev or latest).
  3. Makes your changes.
  4. Add your name to the /about/authors.rst doc.
  5. To test the docs locally, you’ll need sphinx and sphinx_bootstrap_theme, both of which you can install via pip.
  6. Run make html to ensure everything builds properly without any additional warnings from whatever docs you added or changed. (The built docs will be in the _build/html folder. You can open index.html in your local browser to preview your changes.)
  7. Submit your pull request