検索エンジン(および他のユーザー)に見つけてもらえるよう、ドキュメントを最適化する。

もし、より多くの人にあなたのパッケージを見つけてもらいたいのであれば、Sphinxのコアとなる拡張機能(およびテーマの設定)を追加することで、Googleなどの検索エンジンがあなたのドキュメントを見つけやすくすることができます。

Google アナリティクス

重要

Googleアナリティクスは 欧州一般データ保護規則（GDPR）に準拠していません 。この規制には多くの要素があるが、核となる要素のひとつは、データを収集していることをサイト上でユーザーに知らせ、同意を得なければならないということです。Googleアナリティクスの周辺にインフラを追加してGDPRの規制に沿うようにすることは可能ですが、コミュニティは徐々にGoogleから Plausible 、 Cloudflare Web Analytics 、 Matomo といったオープンツールをウェブ解析に使う方向にシフトしつつあります。

pyOpenSci は現在、オープンソース開発者のための無料のオプションを検討しています。

pydata-sphinx-themeや sphinx-book-theme のようなsphinxテーマには、Google Analyticsのサポートが組み込まれています 。しかし、もしあなたが選んだテーマがGoogle Analyticsをサポートしていない場合は、 sphinxcontrib-gtagjs` extension を使うことができます。 このエクステンションは、Google Analyticsのサイトタグをドキュメントの各ページに追加します。

検索エンジン最適化のための sphinx-sitemap

コンプライアンスやプライバシーの問題からGoogleアナリティクスから離れようとしていますが、検索エンジン最適化は依然として重要です。 Googleは最も人気のある検索エンジンです。 そして、もしあなたのドキュメントが検索に最適化されていれば、ユーザーはあなたのパッケージを見つける可能性が高くなります!

Googleのような検索エンジンのために文書を最適化することに興味があるなら、 sitemap.xml ファイルが必要です。 このサイトマップをGoogleに送信すると、Googleはあなたのサイト全体をインデックスします。 このサイトマップをGoogleに送信することで、サイト全体がインデックスされ、サイト内のコンテンツが検索されやすくなります。

このエクステンションは軽量です。

これは、 Sphinxの conf.py 拡張機能リストに追加し、ドキュメントのベースURLを指定する必要があります 。

sphinxext.opengraph

OpenGraph is an extension that allows you to add metadata to your documentation content pages. The OpenGraph protocol allows other websites to provide a useful preview of the content on your page when shared. This is important for when the pages in your documentation are shared on social media sites like Twitter and Mastodon and even for shares on tools like Slack and Discourse.