2017-03-14 11 views
0

私はドキュメントのためにSphinxツールを使用していて、1つのファイルフォーマットで情報を公開したいという状況に遭遇しました。
私はthis linkに遭遇しました。これは、唯一の指令の助けを借りて同様の問題に対処しています。私が直面していますスフィンクスでカスタムタグを追加する

問題は、私は私が生成する(自己を)構築のためのsetup.pyファイルを使用して、BuildDoc.runを実行しています

.. only:: xyz 

    ..directive :: 
    :maxdepth: 1 

    good_stuff 

カスタムタグでのみディレクティブを使用したいですhtmlファイル。私は何とかこのカスタムタグをsetup.pyファイルに渡したいと思う。私はこれをやろうとしましたが、setup.pyファイル内からアクセスタグオブジェクトを読み取ることができないようです。

def run(self): 
    self.builder = 'html' 
    *self.tags.add(xyz)* 
    BuildDoc.run(self) 
    self.zip("html.zip") 

私はconf.pyファイルにtags.add(「XYZ」)を追加した場合、それは常に私がやりたいことは、条件付きで私のsetup.pyファイルにこのタグを追加され、追加情報を公開します。
タグ情報をconf.pyファイルに渡すことによってmakeコマンドが同様のことをすると仮定していますが、どのように動作するのか分かりません。

答えて

0

sphinx-buildコマンドは-tオプションを受け入れます。これにより、onlyの条件で使用できるタグを指定できます。 sphinx-build --helpから

-t TAG   define tag: include "only" blocks with TAG 

だから、何か使用して:

sphinx-build -t xyz 

すると、.. only:: xyz条件付きインラインを使用できるようになります。


あなたが条件付きであなたのsetup.pyファイルにタグを適用したい場合、あなたはあなたがself.tags.add('xyz')かを含めるべきかどうかを決定するためのロジックを自分で書く必要があるだろうと私には思えます。

関連する問題