Sphinx VTK Role

Sphinx VTK Role#

Added in version 0.46.

PyVista’s documentation uses the Sphinx extension pyvista/vtk-xref to link directly to VTK’s documentation.

This extension adds the :vtk: role to allow writing, for example, :vtk:`vtkImageData` inside docstrings to link directly to the vtkImageData documentation. This will render as vtkImageData.

See vtk-xref’s repository for installation and usage details for adding the :vtk: role to your project.