spns #19079: Top-ii-vol integration in SMESH

[modules/smesh.git] / src / Tools / TopIIVolMeshPlug / doc / index.rst

diff --git a/src/Tools/TopIIVolMeshPlug/doc/index.rst b/src/Tools/TopIIVolMeshPlug/doc/index.rst
new file mode 100644 (file)
index 0000000..3cd2379
--- /dev/null
+++ b/src/Tools/TopIIVolMeshPlug/doc/index.rst
@@ -0,0 +1,22 @@
+.. TopIIVolMesh documentation master file, created by sphinx-quickstart.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+topIIvol plugin documentation
+=====================================
+
+This documentation covers the usage of **top-ii-vol** as plug-in in SALOME that can be used within the SALOME
+Mesh module.
+
+TopIIVolMesh plug-in uses CEA **top-ii-Vol** meshing tool,which provides sequential/parallel tools for creating volumetric tetrahedral meshes from a given topology.
+This plug-in offers only the most common functionalities of the tool.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   TopIIVolMesh.rst
+
+
+