python-sphinx - ReadTheDocs テーマで Read The Docs と Sphinx を使用している場合、[Edit on Github] リンクを削除する

Question

Sphinx で _template overrides オプションを使用して、 http://readthedocs.orgで Sphinx ドキュメントをホストするためのデフォルトの ReadTheDocs テーマをオーバーライドする方法を見つけようとしています。

具体的には、このテーマの右上隅に表示されている「Github で編集」リンクを削除/非表示にしたいと考えています。

どんなヒントでも大歓迎です！ありがとう！

http://www.sphinx-doc.org/en/stable/templating.htmlのドキュメントを確認しましたが、困惑しており、本当に助けが必要です。

ありがとうございました！

Answer 1

さて、私はそれを理解したので、他の人を助けることを期待して、私自身の質問に答えます.

ReadTheDocs のデフォルト テーマを使用していると仮定すると、これは問題なく動作するはずです。

• ReadTheDocs テーマを Github リポジトリからコンピューターに複製します。( https://github.com/snide/sphinx_rtd_theme/ )
• ファイルを見つけbreadcrumbs.htmlます ( https://github.com/snide/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/breadcrumbs.html )
• breadcrumbs.htmlフォルダー内の Sphinx ドキュメント フォルダーにファイルを追加し_templatesます。このディレクトリがまだ存在しない場合は、作成する必要があります。

• conf.pyファイルでセクションを見つけます。html_contextこれがまだない場合は、作成できます。(サンプルは下にリンクされています)。

  html_context = { "display_github": False, # Add 'Edit on Github' link instead of 'View page source' "last_updated": True, "commit": False, }

• breadcrumbs.htmlを使用して追跡ファイルにファイルを追加しますGit

• 変更をコミットしますconf.py
• リモート Github リポジトリにプッシュする
• 利益

参考文献

• https://github.com/duelingdogs/dueling-docs/blob/master/source/conf.py#L36-L40
• http://help.duelingdogs.net/en/latest/ (Edit on Githubオプションが削除されたことを示す例。