nikkie-ftnextの日記

イベントレポートや読書メモを発信

外部リンクにアイコンを添えて表示できる設定値をサポートした sphinx-new-tab-link 0.5.0 をリリースしました🦋

Sphinx

リリース報告エントリです。
「sphinx-new-tab-linkとはなんだろう」という方は、以下の記事をまずどうぞ！

目次

設定値new_tab_link_show_external_link_iconをサポートしました。
https://github.com/ftnext/sphinx-new-tab-link/releases/tag/v0.5.0

ブラウザの新しいタブで開くリンクにアイコンを添える

new_tab_link_show_external_link_iconのデフォルト値はFalseです。

この設定値をTrueにしてHTMLをビルドすると、外部リンクであることを示すアイコンが表示されます。
このアイコンが表示されているリンクは、（sphinx-new-tab-linkの力により）ブラウザの新しいタブで開きます。

英語のガイドは同じサイトのリンクなのでアイコンなし、リンク集は外部サイトのリンクなのでアイコンありという出し分けです。

実装過程

きっかけはこちらのissue

So that the user immediately understands that the link leads to an external resource. (comment)

1日1エントリを使いながら進めました。

sphinx-designの:octicon:ロールの実装は非常に参考になりました。感謝です

終わりに

sphinx-new-tab-link 0.5.0のリリース報告でした。
ミリシタ7周年の日にリリースできたのがプチ嬉しいです。

「SphinxでビルドしたHTMLの中の外部リンクをブラウザの新しいタブで開きたい」方はよろしければお試しください（pip install sphinx-new-tab-link）。
今月のPython Monthly TopicsはSphinxで静的サイトを作る話題ですが、そのようなシーンで私が欲しくて自作したのがsphinx-new-tab-linkです。

触ってみた感想や、今回のような「こういうユースケースで使いたいんだけどサポートしてくれないか」といった要望、そしてリポジトリへのスターも、お待ちしています！

応援ください！