custom paraview module - How to generate embedded doc

Development
1

Hi,

I created a new vtk module and I used the following function to append my filters.xmls

set(classes
  testClass  
)    

set(xml_files
  Resources/test_filters.xml)    

vtk_module_add_module(ParaView::TestModule
  CLASSES ${classes})    

paraview_add_server_manager_xmls(
    XMLS  ${xml_files})

The filters appear in ParaView but how do I generate the “embedded documentation”

A plugins generate the doc using the {project}_doc & {project}_qch projects

2

This can be done with:

paraview_client_documentation(
  TARGET mymodule_doc
  XMLS ${xml_files})

I suppose this actually makes more sense to be part of ParaViewServerManager.cmake, but it lives in the client CMake API for now. That call ends up making a bunch of .html files you can bundle up however you want. The paraview_client_generate_help function is provided for clients to make Qt help resources.

3

thank you !