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

Open all external links in a new tab/window #7048

Open
cwarnermm opened this issue Apr 8, 2024 · 4 comments · May be fixed by #7540
Open

Open all external links in a new tab/window #7048

cwarnermm opened this issue Apr 8, 2024 · 4 comments · May be fixed by #7540
Assignees
Labels
Acknowledged/Docs team Issue acknowledged by Docs team, next step pending Help Wanted Community help wanted

Comments

@cwarnermm
Copy link
Member

cwarnermm commented Apr 8, 2024

We're already doing this via the developer docs; good approach to consistency.

To do: Identify syntax needed for both RST and MD.

@cwarnermm cwarnermm assigned cwarnermm and unassigned cwarnermm Apr 8, 2024
@cwarnermm cwarnermm changed the title Open external links in a new tab/window Open all external links in a new tab/window Apr 8, 2024
@cwarnermm cwarnermm added the Acknowledged/Docs team Issue acknowledged by Docs team, next step pending label Apr 8, 2024
@cwarnermm
Copy link
Member Author

cwarnermm commented Apr 8, 2024

In addition, revisit all external link syntax to ensure trailing underlines are specified correctly as per Sphinx requirements:

  • single trailing underline _: reference is named and the same target URI may be referred to elsewhere site-wide.
  • double training underline __: reference and target are both anonymous, can't refer to the target elsewhere site-wide

Better to default to single trailing underline to avoid warning.log error: WARNING: Duplicate target name, cannot be used as a unique reference: "thing".

@rahulmansharamani14
Copy link

Hi @cwarnermm, Is there anyone working on this? If not, I'd like to give it a try.

@cwarnermm
Copy link
Member Author

Thanks, @rahulmansharamani14!

@rahulmansharamani14
Copy link

Hi @cwarnermm,

I've submitted a PR [#7540] that addresses the first part of this issue. Specifically, the PR ensures that all external links in the reStructuredText (RST) files open in a new tab/window.

I wanted to let you know that I'm aware the Markdown (MD) files still need to be updated to achieve consistency across the documentation.

Additionally, I will be working on revisiting all external link syntax to ensure trailing underscores are specified correctly, as per the Sphinx requirements:

  • Using single trailing underscores _ for named references.
  • Avoiding double trailing underscores __ to prevent duplicate target warnings.

I'm looking forward to any feedback on the current PR and will be happy to make any necessary changes.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Acknowledged/Docs team Issue acknowledged by Docs team, next step pending Help Wanted Community help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants