Sphinx VTK Role

Sphinx VTK Role#

Added in version 0.46.

PyVistaのドキュメントでは、 VTK's documentation に直接リンクするためにSphinx拡張 pyvista/vtk-xref を使用しています。

この拡張は :vtk: ロールを追加し、例えば :vtk:`vtkImageData を docstring の中に記述することで、 vtkImageData ドキュメントに直接リンクできるようにします。 これは vtkImageData としてレンダリングされます。

プロジェクトに :vtk: ロールを追加するためのインストールと使い方の詳細は vtk-xref のリポジトリ を参照してください。