Sphinx logo

Previous topic

sphinx.ext.viewcode – ハイライト済みのソースコードへのリンクを追加

Next topic

Sphinx FAQ

This Page

sphinx.ext.oldcmarkup 古いC言語向けマークアップとの互換性維持

Module author: Georg Brandl

New in version 1.0.

この拡張機能は、 cfunction ディレクティブや、 cfunc ロールなどの古いC言語のマークアップを利用しているプロジェクトの移行を手助けします。ドメインが導入されて、これらは完全修飾名の c:functionc:func などの名前にするか、デフォルトのドメインを c に設定し、新しい名前(function, func)を使用するように変更しなければなりません。

この拡張機能を有効にすると、Sphinx 1.0以前で使用されていた古い名前を登録します。追加されるディレクティブは次の通りです:

  • cfunction
  • cmember
  • cmacro
  • ctype
  • cvar

追加されるロールには次のようなものがあります:

  • cdata
  • cfunc
  • cmacro
  • ctype

しかし、新しいマークアップへの移行をおすすめします。この拡張機能は互換性の維持のために一時的に追加されたモノで、将来のバージョンのSphinxでは削除されます。