Fix links and enable warning for missing links (#459)

Signed-off-by: Addisu Z. Taddese <[email protected]>

base_conf.py

@@ -44,7 +44,6 @@
 ]
 
 myst_heading_anchors = 4
-myst_all_links_external = True
 
 myst_enable_extensions = [
     "amsmath",
@@ -64,6 +63,7 @@
     "tasklist",
 ]
 
+nitpicky = True
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 

blueprint/GUI_tutorial.md

@@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI).
 
 ## Prerequisites
 
-Before beginning, you should have [Ignition installed](/docs/blueprint/install).
-If you installed [from source](/docs/blueprint/install#option-3-source-installation-any-platform-)
-you will need to [source](/docs/blueprint/install#using-the-workspace) the workspace;
+Before beginning, you should have [Ignition installed](install).
+If you installed [from source](install.md#option-3-source-installation-any-platform)
+you will need to [source](install.md#using-the-workspace) the workspace;
 otherwise, you're good to go!
 
 Start by getting Ignition up and running with a sample world:
@@ -104,4 +104,4 @@ The function of the World Control options will become clearer once you begin man
 
 ## Next Up
 
-Now that you're comfortable with Ignition GUI navigation and terminology, let's start learning about more meaningful model interactions with the [Manipulating Models](/docs/blueprint/manipulating_models) tutorial.
+Now that you're comfortable with Ignition GUI navigation and terminology, let's start learning about more meaningful model interactions with the [Manipulating Models](manipulating_models) tutorial.

blueprint/Manipulating_models.md

@@ -3,7 +3,7 @@
 This tutorial will walk you through using various plugins to assist model and scene manipulation in the Ignition GUI.
 
 The Transform Control plugin is a combination of keybindings and transform control options: selection, translation, rotation and custom snap values.
-This chart of [Ignition's keyboard shortcuts](/docs/blueprint/hotkeys) may be helpful for this tutorial.
+This chart of [Ignition's keyboard shortcuts](hotkeys) may be helpful for this tutorial.
 
 The View Angle plugin allows you to quickly and easily adjust the direction from which your scene faces an entity in the simulation.
 
@@ -17,7 +17,7 @@ Start by getting Ignition up and running with a sample world:
 ign gazebo shapes.sdf
 ```
 
-The previous tutorial, [Understanding the GUI](/docs/blueprint/gui), explains the basics of navigating the Ignition GUI.
+The previous tutorial, [Understanding the GUI](gui), explains the basics of navigating the Ignition GUI.
 
 ## Transform Control
 
@@ -130,4 +130,4 @@ You can also select multiple entities to face simultaneously from each view angl
 
 So far you've interacted with basic shape models to learn about Ignition's GUI.
 It's also possible to insert more detailed models from [Ignition Fuel](https://app.gazebosim.org) into the GUI.
-Check out the [Model Insertion from Fuel](/docs/blueprint/fuel_insert) tutorial to learn how.
+Check out the [Model Insertion from Fuel](fuel_insert) tutorial to learn how.

blueprint/Model_insertion_fuel.md

@@ -11,7 +11,7 @@ Start by getting Ignition up and running with an empty world:
 ign gazebo empty.sdf
 ```
 
-The previous tutorial, [Manipulating Models](/docs/blueprint/manipulating_models), shows you how to interact with models, which might be helpful once you add some Fuel models to your world.
+The previous tutorial, [Manipulating Models](manipulating_models), shows you how to interact with models, which might be helpful once you add some Fuel models to your world.
 
 ## Choose a Model
 

ci.md

@@ -6,7 +6,7 @@ This document covers all the CI jobs that are available for Gazebo and how to
 interpret their results.
 
 This documentation assumes you have gone over the
-[Contributing guide](https://gazebosim.org/docs/all/contributing) and
+[Contributing guide](contributing) and
 therefore are familiar with:
 
 * Opening pull requests

citadel/GUI_tutorial.md

@@ -4,9 +4,9 @@ This guide is an introduction to the Ignition Graphical User Interface (GUI).
 
 ## Prerequisites
 
-Before beginning, you should have [Ignition installed](/docs/citadel/install).
-If you installed [from source](/docs/citadel/install#source-installation-instructions)
-you will need to [source](/docs/citadel/install_ubuntu_src#using-the-workspace) the workspace;
+Before beginning, you should have [Ignition installed](install).
+If you installed [from source](install.md#source-installation-instructions)
+you will need to [source](install_ubuntu_src.md#using-the-workspace) the workspace;
 otherwise, you're good to go!
 
 Start by getting Ignition up and running with a sample world:

citadel/ign_docker_env.md

@@ -23,9 +23,9 @@ High level instructions:
 
 1. Create a workspace with the source to mount into a container using `vcstool`
 2. Use `gzdev ign-docker-env` to build and start a container with `--vol` pointing to the previously created workspace
-3. See [Ubuntu Source Install section on building](install_ubuntu_src#building-the-ignition-libraries) for instructions to work with a source install
-4. Consider [Contributing](/docs/all/contributing)
+3. See [Ubuntu Source Install section on building](install_ubuntu_src.md#building-the-ignition-libraries) for instructions to work with a source install
+4. Consider [Contributing](contributing)
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/fortress/troubleshooting)
+See [Troubleshooting](troubleshooting)

citadel/install.md

@@ -43,7 +43,7 @@ collection assures that all libraries are compatible and can be used together.
 
 ## Supported platforms
 
-Citadel is [supported](/docs/all/releases) on the platforms below.
+Citadel is [supported](releases) on the platforms below.
 
 These are the **officially** supported platforms:
 

citadel/install_osx.md

@@ -16,7 +16,7 @@ brew install ignition-citadel
 
 All libraries should be ready to use and the `ign gazebo` app ready to be executed.
 
-Head back to the [Getting started](/docs/all/getstarted)
+Head back to the [Getting started](getstarted)
 page to start using Ignition!
 
 ## Uninstalling binary install
@@ -30,4 +30,4 @@ brew uninstall ignition-citadel
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting#macos)
+See [Troubleshooting](troubleshooting.md#macos)

citadel/install_osx_src.md

@@ -232,7 +232,7 @@ Or in zsh:
 . ~/workspace/install/setup.zsh
 ```
 
-This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted)
+This is the end of the source install instructions; head back to the [Getting started](getstarted)
 page to start using Ignition!
 
 ## Uninstalling source-based install
@@ -248,4 +248,4 @@ sudo make uninstall
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting#macos)
+See [Troubleshooting](troubleshooting.md#macos)

citadel/install_ubuntu.md

@@ -23,7 +23,7 @@ sudo apt-get install ignition-citadel
 
 All libraries should be ready to use and the `ign gazebo` app ready to be executed.
 
-Head back to the [Getting started](/docs/all/getstarted)
+Head back to the [Getting started](getstarted)
 page to start using Ignition!
 
 ## Uninstalling binary install
@@ -37,4 +37,4 @@ sudo apt remove ignition-citadel && sudo apt autoremove
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting#ubuntu)
+See [Troubleshooting](troubleshooting.md#ubuntu)

citadel/install_ubuntu_src.md

@@ -217,7 +217,7 @@ Or in zsh:
 . ~/workspace/install/setup.zsh
 ```
 
-This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted)
+This is the end of the source install instructions; head back to the [Getting started](getstarted)
 page to start using Ignition!
 
 ## Uninstalling source-based install
@@ -242,4 +242,4 @@ the results you want:
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting#ubuntu)
+See [Troubleshooting](troubleshooting.md#ubuntu)

citadel/install_windows.md

@@ -82,4 +82,4 @@ conda uninstall libignition-<package_name> --channel conda-forge
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting)
+See [Troubleshooting](troubleshooting)

citadel/install_windows_src.md

@@ -116,7 +116,7 @@ Run the following command to source the workspace:
 call install\setup.bat
 ```
 
-This is the end of the source install instructions; head back to the [Getting started](/docs/all/getstarted)
+This is the end of the source install instructions; head back to the [Getting started](getstarted)
 page to start using Ignition!
 
 ## Uninstalling source-based install
@@ -142,4 +142,4 @@ the results you want:
 
 ## Troubleshooting
 
-See [Troubleshooting](/docs/citadel/troubleshooting)
+See [Troubleshooting](troubleshooting)

citadel/ros2_integration.md

@@ -10,7 +10,7 @@ from ROS and apply it to Ignition and vice versa.
 
 ## Requirements
 
-Please follow the [Install Gazebo and ROS document](docs/latest/ros_installation)
+Please follow the [Install Gazebo and ROS document](ros_installation)
 before starting this tutorial. A working installation of ROS 2 and Gazebo is
 required to go further.
 

citadel/tutorials.md

@@ -24,23 +24,23 @@ These tutorials cover general concepts to help get you started with Ignition.
 
 ## Per-library tutorials
 
-See the *API & Tutorials* sections on the [Libraries page](/libs) page for more specific content correlating to each Gazebo library.
+See the *API & Tutorials* sections on the [Libraries page](/libs){.external} page for more specific content correlating to each Gazebo library.
 
 The entrypoint library is Sim.
-- [Sim](/api/sim/3/tutorials.html)
+- [Sim](/api/sim/3/tutorials.html){.external}
 
 Other libraries:
-- [Cmake](/api/cmake/2/tutorials.html)
-- [Common](/api/common/3/tutorials.html)
-- [Fuel_tools](/api/fuel_tools/4/tutorials.html)
-- [Gui](/api/gui/3/tutorials.html)
-- [Launch](/api/launch/2/tutorials.html)
-- [Math](/api/math/6/tutorials.html)
-- [Msgs](/api/msgs/5/tutorials.html)
-- [Physics](/api/physics/2/tutorials.html)
-- [Plugin](/api/plugin/1/tutorials.html)
-- [Rendering](/api/rendering/3/tutorials.html)
-- [Sensors](/api/sensors/3/tutorials.html)
-- [Tools](/api/tools/1/tutorials.html)
-- [Transport](/api/transport/8/tutorials.html)
-- [Sdformat](/api/sdformat/9/)
+- [Cmake](/api/cmake/2/tutorials.html){.external}
+- [Common](/api/common/3/tutorials.html){.external}
+- [Fuel_tools](/api/fuel_tools/4/tutorials.html){.external}
+- [Gui](/api/gui/3/tutorials.html){.external}
+- [Launch](/api/launch/2/tutorials.html){.external}
+- [Math](/api/math/6/tutorials.html){.external}
+- [Msgs](/api/msgs/5/tutorials.html){.external}
+- [Physics](/api/physics/2/tutorials.html){.external}
+- [Plugin](/api/plugin/1/tutorials.html){.external}
+- [Rendering](/api/rendering/3/tutorials.html){.external}
+- [Sensors](/api/sensors/3/tutorials.html){.external}
+- [Tools](/api/tools/1/tutorials.html){.external}
+- [Transport](/api/transport/8/tutorials.html){.external}
+- [Sdformat](/api/sdformat/9/){.external}

conf.py

@@ -111,8 +111,12 @@ def config_init(app: Sphinx, config: Config):
 
     try:
         releases = load_releases(config.gz_root_index_file)
-        app.config.html_context["release_info"] = releases[config.gz_release]
+        release_info = releases[config.gz_release]
+        app.config.html_context["release_info"] = release_info
         app.config.html_context["preferred_release"] = get_preferred_release(releases)
+        if release_info.get('eol', False):
+            print(f"Disable nitpicky for {release_info['name']}")
+            app.config.nitpick_ignore_regex.append(("myst", r".*"))
 
     except KeyError as e:
         print(e)