Merge pull request #195 from alxbilger/scenecheckgen

Generate the list of SceneCheck

Author: hugtalbot

.github/workflows/doc.yml

@@ -68,8 +68,10 @@ jobs:
           pip install gitpython
           pip install requests
           python ${{ github.workspace }}/SofaDocGenerator/script/pipeline.py ${{ github.workspace }}/SofaDocGenerator/doc ${{ github.workspace }}/sofa/share/sofa/examples ${{ github.workspace }}/sofa/plugins
-          
+
           python ${{ github.workspace }}/SofaDocGenerator/script/title_metadata.py ${{ github.workspace }}/SofaDocGenerator/doc
+          
+          python ${{ github.workspace }}/SofaDocGenerator/script/scene_check.py ${{ github.workspace }}/SofaDocGenerator/doc/15_Using_SOFA/10_SceneChecking.md
 
           echo "Starting the export of plugin lists"
           # Export plugin lists into the merged doc

script/scene_check.py

@@ -0,0 +1,27 @@
+"""
+Append the table composed of the list of SceneCheck to a file
+"""
+
+import sys
+
+def main():
+
+    if len(sys.argv) < 2:
+        print('Usage: scene_check.py <output_file>')
+        exit(1)
+
+    import Sofa
+    import SofaRuntime
+
+    SofaRuntime.importPlugin("SceneChecking")
+
+    table = "| Name | Description |\n"
+    table += "| ---- | ----------- |\n"
+    for scene_check in Sofa.Simulation.SceneCheckMainRegistry.getRegisteredSceneChecks():
+        table += f"| {scene_check.getName()} | {scene_check.getDesc()} |\n"
+
+    with open(sys.argv[1], 'a', encoding="utf-8") as output_file:
+        output_file.write(table)
+
+if __name__ == '__main__':
+    main()