7

を使用して新しいプロジェクトのドキュメントを書いていますSphinx

ただし、このプロジェクトは新しいため、名前が変更される可能性があり、すべてのドキュメントで「プロジェクト名」のすべての参照を置き換えたくありません。

それで、それを行うために変数/定数を置く方法があるかどうか知りたいですSphinx

i18nに機能があることはわかっているSphinxので、gettext を使用して「プロジェクト名」を他に何も変更せずに変更できます。しかし、私はそれを行う適切な方法を探しています。

4

2 に答える 2

8

プロジェクト名はsphinx、構成値を使用して参照されます。sphinx-quickstartを使用して xyour プロジェクトを作成する場合は、プロジェクトの名前を尋ねられますsphinx。プロジェクト名は、後で変更することで変更できprojectます。conf.py

.rstで定義することにより、ファイルで構成値を使用できます(例については、この回答conf.pyを参照してください)。rst_epilog

于 2013-03-01T08:51:52.907 に答える
7

スフィンクスのドキュメントから:

reST は「置換」( ref ) をサポートしています。これは、 によってテキスト内で参照されるテキストおよび/またはマークアップの一部です|name|。これらは、次のように、明示的なマークアップ ブロックを含む脚注のように定義されます。

.. |name| replace:: replacement *text*

またはこれ:

.. |caution| image:: warning.png
         :alt: Warning!

詳細については、置換の reST リファレンスを参照してください。

すべてのドキュメントにいくつかの置換を使用する場合は、ディレクティブを使用して、それらを別のファイルに入れるか、別のファイルに入れ、それらを使用するすべてのドキュメントに含めますrst_prolog。(インクルード ファイルには、他のソース ファイルとは異なるファイル名拡張子を付けて、Sphinx がそれをスタンドアロン ドキュメントとして検出しないようにしてください。)rst_epiloginclude

「プロジェクト変数」を追加して、rst_prolog置換を使用します。

于 2013-03-02T12:06:01.020 に答える