# custom paraview module - How to generate embedded doc

**URL:** https://discourse.paraview.org/t/custom-paraview-module-how-to-generate-embedded-doc/2686
**Category:** Development
**Created:** [October 3, 2019, 7:16pm UTC](https://discourse.paraview.org/t/custom-paraview-module-how-to-generate-embedded-doc/2686 "2019-10-03T19:16:24Z")
**Posts on this page:** 3
**Page:** 1

<div class="post-metadata">

### Author: ![michal.wozniak](https://discourse.paraview.org/letter_avatar_proxy/v4/letter/m/848f3c/32.png) [@michal.wozniak](https://discourse.paraview.org/u/michal.wozniak)
#### Post date: [October 3, 2019, 7:16pm UTC](https://discourse.paraview.org/t/custom-paraview-module-how-to-generate-embedded-doc/2686/1 "2019-10-03T19:16:24Z")

</div>

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

---

<div class="post-metadata">

### Author: ![ben.boeckel](https://discourse.paraview.org/letter_avatar_proxy/v4/letter/b/ea5d25/32.png) [@ben.boeckel](https://discourse.paraview.org/u/ben.boeckel)
#### Post date: [October 17, 2019, 1:38pm UTC](https://discourse.paraview.org/t/custom-paraview-module-how-to-generate-embedded-doc/2686/2 "2019-10-17T13:38:32Z")

</div>

This can be done with:

```auto
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.

---

<div class="post-metadata">

### Author: ![michal.wozniak](https://discourse.paraview.org/letter_avatar_proxy/v4/letter/m/848f3c/32.png) [@michal.wozniak](https://discourse.paraview.org/u/michal.wozniak)
#### Post date: [October 17, 2019, 7:21pm UTC](https://discourse.paraview.org/t/custom-paraview-module-how-to-generate-embedded-doc/2686/3 "2019-10-17T19:21:32Z")

</div>

thank you !
