Merge pull request #194 from sofa-framework/hugtalbot-patch-10

[GitHub] Add the SofaGLFW README to describe the new GUI

Author: bakpaul

script/pipeline.py

@@ -31,11 +31,11 @@ def onerror(func, path, exc_info):
 def download_guidelines_file(cloned_doc_folder):
     url = 'https://raw.githubusercontent.com/sofa-framework/sofa/master/GUIDELINES.md'
     response = requests.get(url)
-    contributing_filepath = os.path.join(cloned_doc_folder, "40_Programming_with_SOFA", "01_Guidelines.md")
+    guidelines_filepath = os.path.join(cloned_doc_folder, "40_Programming_with_SOFA", "01_Guidelines.md")
     if response.status_code == 200:
-        with open(contributing_filepath, 'wb') as file:
+        with open(guidelines_filepath, 'wb') as file:
             file.write(response.content)
-        print(f'File {contributing_filepath} downloaded successfully.')
+        print(f'File {guidelines_filepath} downloaded successfully.')
     else:
         print(f'Failed to download file. Status code: {response.status_code}')
 
@@ -52,6 +52,18 @@ def download_contributing_file(cloned_doc_folder):
         print(f'Failed to download file. Status code: {response.status_code}')
 
 
+def download_SofaGLFW_file(cloned_doc_folder):
+    url = 'https://raw.githubusercontent.com/sofa-framework/SofaGLFW/master/README.md'
+    response = requests.get(url)
+    sofaglfw_filepath = os.path.join(cloned_doc_folder, "15_Using_SOFA", "11_runSofa_with_ImGui.md")
+    if response.status_code == 200:
+        with open(sofaglfw_filepath, 'wb') as file:
+            file.write(response.content)
+        print(f'File {sofaglfw_filepath} downloaded successfully.')
+    else:
+        print(f'Failed to download file. Status code: {response.status_code}')
+
+
 if __name__ == "__main__":
     tmp_folder = os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "tmp")
 
@@ -68,8 +80,10 @@ def download_contributing_file(cloned_doc_folder):
                                    branch='master')
         print("Finished to clone the doc...")
 
+    # Download and include pages as doc pages : GUIDELINES.md, CONTRIBUTING.md, README.md
     download_guidelines_file(cloned_doc_folder)
     download_contributing_file(cloned_doc_folder)
+    download_SofaGLFW_file(cloned_doc_folder)
 
     auto_doc_folder = os.path.join(tmp_folder, "auto_doc")
     print("Generate the doc...")