Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix documentation site links to include /latest/ after tld #1838

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion AUTHORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,11 @@ their spare time, unpaid, for the love of pinball!
* Dave Ensminger <[email protected]>
* Charles Duncan (nullbuilds)
* Eric Selk <[email protected]>
* Alex Lobascio (bosh)

MPF was inspired by pyprocgame which was written by:

* Adam Preble
* Gerry Stellenberg

Want to contribute to MPF? Get started here: https://missionpinball.org/about/contributing_to_mpf/
Want to contribute to MPF? Get started here: https://missionpinball.org/latest/about/contributing_to_mpf/
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See: https://missionpinball.org/about/contributing_to_mpf/
See: https://missionpinball.org/latest/about/contributing_to_mpf/
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Mission Pinball Framework (MPF)
===============================

<img align="center" height="146" src="https://missionpinball.org/images/mpf-logo-full.png"/>
<img align="center" height="146" src="https://missionpinball.org/latest/images/mpf-logo-full.png"/>

<em>...Let's build a pinball machine!</em>

Expand All @@ -25,7 +25,7 @@ Documentation
Support
-------

MPF is an open source community project which has no official support. Some MPF users participate in the MPF-Users Google group or GitHub Discussion. Links [here](https://missionpinball.org/community/).
MPF is an open source community project which has no official support. Some MPF users participate in the MPF-Users Google group or GitHub Discussion. Links [here](https://missionpinball.org/latest/community/).

Individual pinball hardware companies may provide additional support for users of their hardware, often via their own Slack, Discord, or other chat groups. If you get stuck, you can ask for help in the MPF-users group, or you reach out to your hardware provider.

Expand All @@ -34,15 +34,15 @@ Maintenance, Pull Requests, & Bug Fixes

As a community project, we welcome pull requests and bug fixes. However, we do not have the resources to provide support for MPF. If you are interested in becoming a maintainer, please contact us at [email protected].

Bugs or other issues related to MPF itself can be posted to the [MPF Discussions page on GitHub](https://missionpinball.org/community/).
Bugs or other issues related to MPF itself can be posted to the [MPF Discussions page on GitHub](https://missionpinball.org/latest/community/).

Contributing
------------

Individual pinball hardware makers are responsible for their own platform interface maintenance and contributions.

MPF is a passion project created and maintained by volunteers. If you're a Python coder, documentation writer, or pinball maker, feel free to make a change and submit a pull request. For more information about contributing see the [Contributing Code](https://missionpinball.org/about/contributing_to_mpf/)
and [Contributing Documentation](https://missionpinball.org/about/help_docs/) pages.
MPF is a passion project created and maintained by volunteers. If you're a Python coder, documentation writer, or pinball maker, feel free to make a change and submit a pull request. For more information about contributing see the [Contributing Code](https://missionpinball.org/latest/about/contributing_to_mpf/)
and [Contributing Documentation](https://missionpinball.org/latest/about/help_docs/) pages.

License
-------
Expand Down
2 changes: 1 addition & 1 deletion RELEASE.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
See: https://missionpinball.org/versions/release_notes/
See: https://missionpinball.org/latest/versions/release_notes/
2 changes: 1 addition & 1 deletion docs/code/machine_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ match up to any of MPF's built in devices. The elevator and claw unloader
in *Demolition Man* is a good example, and what we'll use here.

(You can read about how to download and run *Demo Man* in the
`example games section <https://missionpinball.org/example_games/>`_
`example games section <https://missionpinball.org/latest/examples/>`_
section of the MPF User Documentation.)

Here's how to create a custom code class:
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/event_annotations.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ document the event in code and in the docs, we use a custom docblock annotation:
reason: The reason for this awesomeness is stated here.
'''

The event should be added to the `event reference <https://missionpinball.org/events/>`_
The event should be added to the `event reference <https://missionpinball.org/latest/events/>`_
on missionpinball.org.

Note: As of June 2023, the events list on missionpinball.org is no longer automatically generated.
8 changes: 4 additions & 4 deletions docs/dev/mc.widget_player.rst
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ So here is our base ``widget`` from the config file that we will be using.
x: 35

Refer to the widget section in the docs for more info on how to set it up:
https://missionpinball.org/mc/widgets/
https://missionpinball.org/latest/mc/widgets/

Writing the settings to show/play this widget in code
^^^^^^^^^^^^^^^
Expand All @@ -69,7 +69,7 @@ When it comes to the settings we start with the following:

You need to add ``action`` and ``key`` to make the ``widget`` work.
Refer to the ``widget_player`` section for more info on these and what other functions can be added:
https://missionpinball.org/config_players/widget_player/
https://missionpinball.org/latest/config_players/widget_player/

Now you can show the pre-defined widget from the config file.

Expand Down Expand Up @@ -107,7 +107,7 @@ The following code shows how to override an image and x-coordinate
You can ``change``/``add`` everything this way from the related type of ``widget``, or the common settings for all widgets.
Refer to the common settings for a overview of all settings.

https://missionpinball.org/mc/widgets/common_settings/
https://missionpinball.org/latest/mc/widgets/common_settings/

Just make sure you format this way

Expand All @@ -127,7 +127,7 @@ Creating animation from predefined animations
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The easiest thing is to change/add pre-defined animations.
See chapter 9 of widget animation for more info on this:
https://missionpinball.org/mc/widgets/animation/
https://missionpinball.org/latest/mc/widgets/animation/

.. code-block:: python

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/tutorial/2.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Testing Tutorial Step 2. Create your machine folder
===================================================

`Step 2 of the MPF Tutorial <https://missionpinball.org/tutorial/2_creating_a_new_machine>`_ is where
`Step 2 of the MPF Tutorial <https://missionpinball.org/latest/tutorial/2_creating_a_new_machine>`_ is where
you create your machine folder and get MPF up and running with an empty config. Since it ends with MPF running and the
attract mode being active, we can actually write a test for it!

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/writing_machine_tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ your tests pass again!)
.. rubric:: Tutorial for writing your own tests

We have a complete tutorial which walks you through writing tests for your own machine. This tutorial
conveniently follows the general MPF tutorial at `<https://missionpinball.org/tutorial>`_. Each step here matches the
conveniently follows the general MPF tutorial at `<https://missionpinball.org/latest/tutorial>`_. Each step here matches the
step with the same number there. (Just make sure you'll looking at the same version of the documentation
in both places.)

Expand Down
2 changes: 1 addition & 1 deletion mpf/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
'''An extended version string that includes the MPF version, show version,
and BCP versions used in this build of MPF.'''

log_url = "https://missionpinball.org/logs"
log_url = "https://missionpinball.org/latest/logs"
# TODO make dynamic "https://docs.missionpinball.org/en/dev/logs/{}.html"

__api__ = ['version',
Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/credits/config/credits.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
stop_on_ball_end: False

# Instructions on how to use this mode:
# https://missionpinball.org/game_logic/credits
# https://missionpinball.org/latest/game_logic/credits

# You can copy the sections below to your own machine config as a starting point

Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/high_score/config/high_score.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
use_wait_queue: true

# Instructions on how to use this mode:
# https://missionpinball.org/game_logic/high_scores
# https://missionpinball.org/latest/game_logic/high_scores

high_score:
enter_initials_timeout: 60
Expand Down
2 changes: 1 addition & 1 deletion mpf/modes/tilt/config/tilt.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ mode:
stop_on_ball_end: False

# Instructions on how to use this mode:
# https://missionpinball.org/game_logic/tilt
# https://missionpinball.org/latest/game_logic/tilt

tilt:
tilt_warning_switch_tag: tilt_warning
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ all = [ # currently no way to just use the names from above afaik?

[project.urls]
homepage = "https://missionpinball.org"
support-forum = "https://missionpinball.org/community/"
support-forum = "https://missionpinball.org/latest/community/"

[project.scripts]
mpf = "mpf.commands:run_from_command_line"
Expand Down
Loading