From 83d13ee7b553bbf25d6b5bac2fee0eb3811cd726 Mon Sep 17 00:00:00 2001 From: jremitz Date: Thu, 2 Apr 2026 09:55:40 -0500 Subject: [PATCH] fix: Read the Docs example links not navigating Rename docs/examples/ wrapper files to match the example filenames (01-getting-started.md, 02-configuration.md, etc.) so relative links in {include}d content resolve correctly in Sphinx. Co-Authored-By: Claude --- CHANGELOG.md | 5 +++++ ...tting-started.md => 01-getting-started.md} | 0 .../{configuration.md => 02-configuration.md} | 0 ...arting-a-game.md => 03-starting-a-game.md} | 0 ...nd-events.md => 04-segments-and-events.md} | 0 ...ering-shorts.md => 05-rendering-shorts.md} | 0 ...nd-reels.md => 06-highlights-and-reels.md} | 0 ...tions.md => 07-profiles-and-iterations.md} | 0 ...eanup.md => 08-game-finish-and-cleanup.md} | 0 docs/examples/{plugins.md => 09-plugins.md} | 0 .../{smart-zoom.md => 10-smart-zoom.md} | 0 docs/examples/index.md | 20 +++++++++---------- reeln/__init__.py | 2 +- 13 files changed, 16 insertions(+), 11 deletions(-) rename docs/examples/{getting-started.md => 01-getting-started.md} (100%) rename docs/examples/{configuration.md => 02-configuration.md} (100%) rename docs/examples/{starting-a-game.md => 03-starting-a-game.md} (100%) rename docs/examples/{segments-and-events.md => 04-segments-and-events.md} (100%) rename docs/examples/{rendering-shorts.md => 05-rendering-shorts.md} (100%) rename docs/examples/{highlights-and-reels.md => 06-highlights-and-reels.md} (100%) rename docs/examples/{profiles-and-iterations.md => 07-profiles-and-iterations.md} (100%) rename docs/examples/{game-finish-and-cleanup.md => 08-game-finish-and-cleanup.md} (100%) rename docs/examples/{plugins.md => 09-plugins.md} (100%) rename docs/examples/{smart-zoom.md => 10-smart-zoom.md} (100%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6591099..acac079 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/), and this project adheres to [Semantic Versioning](https://semver.org/). +## [0.0.36] - 2026-04-02 + +### Fixed +- Read the Docs example page links now navigate correctly (renamed wrapper files to match example filenames) + ## [0.0.35] - 2026-04-02 ### Added diff --git a/docs/examples/getting-started.md b/docs/examples/01-getting-started.md similarity index 100% rename from docs/examples/getting-started.md rename to docs/examples/01-getting-started.md diff --git a/docs/examples/configuration.md b/docs/examples/02-configuration.md similarity index 100% rename from docs/examples/configuration.md rename to docs/examples/02-configuration.md diff --git a/docs/examples/starting-a-game.md b/docs/examples/03-starting-a-game.md similarity index 100% rename from docs/examples/starting-a-game.md rename to docs/examples/03-starting-a-game.md diff --git a/docs/examples/segments-and-events.md b/docs/examples/04-segments-and-events.md similarity index 100% rename from docs/examples/segments-and-events.md rename to docs/examples/04-segments-and-events.md diff --git a/docs/examples/rendering-shorts.md b/docs/examples/05-rendering-shorts.md similarity index 100% rename from docs/examples/rendering-shorts.md rename to docs/examples/05-rendering-shorts.md diff --git a/docs/examples/highlights-and-reels.md b/docs/examples/06-highlights-and-reels.md similarity index 100% rename from docs/examples/highlights-and-reels.md rename to docs/examples/06-highlights-and-reels.md diff --git a/docs/examples/profiles-and-iterations.md b/docs/examples/07-profiles-and-iterations.md similarity index 100% rename from docs/examples/profiles-and-iterations.md rename to docs/examples/07-profiles-and-iterations.md diff --git a/docs/examples/game-finish-and-cleanup.md b/docs/examples/08-game-finish-and-cleanup.md similarity index 100% rename from docs/examples/game-finish-and-cleanup.md rename to docs/examples/08-game-finish-and-cleanup.md diff --git a/docs/examples/plugins.md b/docs/examples/09-plugins.md similarity index 100% rename from docs/examples/plugins.md rename to docs/examples/09-plugins.md diff --git a/docs/examples/smart-zoom.md b/docs/examples/10-smart-zoom.md similarity index 100% rename from docs/examples/smart-zoom.md rename to docs/examples/10-smart-zoom.md diff --git a/docs/examples/index.md b/docs/examples/index.md index 1fe72f6..9cd9191 100644 --- a/docs/examples/index.md +++ b/docs/examples/index.md @@ -6,14 +6,14 @@ self-contained — start from the top or jump to whatever fits your use case. ```{toctree} :maxdepth: 1 -getting-started -configuration -starting-a-game -segments-and-events -rendering-shorts -highlights-and-reels -profiles-and-iterations -game-finish-and-cleanup -plugins -smart-zoom +01-getting-started +02-configuration +03-starting-a-game +04-segments-and-events +05-rendering-shorts +06-highlights-and-reels +07-profiles-and-iterations +08-game-finish-and-cleanup +09-plugins +10-smart-zoom ``` diff --git a/reeln/__init__.py b/reeln/__init__.py index eadb412..348a069 100644 --- a/reeln/__init__.py +++ b/reeln/__init__.py @@ -2,4 +2,4 @@ from __future__ import annotations -__version__ = "0.0.35" +__version__ = "0.0.36"