Documenting - Rework doxygen documentation for markdawn

.github/workflows/build-and-test-multiplatform.yml

@@ -6,9 +6,9 @@
 name: Build and Test OCCT on Multiple Platforms
 
 on:
-  pull_request:
-    branches:
-      - '**'
+  # pull_request:
+  #   branches:
+  #     - '**'
   push:
     branches:
       - 'master'

.github/workflows/build-docs.yml

@@ -5,6 +5,9 @@
 name: Build Documentation
 
 on:
+  pull_request:
+    branches:
+      - '**'
   push:
     branches:
       - 'master'
@@ -23,26 +26,26 @@ jobs:
         choco install -y graphviz
         choco install -y doxygen.install
 
-    - name: Build refman documentation
-      run: |
-        set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
-        cd adm
-        bash gendoc -refman
-      shell: cmd
-
-    - name: Upload refman documentation
-      uses: actions/[email protected]
-      with:
-        name: refman-doc
-        path: doc/refman
-        retention-days: 90
-
-    - name: Upload generation log
-      uses: actions/[email protected]
-      with:
-        name: doxygen.log
-        path: doc/html_doxygen_err.log
-        retention-days: 90
+    # - name: Build refman documentation
+    #   run: |
+    #     set PATH=%PATH%;C:\Program Files\doxygen\bin;C:\Program Files\Graphviz\bin;C:\Program Files\doxygen
+    #     cd adm
+    #     bash gendoc -refman
+    #   shell: cmd
+
+    # - name: Upload refman documentation
+    #   uses: actions/[email protected]
+    #   with:
+    #     name: refman-doc
+    #     path: doc/refman
+    #     retention-days: 90
+
+    # - name: Upload generation log
+    #   uses: actions/[email protected]
+    #   with:
+    #     name: doxygen.log
+    #     path: doc/html_doxygen_err.log
+    #     retention-days: 90
 
     - name: Build documentation Overview
       run: |

dox/FILES_HTML.txt

@@ -5,9 +5,9 @@
 # The order of files in this list determines order of top-level pages
 # in the generated documentation.
 
-introduction/introduction.md
+home.md
 
-samples/samples.md
+samples.md
 ../samples/mfc/standard/ReadMe.md
 ../samples/CSharp/ReadMe.md
 ../samples/CSharp/ReadMe_D3D.md
@@ -19,48 +19,48 @@ samples/samples.md
 ../samples/ios/UIKitSample/ReadMe.md
 ../samples/webgl/ReadMe.md
 ../samples/glfw/readme.md
-samples/ocaf.md
-samples/ocaf_func.md
-samples/draw_scripts.md
-samples/ais_object.md
+ocaf.md
+ocaf_func.md
+draw_scripts.md
+ais_object.md
 
-samples/novice_guide.md
-tutorial/tutorial.md
+novice_guide.md
+tutorial.md
 
-build/build_upgrade.md
-build/build_occt/building_occt.md
-build/build_3rdparty/building_3rdparty.md
-build/build_documentation/building_documentation.md
+build_upgrade.md
+building_occt.md
+building_3rdparty.md
+building_documentation.md
 
-debug/debug.md
-upgrade/upgrade.md
+debug.md
+upgrade.md
 
-user_guides/user_guides.md
-user_guides/foundation_classes/foundation_classes.md
-user_guides/modeling_data/modeling_data.md
-user_guides/modeling_algos/modeling_algos.md
-user_guides/mesh/mesh.md
-user_guides/shape_healing/shape_healing.md
-user_guides/visualization/visualization.md
-user_guides/iges/iges.md
-user_guides/step/step.md
-user_guides/xde/xde.md
-user_guides/de_wrapper/de_wrapper.md
-user_guides/ocaf/ocaf.md
-user_guides/draw_test_harness/draw_test_harness.md
-user_guides/inspector/inspector.md
-user_guides/vis/vis.md
+user_guides.md
+foundation_classes.md
+modeling_data.md
+modeling_algos.md
+mesh.md
+shape_healing.md
+visualization.md
+iges.md
+step.md
+xde.md
+de_wrapper.md
+ocaf.md
+draw_test_harness.md
+inspector.md
+vis.md
 
-specification/specification.md
-specification/boolean_operations/boolean_operations.md
-specification/brep_format.md
-specification/pbr_math.md
+specification.md
+boolean_operations.md
+brep_format.md
+pbr_math.md
 
-contribution/contribution.md
-contribution/documentation/documentation.md
-contribution/coding_rules.md
-contribution/contribution_workflow/contribution_workflow.md
-contribution/git_guide/git_guide.md
-contribution/tests/tests.md
+contribution.md
+documentation.md
+coding_rules.md
+contribution_workflow.md
+git_guide.md
+tests.md
 
 license.md

dox/FILES_PDF.txt

@@ -4,32 +4,32 @@
 # Empty spaces are allowed.
 # Strings starting with '#' are treated as comments and ignored.
 
-tutorial/tutorial.md
+tutorial.md
 
-samples/novice_guide.md
+novice_guide.md
 
-upgrade/upgrade.md
+upgrade.md
 
-user_guides/foundation_classes/foundation_classes.md
-user_guides/modeling_data/modeling_data.md
-user_guides/modeling_algos/modeling_algos.md
-user_guides/mesh/mesh.md
-user_guides/ocaf/ocaf.md
-user_guides/visualization/visualization.md
-user_guides/vis/vis.md
-user_guides/iges/iges.md
-user_guides/step/step.md
-user_guides/xde/xde.md
-user_guides/de_wrapper/de_wrapper.md
-user_guides/inspector/inspector.md
-user_guides/draw_test_harness/draw_test_harness.md
+foundation_classes.md
+modeling_data.md
+modeling_algos.md
+mesh.md
+ocaf.md
+visualization.md
+vis.md
+iges.md
+step.md
+xde.md
+de_wrapper.md
+inspector.md
+draw_test_harness.md
 
-contribution/contribution_workflow/contribution_workflow.md
-contribution/documentation/documentation.md
-contribution/coding_rules.md
-contribution/git_guide/git_guide.md
-contribution/tests/tests.md
+contribution_workflow.md
+documentation.md
+coding_rules.md
+git_guide.md
+tests.md
 
-specification/boolean_operations/boolean_operations.md
-specification/brep_format.md
-specification/pbr_math.md
+boolean_operations.md
+brep_format.md
+pbr_math.md