sphinxcontrib-タグリストは、スフィンクス「タグリスト」を拡張したものです。
タグリストのの
タグリストは、スフィンクスドキュメンテーションシステムの拡張です。
<強い>インストールの
PIPを通してインスタレーション:
sphinxcontrib-タグリストをインストールピップ
またはGitHubの経由:
gitのクローンhttps://github.com/spinus/sphinxcontrib-taglist
CDのsphinxcontrib-タグリスト
Pythonはsetup.py installを
次に、あなたのスフィンクスのプロジェクトの「conf.py」に拡張子を追加する必要があります。
拡張= [
&NBSP; ...、
&NBSP; 'sphinxcontrib.taglist」、
&NBSP; ...]
のコンフィグレーションの
この拡張子のタグを使用する場合は、各タグの他の色を与える場合があります。あなたが追加することによって、「conf.py」でその操作を行うことができます。
taglist_tags = {
&NBSP; 'TAG1':{'背景色': '緑'}
}
ディレクティブ
タグ:
&NBSP;タグディレクティブは、情報の「作品」を追加し、あなたはそれにタグを付けることができます。
&NBSP;あなたが好きそれを使用することができます。
&NBSP; ..タグ::いくつかのタグ付けされた情報
&NBSP;タグ:TAG1のTAG2のTAG3
&NBSP;または:
&NBSP; ..タグ:: [TAG1のTAG2のタグ3]いくつかのタグ付けされた情報
<強い>
&NBSP;警告:の第二の方法は、最初の方法ではない場合にのみ使用されます。
<強い>&NBSP;警告:の私はこの構文を確認していない、それが変更されることがあります。あなたはアニーの提案があれば私に知らせてください。
タグリスト:
&NBSP;タグリストはタグをキャッチし、リストを行う指令がある。
&NBSP;第一に、それは「タグ:... '出力し、それが表示され、それはリストが表示さよりも、タグの情報を。
&NBSP;あなたが好きそれを使用することができます。
&NBSP; ..タグリスト::
&NBSP;タグ:タグ1のTAG3
それがどのように動作?
それは同じように動作しますので、コードベースはsphinxcontrib-要件から導出されます。
原稿読取タグディレクティブ中にtag_node`sを作成します。 `タグリストはタグリストのノードを作成します。
タグリストのノードを解決する時には、テキストタグの片に変更されます。そのリストに表示されたタグ項目と。次に、すべてのタグ付けされた項目を印刷します。
CSS
taglist.css:
&NBSPは、それはタグの基底クラスが含まれている - taglist_tagを
<強い>
&NBSP;警告:のそれはおそらく変更され、taglist_tags.cssに入れられます。 (そして、それはconf.pyから設定可能になります)
(; taglist_tagsは、CSSキーにすべてのタグのキーをマッピングしますconf.pyで定義された各タグのCSSを使用した)と静的ファイルにディレクトリを構築するためにそれを書く。
さらに、それは、処理中にファイルtaglist_tags.cssを作成します。 の要件の
- のPythonます。
- スフィンクスます。
コメントが見つかりません