1

Sphinxで作成されたドキュメントプロジェクトがあります。私は設定キーrst_epilogによってグローバル変数を使用しています。スフィンクスで変数置換が正しく機能しない

rst_epilog = """ 
.. |MY_VERSION| replace:: 2.1.0 
""" 

すると、次のように最初のページに、私は以前定義された変数(VERSION)を使用しています:私conf.pyファイルには、以下が含まれてい

The version of my repo is: |MY_VERSION| 

.. sourcecode:: bash 

    git clone https://github.com/my-organization/my-repo.git 
    cd my-repo 
    git checkout |MY_VERSION| 

結果で、ドキュメントを構築した後HTMLの場合、最初の変数は正しく置換されますが、2番目の変数は正しく置換されません。 enter image description here

明らかに、置換はフォーマットされたソースコードブロック内では機能しません便利。

この問題を回避することはできますか?

PS:私もrst_prologと同じ結果を出しました。

+1

'parsed-literal'を試してください。 http://docutils.sourceforge.net/docs/ref/rst/directives.html#parsed-literal-blockを参照してください – mzjn

+0

はい、どうもありがとうございました! 'parsed-literal'と' sourcecode'を組み合わせることが可能かどうか知っていますか? –

+0

いいえ、あなたはそれらを組み合わせることはできません。 – mzjn

答えて

2

これは、置換作業になります。parsed-literalディレクティブで

.. parsed-literal:: 

    git clone https://github.com/my-organization/my-repo.git 
    cd my-repo 
    git checkout |MY_VERSION| 

を、あなたは、置換(および他のインラインマークアップ)を持つことができますが、何のシンタックスハイライトはありません。

code-block(またはsourcecodeまたはhighlight)を使用すると、構文の強調表示ができますが、インラインマークアップは処理されません。

関連する問題