fix documentation site links to include /latest/ after tld

bosh · bosh · commit 9f748bb15317 · 2024-09-20T18:51:43.000-07:00
diff --git a/AUTHORS.md b/AUTHORS.md
@@ -30,10 +30,11 @@ their spare time, unpaid, for the love of pinball!
  * Dave Ensminger <dave@ensadi.com>
  * Charles Duncan (nullbuilds)
  * Eric Selk <ericselk2018@gmail.com>
+ * 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/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1 +1 @@
-See: https://missionpinball.org/about/contributing_to_mpf/
+See: https://missionpinball.org/latest/about/contributing_to_mpf/
diff --git a/README.md b/README.md
@@ -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>
 
@@ -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.
 
@@ -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 brian@missionpinball.org.
 
-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
 -------
diff --git a/RELEASE.md b/RELEASE.md
@@ -1 +1 @@
-See: https://missionpinball.org/versions/release_notes/
+See: https://missionpinball.org/latest/versions/release_notes/
diff --git a/docs/code/machine_code.rst b/docs/code/machine_code.rst
@@ -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:
diff --git a/docs/dev/event_annotations.rst b/docs/dev/event_annotations.rst
@@ -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.
diff --git a/docs/dev/mc.widget_player.rst b/docs/dev/mc.widget_player.rst
@@ -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
 ^^^^^^^^^^^^^^^
@@ -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.
 
@@ -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
 
@@ -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
 
diff --git a/docs/testing/tutorial/2.rst b/docs/testing/tutorial/2.rst
@@ -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!
 
diff --git a/docs/testing/writing_machine_tests.rst b/docs/testing/writing_machine_tests.rst
@@ -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.)
 
diff --git a/mpf/_version.py b/mpf/_version.py
@@ -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',
diff --git a/mpf/modes/credits/config/credits.yaml b/mpf/modes/credits/config/credits.yaml
@@ -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
 
diff --git a/mpf/modes/high_score/config/high_score.yaml b/mpf/modes/high_score/config/high_score.yaml
@@ -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
diff --git a/mpf/modes/tilt/config/tilt.yaml b/mpf/modes/tilt/config/tilt.yaml
@@ -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
diff --git a/pyproject.toml b/pyproject.toml
@@ -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"

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-See: https://missionpinball.org/about/contributing_to_mpf/`
	`1`	`+See: https://missionpinball.org/latest/about/contributing_to_mpf/`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-See: https://missionpinball.org/versions/release_notes/`
	`1`	`+See: https://missionpinball.org/latest/versions/release_notes/`