2016-03-30 13 views
0

私は私のプロジェクトのいずれかのスフィンクスドキュメントを使用してドキュメントを作成していると私は、例えば、全体のdocに何回にいくつかの単語を使用しています - IPアドレス、ポート番号および時間に変更される可能性があり、他の多くのもの。なんらかの理由で変更された場合は、すべてのファイルを手動で変更するのではなく、1か所で簡単に変更したいと考えています。私が探しているのは、すべての.rstファイルから簡単にアクセスできる、ある種のリソースファイル/変数を作成する簡単な方法です。Sphinxのドキュメント変数

私はthis 1が見つかりました:

my_config_value = 'test' 
rst_epilog = '.. |my_conf_val| replace:: %s' % my_config_value 

それはほぼ完璧だが、私は多くの変数を持っていると思います。上記の方法を使用すると、私は1つしか使用できません。これでは十分ではありません。

また、私はsphinx.ext.extlinksを使用する方法を発見しました。それは働いていますが、私が欲しかったのとまったく同じではありません。私は私のconf.pyでこれを使用しています:

extlinks = {'test': ('bla_bla_bla', None)} 

そして、いくつかの.rstに:

:test:`1` 

結果にbla_bla_bla1

まず、これはどこにハイパーリンクです。第二に、私は書くことができないので、

またはさらには:test:と書くことはできません。

そして、私の質問があり来る:全体ドキュメントで使用できる変数を作成するための任意の簡単な方法は、ありますか?

+0

'rst_epilog'に複数の置換を指定することができます。例:http://stackoverflow.com/a/26258989/407651 – mzjn

+0

はい、これは私が探しているものですが、見つけられませんでした。ご協力いただきありがとうございます! –

答えて

5

ありがとうmzjn私は私の質問の正確な答えを見つけました。将来誰かがそれを検索すると、私は以下の答えを残しました。ちょうど使用私の.rstで

address = '192.168.1.1' 
port = 'port 3333' 

rst_prolog = """ 
.. |address| replace:: {0} 
.. |port| replace:: {1} 
""".format(
address, 
port 
) 

そして:

|address| - |port| 

結果192.168.1.1 - port 3333と私のconf.py

は、私はこれを追加しました。これはまさに私が必要としていたものです。ありがとうございましたmzjn

関連する問題