Skip to content

Add a compatibility target to stories#4582

Merged
happz merged 2 commits intoteemtee:mainfrom
LecrisUT:fix/sphinx-story-target
Feb 16, 2026
Merged

Add a compatibility target to stories#4582
happz merged 2 commits intoteemtee:mainfrom
LecrisUT:fix/sphinx-story-target

Conversation

@LecrisUT
Copy link
Copy Markdown
Member

Signed-off-by: Cristian Le <git@lecris.dev>
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @LecrisUT, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request addresses broken documentation links by implementing a compatibility layer within the Sphinx extension responsible for story rendering. By adding an alternative target format, the system can now correctly resolve both new and old link structures, ensuring that existing documentation references continue to work as expected without requiring manual updates to all external links.

Highlights

  • Documentation Link Compatibility: Introduced a compatibility target in the documentation generation logic to ensure older link formats remain functional.
  • Fixing Broken Links: Resolved issues with previously broken documentation links that used a different URL structure, specifically those pointing to /spec/plans/provision/ansible.
Changelog
  • docs/ext/tmt_domain/story.py
    • Added a compatibility target for documentation links to support older URL formats.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a compatibility target for story links to support older URL formats. The implementation is straightforward, but there's an edge case where the story name is just /, which could lead to an invalid empty ID for an HTML anchor. I've suggested a fix to handle this case by only adding the compatibility target if it's a non-empty string.

Comment thread docs/ext/tmt_domain/story.py
@happz happz added this to planning Feb 13, 2026
@github-project-automation github-project-automation Bot moved this to backlog in planning Feb 13, 2026
@happz happz moved this from backlog to review in planning Feb 13, 2026
Signed-off-by: Cristian Le <git@lecris.dev>
@happz happz added the documentation Improvements or additions to documentation label Feb 16, 2026
@therazix therazix moved this from review to merge in planning Feb 16, 2026
@happz
Copy link
Copy Markdown
Contributor

happz commented Feb 16, 2026

Documentation-only, merging.

@happz happz merged commit 954206b into teemtee:main Feb 16, 2026
18 checks passed
@github-project-automation github-project-automation Bot moved this from merge to done in planning Feb 16, 2026
@psss psss added this to the 1.68 milestone Feb 24, 2026
@LecrisUT LecrisUT deleted the fix/sphinx-story-target branch February 26, 2026 11:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: done

Development

Successfully merging this pull request may close these issues.

6 participants