10

私はsphinxとRSTを使用して技術ドキュメントを HTML として生成していますが、ローカルの PDF 参照をハイパーリンクとして機能させるのに問題があります。ローカル PDF へのリンクを使用している人を見てきましたが、参照用にディレクトリ:download:内に PDF を埋め込んでいます。ブラウザーにインラインで PDF が表示されないため、ユーザーが消費するために追加の手順が必要になるため、/docs私は好きではありません。:download:

sphinx-build -b htmlconfig.pyhookhtml_static_pathまたはhtml_extra_path- で指定されていない限りファイルをコピーせず、その場合でもrootディレクトリまたは_staticフォルダーにドロップされます。

リンクされたバイナリ ファイルを sphinx 内に埋め込むための推奨される方法はありますか、それとも不適切な方法ですか? 多くの場合、リンクは、他のどこにもホストされていないスライド デッキまたは設計図へのリンクです。

リンクされた PDF のサンプル RST

.. important:: View the agile course on scrum basics

    - View `these slides to dive deeper into Agile Basics <docs/agile-101.pdf>`_.
4

1 に答える 1

11

私が思いついた解決策は、PDF を追加して、ソース内のパスではなく、リンク内html_static_pathの出力パスを参照することでした。PDF をダウンロードして表示するのではなく、ブラウザで開くようになりました。_staticdocs

これを処理するためのスフィンクス拡張/ディレクティブがあれば素晴らしいでしょう ( :download-inline:)。

conf.py

html_static_path = ['_static', 'agile-101/docs']

アジャイル-101.rst

.. important:: View the agile course on scrum basics

- View `these slides to dive deeper into Agile Basics <../_static/agile-101.pdf>`_.
于 2016-07-29T14:29:13.580 に答える