From 340f3f4fbc8d61189ec1d991c21e94c9efd85c71 Mon Sep 17 00:00:00 2001 From: vsr Date: Tue, 4 May 2021 13:05:33 +0300 Subject: [PATCH] bos #20430 Move fields documentation to the common doc folder --- CMakeLists.txt | 3 - .../sphinx}/fields_contour_presentation.rst | 4 +- .../fields_cut_segment_presentation.rst | 4 +- .../dev/sphinx}/fields_data_source.rst | 6 +- .../fields_deflection_shape_presentation.rst | 4 +- .../sphinx}/fields_fields_presentation.rst | 0 .../dev/sphinx/fields_index.rst | 12 +- .../dev/sphinx}/fields_introduction.rst | 4 +- .../sphinx}/fields_managing_presentations.rst | 0 .../dev/sphinx}/fields_mesh_presentation.rst | 4 +- .../sphinx}/fields_plot3d_presentation.rst | 4 +- .../fields_point_sprite_presentation.rst | 4 +- .../dev/sphinx}/fields_preferences.rst | 10 +- .../dev/sphinx}/fields_presentations.rst | 4 +- .../fields_scalar_map_presentation.rst | 4 +- .../sphinx}/fields_slices_presentation.rst | 4 +- .../fields_stream_lines_presentation.rst | 4 +- .../fields_vector_field_presentation.rst | 4 +- .../dev/sphinx}/fields_view_modes.rst | 2 + .../dev/sphinx}/images/image_contour.png | Bin .../dev/sphinx}/images/image_contour_prs.png | Bin .../dev/sphinx}/images/image_cut_segment.png | Bin .../sphinx}/images/image_cut_segment_prs.png | Bin .../image_data_source_representation.png | Bin .../sphinx}/images/image_datasource_add.png | Bin .../dev/sphinx}/images/image_deflection.png | Bin .../images/image_deflection_shape_prs.png | Bin .../dev/sphinx}/images/image_fields.png | Bin .../images/image_fields_preferences.png | Bin .../dev/sphinx}/images/image_file_search.png | Bin .../dev/sphinx}/images/image_icons_modern.png | Bin .../sphinx}/images/image_icons_standard.png | Bin .../dev/sphinx}/images/image_mesh.png | Bin .../dev/sphinx}/images/image_mesh_prs.png | Bin .../dev/sphinx}/images/image_plot3d.png | Bin .../dev/sphinx}/images/image_plot3d_prs.png | Bin .../dev/sphinx}/images/image_point_sprite.png | Bin .../sphinx}/images/image_point_sprite_prs.png | Bin .../sphinx}/images/image_representations.png | Bin .../dev/sphinx}/images/image_scalar_map.png | Bin .../sphinx}/images/image_scalar_map_prs.png | Bin .../dev/sphinx}/images/image_slices.png | Bin .../dev/sphinx}/images/image_slices_prs.png | Bin .../dev/sphinx}/images/image_stream_lines.png | Bin .../sphinx}/images/image_stream_lines_prs.png | Bin .../dev/sphinx}/images/image_vector.png | Bin .../sphinx}/images/image_vector_field_prs.png | Bin doc/dev/sphinx/index.rst | 5 +- src/MEDCalc/CMakeLists.txt | 4 - src/MEDCalc/doc/CMakeLists.txt | 38 --- src/MEDCalc/doc/conf.py.in | 240 ------------------ src/MEDCalc/doc/locale/fr/README | 1 - src/MEDCalc/doc/static/switchers.js.in | 72 ------ src/MEDCalc/doc/templates/breadcrumbs.html | 9 - src/MEDCalc/doc/templates/layout.html | 30 --- 55 files changed, 43 insertions(+), 437 deletions(-) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_contour_presentation.rst (91%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_cut_segment_presentation.rst (91%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_data_source.rst (84%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_deflection_shape_presentation.rst (88%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_fields_presentation.rst (100%) rename src/MEDCalc/doc/input/index.rst => doc/dev/sphinx/fields_index.rst (51%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_introduction.rst (93%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_managing_presentations.rst (100%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_mesh_presentation.rst (85%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_plot3d_presentation.rst (92%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_point_sprite_presentation.rst (88%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_preferences.rst (61%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_presentations.rst (86%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_scalar_map_presentation.rst (94%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_slices_presentation.rst (92%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_stream_lines_presentation.rst (90%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_vector_field_presentation.rst (89%) rename {src/MEDCalc/doc/input => doc/dev/sphinx}/fields_view_modes.rst (97%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_contour.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_contour_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_cut_segment.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_cut_segment_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_data_source_representation.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_datasource_add.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_deflection.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_deflection_shape_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_fields.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_fields_preferences.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_file_search.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_icons_modern.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_icons_standard.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_mesh.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_mesh_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_plot3d.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_plot3d_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_point_sprite.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_point_sprite_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_representations.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_scalar_map.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_scalar_map_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_slices.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_slices_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_stream_lines.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_stream_lines_prs.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_vector.png (100%) rename {src/MEDCalc/doc => doc/dev/sphinx}/images/image_vector_field_prs.png (100%) delete mode 100644 src/MEDCalc/doc/CMakeLists.txt delete mode 100644 src/MEDCalc/doc/conf.py.in delete mode 100644 src/MEDCalc/doc/locale/fr/README delete mode 100644 src/MEDCalc/doc/static/switchers.js.in delete mode 100644 src/MEDCalc/doc/templates/breadcrumbs.html delete mode 100644 src/MEDCalc/doc/templates/layout.html diff --git a/CMakeLists.txt b/CMakeLists.txt index e38a2bcf7..1d4c3ea8d 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -76,9 +76,6 @@ OPTION(SALOME_USE_MPI "(Use MPI containers) - For FIELDS this triggers the build OPTION(SALOME_BUILD_GUI "Build GUI of FIELDS." ON) OPTION(SALOME_BUILD_TESTS "Build FIELDS tests." ON) OPTION(SALOME_BUILD_DOC "Build FIELDS doc." ON) -CMAKE_DEPENDENT_OPTION(SALOME_FIELDS_BUILD_FRENCH_DOC "Generate SALOME Fields French documentation" OFF - "SALOME_BUILD_DOC" OFF) - # Find MEDCoupling (required) # ========================== diff --git a/src/MEDCalc/doc/input/fields_contour_presentation.rst b/doc/dev/sphinx/fields_contour_presentation.rst similarity index 91% rename from src/MEDCalc/doc/input/fields_contour_presentation.rst rename to doc/dev/sphinx/fields_contour_presentation.rst index e1c2fb1b1..6f5f6e81b 100644 --- a/src/MEDCalc/doc/input/fields_contour_presentation.rst +++ b/doc/dev/sphinx/fields_contour_presentation.rst @@ -4,12 +4,12 @@ Contour presentation ******************** -.. image:: ../images/image_contour_prs.png +.. image:: images/image_contour_prs.png :align: center **Contour** presentation combines all equal scalar values applied to the cells and constructs isobaric surfaces. -.. |img_ct| image:: ../images/image_contour.png +.. |img_ct| image:: images/image_contour.png To create a **Contour** presentation, diff --git a/src/MEDCalc/doc/input/fields_cut_segment_presentation.rst b/doc/dev/sphinx/fields_cut_segment_presentation.rst similarity index 91% rename from src/MEDCalc/doc/input/fields_cut_segment_presentation.rst rename to doc/dev/sphinx/fields_cut_segment_presentation.rst index b31977c41..3fe6d6854 100644 --- a/src/MEDCalc/doc/input/fields_cut_segment_presentation.rst +++ b/doc/dev/sphinx/fields_cut_segment_presentation.rst @@ -4,13 +4,13 @@ Cut Segment presentation ************************ -.. image:: ../images/image_cut_segment_prs.png +.. image:: images/image_cut_segment_prs.png :align: center **Cut segment** presentation is a type of presentation which displays colored cells with applied scalar values on the mesh where cut segment is placed. -.. |img_cs| image:: ../images/image_cut_segment.png +.. |img_cs| image:: images/image_cut_segment.png To create a **Cut segment** presentation, diff --git a/src/MEDCalc/doc/input/fields_data_source.rst b/doc/dev/sphinx/fields_data_source.rst similarity index 84% rename from src/MEDCalc/doc/input/fields_data_source.rst rename to doc/dev/sphinx/fields_data_source.rst index 7bcfca036..4795fbfed 100644 --- a/src/MEDCalc/doc/input/fields_data_source.rst +++ b/doc/dev/sphinx/fields_data_source.rst @@ -4,20 +4,20 @@ Data Source *********** -.. |img| image:: ../images/image_datasource_add.png +.. |img| image:: images/image_datasource_add.png :scale: 50 % Data Source for all presentations of Fields module is a MED file. To add Data Source into Fields module, choose **File > Add Data Source** menu (or click **Add Data Source** |img| button in the *Datasource* toolbar). This shows a standard dialog that allows browsing and choosing \*.med files: -.. image:: ../images/image_file_search.png +.. image:: images/image_file_search.png :align: center Select a file and confirm your choice by pressing **Open** button. As a result, Data Source representation appears in **Object Browser**: -.. image:: ../images/image_data_source_representation.png +.. image:: images/image_data_source_representation.png :align: center It contains the following information: diff --git a/src/MEDCalc/doc/input/fields_deflection_shape_presentation.rst b/doc/dev/sphinx/fields_deflection_shape_presentation.rst similarity index 88% rename from src/MEDCalc/doc/input/fields_deflection_shape_presentation.rst rename to doc/dev/sphinx/fields_deflection_shape_presentation.rst index 3d1f56e37..8a4f6e37b 100644 --- a/src/MEDCalc/doc/input/fields_deflection_shape_presentation.rst +++ b/doc/dev/sphinx/fields_deflection_shape_presentation.rst @@ -4,13 +4,13 @@ Deflection shape presentation ***************************** -.. image:: ../images/image_deflection_shape_prs.png +.. image:: images/image_deflection_shape_prs.png :align: center **Deflection shape** is a type of field presentation when vector values corresponding to the mesh cells are visualized by shifting these cells. -.. |img_dfl| image:: ../images/image_deflection.png +.. |img_dfl| image:: images/image_deflection.png To create a **Deflection shape** presentation, diff --git a/src/MEDCalc/doc/input/fields_fields_presentation.rst b/doc/dev/sphinx/fields_fields_presentation.rst similarity index 100% rename from src/MEDCalc/doc/input/fields_fields_presentation.rst rename to doc/dev/sphinx/fields_fields_presentation.rst diff --git a/src/MEDCalc/doc/input/index.rst b/doc/dev/sphinx/fields_index.rst similarity index 51% rename from src/MEDCalc/doc/input/index.rst rename to doc/dev/sphinx/fields_index.rst index 795f96c7d..53b1c9d89 100644 --- a/src/MEDCalc/doc/input/index.rst +++ b/doc/dev/sphinx/fields_index.rst @@ -1,5 +1,8 @@ -Welcome to Fields's documentation! -================================== +.. _fields_index_page: + +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +FIELDS module: Guide on presentations +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% .. toctree:: @@ -8,8 +11,3 @@ Welcome to Fields's documentation! fields_data_source.rst fields_view_modes.rst fields_presentations.rst - -Indices and tables -================== - -* :ref:`search` diff --git a/src/MEDCalc/doc/input/fields_introduction.rst b/doc/dev/sphinx/fields_introduction.rst similarity index 93% rename from src/MEDCalc/doc/input/fields_introduction.rst rename to doc/dev/sphinx/fields_introduction.rst index 04f5d75e3..7d5173139 100644 --- a/src/MEDCalc/doc/input/fields_introduction.rst +++ b/doc/dev/sphinx/fields_introduction.rst @@ -1,8 +1,10 @@ +.. _fields_introduction_page: + ***************************** Introduction to Fields module ***************************** -.. image:: ../images/image_fields.png +.. image:: images/image_fields.png :align: center Fields module is used for analysis and post-processing of numerical simulation results. It is based upon ParaVis module, MEDReader ParaVis diff --git a/src/MEDCalc/doc/input/fields_managing_presentations.rst b/doc/dev/sphinx/fields_managing_presentations.rst similarity index 100% rename from src/MEDCalc/doc/input/fields_managing_presentations.rst rename to doc/dev/sphinx/fields_managing_presentations.rst diff --git a/src/MEDCalc/doc/input/fields_mesh_presentation.rst b/doc/dev/sphinx/fields_mesh_presentation.rst similarity index 85% rename from src/MEDCalc/doc/input/fields_mesh_presentation.rst rename to doc/dev/sphinx/fields_mesh_presentation.rst index d2e9c3bdd..d09303390 100644 --- a/src/MEDCalc/doc/input/fields_mesh_presentation.rst +++ b/doc/dev/sphinx/fields_mesh_presentation.rst @@ -4,12 +4,12 @@ Mesh presentation ***************** -.. image:: ../images/image_mesh_prs.png +.. image:: images/image_mesh_prs.png :align: center The main purpose of this presentation is to display the mesh structure without any physical data. -.. |img_msh| image:: ../images/image_mesh.png +.. |img_msh| image:: images/image_mesh.png This presentation is automatically created when importing a :ref:`fields_data_source_page`. Additionally, **Mesh** presentation can be created by diff --git a/src/MEDCalc/doc/input/fields_plot3d_presentation.rst b/doc/dev/sphinx/fields_plot3d_presentation.rst similarity index 92% rename from src/MEDCalc/doc/input/fields_plot3d_presentation.rst rename to doc/dev/sphinx/fields_plot3d_presentation.rst index bc2d5c8be..f302fb605 100644 --- a/src/MEDCalc/doc/input/fields_plot3d_presentation.rst +++ b/doc/dev/sphinx/fields_plot3d_presentation.rst @@ -4,13 +4,13 @@ Plot3D presentation ******************* -.. image:: ../images/image_plot3d_prs.png +.. image:: images/image_plot3d_prs.png :align: center **Plot3D** is a presentation of scalar values of meshes lying on a cutting plane. The relief and coloring of the resulting presentation both correspond to the values applied to the cells of a mesh. -.. |img_pl3| image:: ../images/image_slices.png +.. |img_pl3| image:: images/image_slices.png To create a **Plot3D** presentation, diff --git a/src/MEDCalc/doc/input/fields_point_sprite_presentation.rst b/doc/dev/sphinx/fields_point_sprite_presentation.rst similarity index 88% rename from src/MEDCalc/doc/input/fields_point_sprite_presentation.rst rename to doc/dev/sphinx/fields_point_sprite_presentation.rst index b93830607..b449fd615 100644 --- a/src/MEDCalc/doc/input/fields_point_sprite_presentation.rst +++ b/doc/dev/sphinx/fields_point_sprite_presentation.rst @@ -4,13 +4,13 @@ Point sprite presentation ************************* -.. image:: ../images/image_point_sprite_prs.png +.. image:: images/image_point_sprite_prs.png :align: center **Point sprite** presentation presents data on field as a set of fixed points of the renormalisation group flow with Gaussian distribution. -.. |img_ps| image:: ../images/image_point_sprite.png +.. |img_ps| image:: images/image_point_sprite.png To create a **Point sprite** presentation, diff --git a/src/MEDCalc/doc/input/fields_preferences.rst b/doc/dev/sphinx/fields_preferences.rst similarity index 61% rename from src/MEDCalc/doc/input/fields_preferences.rst rename to doc/dev/sphinx/fields_preferences.rst index cdf8165f5..81c3c9300 100644 --- a/src/MEDCalc/doc/input/fields_preferences.rst +++ b/doc/dev/sphinx/fields_preferences.rst @@ -1,17 +1,21 @@ +.. _fields_preferences_page: + *********** Preferences *********** -.. image:: ../images/image_fields_preferences.png +.. image:: images/image_fields_preferences.png :align: center Preferences dialog allows choosing icons theme for use in Fields module. One of the following themes can be chosen: * **Modern**: modern icons -.. image:: ../images/image_icons_modern.png + +.. image:: images/image_icons_modern.png :align: center * **Classic**: classic icons -.. image:: ../images/image_icons_standard.png + +.. image:: images/image_icons_standard.png :align: center diff --git a/src/MEDCalc/doc/input/fields_presentations.rst b/doc/dev/sphinx/fields_presentations.rst similarity index 86% rename from src/MEDCalc/doc/input/fields_presentations.rst rename to doc/dev/sphinx/fields_presentations.rst index b58151e8a..858abfcd2 100644 --- a/src/MEDCalc/doc/input/fields_presentations.rst +++ b/doc/dev/sphinx/fields_presentations.rst @@ -1,10 +1,10 @@ -.. _presentations_page: +.. _fields_presentations_page: ************* Presentations ************* -.. image:: ../images/image_representations.png +.. image:: images/image_representations.png :align: center Fields module allows creating several types of presentations. All presentation types can be split in two main groups: diff --git a/src/MEDCalc/doc/input/fields_scalar_map_presentation.rst b/doc/dev/sphinx/fields_scalar_map_presentation.rst similarity index 94% rename from src/MEDCalc/doc/input/fields_scalar_map_presentation.rst rename to doc/dev/sphinx/fields_scalar_map_presentation.rst index a8a5c21d9..55e018a7e 100644 --- a/src/MEDCalc/doc/input/fields_scalar_map_presentation.rst +++ b/doc/dev/sphinx/fields_scalar_map_presentation.rst @@ -4,13 +4,13 @@ Scalar map presentation *********************** -.. image:: ../images/image_scalar_map_prs.png +.. image:: images/image_scalar_map_prs.png :align: center **Scalar map** is the basic type of presentation in Fields module. It consists in coloring each cell of a field in accordance with the scalar or vector data applied to it. -.. |img_sm| image:: ../images/image_scalar_map.png +.. |img_sm| image:: images/image_scalar_map.png To create a **Scalar map** presentation, diff --git a/src/MEDCalc/doc/input/fields_slices_presentation.rst b/doc/dev/sphinx/fields_slices_presentation.rst similarity index 92% rename from src/MEDCalc/doc/input/fields_slices_presentation.rst rename to doc/dev/sphinx/fields_slices_presentation.rst index 155eedf4f..93277af38 100644 --- a/src/MEDCalc/doc/input/fields_slices_presentation.rst +++ b/doc/dev/sphinx/fields_slices_presentation.rst @@ -4,13 +4,13 @@ Slices presentation ******************* -.. image:: ../images/image_slices_prs.png +.. image:: images/image_slices_prs.png :align: center **Slices** is a type of field presentation, when the given mesh is cut by a number of planes. These planes are colored according the the values applied to the mesh cells. -.. |img_sl| image:: ../images/image_slices.png +.. |img_sl| image:: images/image_slices.png To create a **Slices** presentation, diff --git a/src/MEDCalc/doc/input/fields_stream_lines_presentation.rst b/doc/dev/sphinx/fields_stream_lines_presentation.rst similarity index 90% rename from src/MEDCalc/doc/input/fields_stream_lines_presentation.rst rename to doc/dev/sphinx/fields_stream_lines_presentation.rst index 2106c0cd2..bc4fa85f6 100644 --- a/src/MEDCalc/doc/input/fields_stream_lines_presentation.rst +++ b/doc/dev/sphinx/fields_stream_lines_presentation.rst @@ -4,14 +4,14 @@ Stream lines presentation ************************* -.. image:: ../images/image_stream_lines_prs.png +.. image:: images/image_stream_lines_prs.png :align: center **Stream lines** is a type of presentation transforming the cells with vectors having most similar direction into lines. A streamline can be thought of as the path that a massless particle takes in a vector field. Streamlines are used to convey the structure of a vector field. -.. |img_stl| image:: ../images/image_stream_lines.png +.. |img_stl| image:: images/image_stream_lines.png To create a **Stream lines** presentation, diff --git a/src/MEDCalc/doc/input/fields_vector_field_presentation.rst b/doc/dev/sphinx/fields_vector_field_presentation.rst similarity index 89% rename from src/MEDCalc/doc/input/fields_vector_field_presentation.rst rename to doc/dev/sphinx/fields_vector_field_presentation.rst index 5c1d662bd..62caee789 100644 --- a/src/MEDCalc/doc/input/fields_vector_field_presentation.rst +++ b/doc/dev/sphinx/fields_vector_field_presentation.rst @@ -4,12 +4,12 @@ Vector field presentation ************************* -.. image:: ../images/image_vector_field_prs.png +.. image:: images/image_vector_field_prs.png :align: center **Vector field** presentation visualizes vectors of the corresponding mesh cells in graphical mode. -.. |img_vct| image:: ../images/image_vector.png +.. |img_vct| image:: images/image_vector.png To create a **Vector field** presentation, diff --git a/src/MEDCalc/doc/input/fields_view_modes.rst b/doc/dev/sphinx/fields_view_modes.rst similarity index 97% rename from src/MEDCalc/doc/input/fields_view_modes.rst rename to doc/dev/sphinx/fields_view_modes.rst index dbe1c8ae6..d063bd119 100644 --- a/src/MEDCalc/doc/input/fields_view_modes.rst +++ b/doc/dev/sphinx/fields_view_modes.rst @@ -1,3 +1,5 @@ +.. _fields_view_modes_page: + ********** View Modes ********** diff --git a/src/MEDCalc/doc/images/image_contour.png b/doc/dev/sphinx/images/image_contour.png similarity index 100% rename from src/MEDCalc/doc/images/image_contour.png rename to doc/dev/sphinx/images/image_contour.png diff --git a/src/MEDCalc/doc/images/image_contour_prs.png b/doc/dev/sphinx/images/image_contour_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_contour_prs.png rename to doc/dev/sphinx/images/image_contour_prs.png diff --git a/src/MEDCalc/doc/images/image_cut_segment.png b/doc/dev/sphinx/images/image_cut_segment.png similarity index 100% rename from src/MEDCalc/doc/images/image_cut_segment.png rename to doc/dev/sphinx/images/image_cut_segment.png diff --git a/src/MEDCalc/doc/images/image_cut_segment_prs.png b/doc/dev/sphinx/images/image_cut_segment_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_cut_segment_prs.png rename to doc/dev/sphinx/images/image_cut_segment_prs.png diff --git a/src/MEDCalc/doc/images/image_data_source_representation.png b/doc/dev/sphinx/images/image_data_source_representation.png similarity index 100% rename from src/MEDCalc/doc/images/image_data_source_representation.png rename to doc/dev/sphinx/images/image_data_source_representation.png diff --git a/src/MEDCalc/doc/images/image_datasource_add.png b/doc/dev/sphinx/images/image_datasource_add.png similarity index 100% rename from src/MEDCalc/doc/images/image_datasource_add.png rename to doc/dev/sphinx/images/image_datasource_add.png diff --git a/src/MEDCalc/doc/images/image_deflection.png b/doc/dev/sphinx/images/image_deflection.png similarity index 100% rename from src/MEDCalc/doc/images/image_deflection.png rename to doc/dev/sphinx/images/image_deflection.png diff --git a/src/MEDCalc/doc/images/image_deflection_shape_prs.png b/doc/dev/sphinx/images/image_deflection_shape_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_deflection_shape_prs.png rename to doc/dev/sphinx/images/image_deflection_shape_prs.png diff --git a/src/MEDCalc/doc/images/image_fields.png b/doc/dev/sphinx/images/image_fields.png similarity index 100% rename from src/MEDCalc/doc/images/image_fields.png rename to doc/dev/sphinx/images/image_fields.png diff --git a/src/MEDCalc/doc/images/image_fields_preferences.png b/doc/dev/sphinx/images/image_fields_preferences.png similarity index 100% rename from src/MEDCalc/doc/images/image_fields_preferences.png rename to doc/dev/sphinx/images/image_fields_preferences.png diff --git a/src/MEDCalc/doc/images/image_file_search.png b/doc/dev/sphinx/images/image_file_search.png similarity index 100% rename from src/MEDCalc/doc/images/image_file_search.png rename to doc/dev/sphinx/images/image_file_search.png diff --git a/src/MEDCalc/doc/images/image_icons_modern.png b/doc/dev/sphinx/images/image_icons_modern.png similarity index 100% rename from src/MEDCalc/doc/images/image_icons_modern.png rename to doc/dev/sphinx/images/image_icons_modern.png diff --git a/src/MEDCalc/doc/images/image_icons_standard.png b/doc/dev/sphinx/images/image_icons_standard.png similarity index 100% rename from src/MEDCalc/doc/images/image_icons_standard.png rename to doc/dev/sphinx/images/image_icons_standard.png diff --git a/src/MEDCalc/doc/images/image_mesh.png b/doc/dev/sphinx/images/image_mesh.png similarity index 100% rename from src/MEDCalc/doc/images/image_mesh.png rename to doc/dev/sphinx/images/image_mesh.png diff --git a/src/MEDCalc/doc/images/image_mesh_prs.png b/doc/dev/sphinx/images/image_mesh_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_mesh_prs.png rename to doc/dev/sphinx/images/image_mesh_prs.png diff --git a/src/MEDCalc/doc/images/image_plot3d.png b/doc/dev/sphinx/images/image_plot3d.png similarity index 100% rename from src/MEDCalc/doc/images/image_plot3d.png rename to doc/dev/sphinx/images/image_plot3d.png diff --git a/src/MEDCalc/doc/images/image_plot3d_prs.png b/doc/dev/sphinx/images/image_plot3d_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_plot3d_prs.png rename to doc/dev/sphinx/images/image_plot3d_prs.png diff --git a/src/MEDCalc/doc/images/image_point_sprite.png b/doc/dev/sphinx/images/image_point_sprite.png similarity index 100% rename from src/MEDCalc/doc/images/image_point_sprite.png rename to doc/dev/sphinx/images/image_point_sprite.png diff --git a/src/MEDCalc/doc/images/image_point_sprite_prs.png b/doc/dev/sphinx/images/image_point_sprite_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_point_sprite_prs.png rename to doc/dev/sphinx/images/image_point_sprite_prs.png diff --git a/src/MEDCalc/doc/images/image_representations.png b/doc/dev/sphinx/images/image_representations.png similarity index 100% rename from src/MEDCalc/doc/images/image_representations.png rename to doc/dev/sphinx/images/image_representations.png diff --git a/src/MEDCalc/doc/images/image_scalar_map.png b/doc/dev/sphinx/images/image_scalar_map.png similarity index 100% rename from src/MEDCalc/doc/images/image_scalar_map.png rename to doc/dev/sphinx/images/image_scalar_map.png diff --git a/src/MEDCalc/doc/images/image_scalar_map_prs.png b/doc/dev/sphinx/images/image_scalar_map_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_scalar_map_prs.png rename to doc/dev/sphinx/images/image_scalar_map_prs.png diff --git a/src/MEDCalc/doc/images/image_slices.png b/doc/dev/sphinx/images/image_slices.png similarity index 100% rename from src/MEDCalc/doc/images/image_slices.png rename to doc/dev/sphinx/images/image_slices.png diff --git a/src/MEDCalc/doc/images/image_slices_prs.png b/doc/dev/sphinx/images/image_slices_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_slices_prs.png rename to doc/dev/sphinx/images/image_slices_prs.png diff --git a/src/MEDCalc/doc/images/image_stream_lines.png b/doc/dev/sphinx/images/image_stream_lines.png similarity index 100% rename from src/MEDCalc/doc/images/image_stream_lines.png rename to doc/dev/sphinx/images/image_stream_lines.png diff --git a/src/MEDCalc/doc/images/image_stream_lines_prs.png b/doc/dev/sphinx/images/image_stream_lines_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_stream_lines_prs.png rename to doc/dev/sphinx/images/image_stream_lines_prs.png diff --git a/src/MEDCalc/doc/images/image_vector.png b/doc/dev/sphinx/images/image_vector.png similarity index 100% rename from src/MEDCalc/doc/images/image_vector.png rename to doc/dev/sphinx/images/image_vector.png diff --git a/src/MEDCalc/doc/images/image_vector_field_prs.png b/doc/dev/sphinx/images/image_vector_field_prs.png similarity index 100% rename from src/MEDCalc/doc/images/image_vector_field_prs.png rename to doc/dev/sphinx/images/image_vector_field_prs.png diff --git a/doc/dev/sphinx/index.rst b/doc/dev/sphinx/index.rst index 4483a4779..cd0d21bc8 100644 --- a/doc/dev/sphinx/index.rst +++ b/doc/dev/sphinx/index.rst @@ -12,13 +12,10 @@ References **User documentation** -.. _FIELDS module\: User guide for simplified MED visualisation: ../../MEDCalc/index.html - -* `FIELDS module\: User guide for simplified MED visualisation`_ - .. toctree:: :maxdepth: 1 + fields_index.rst medcalc-userguide-gui.rst medcalc-userguide-api.rst diff --git a/src/MEDCalc/CMakeLists.txt b/src/MEDCalc/CMakeLists.txt index 5f2f2cae3..4e7afd6fd 100644 --- a/src/MEDCalc/CMakeLists.txt +++ b/src/MEDCalc/CMakeLists.txt @@ -31,8 +31,4 @@ IF(SALOME_FIELDS_ENABLE_PYTHON) ADD_SUBDIRECTORY(exe) ENDIF() -IF(SALOME_BUILD_DOC) - ADD_SUBDIRECTORY(doc) -ENDIF(SALOME_BUILD_DOC) - INSTALL(FILES MEDCalcConstants.hxx DESTINATION ${SALOME_INSTALL_HEADERS}) diff --git a/src/MEDCalc/doc/CMakeLists.txt b/src/MEDCalc/doc/CMakeLists.txt deleted file mode 100644 index 088c91059..000000000 --- a/src/MEDCalc/doc/CMakeLists.txt +++ /dev/null @@ -1,38 +0,0 @@ -# Copyright (C) 2021 CEA/DEN, EDF R&D, OPEN CASCADE -# -# This library is free software; you can redistribute it and/or -# modify it under the terms of the GNU Lesser General Public -# License as published by the Free Software Foundation; either -# version 2.1 of the License, or (at your option) any later version. -# -# This library is distributed in the hope that it will be useful, -# but WITHOUT ANY WARRANTY; without even the implied warranty of -# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -# Lesser General Public License for more details. -# -# You should have received a copy of the GNU Lesser General Public -# License along with this library; if not, write to the Free Software -# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -# -# See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com -# - -INCLUDE(UseSphinx) - -SALOME_CONFIGURE_FILE(conf.py.in conf.py) - -IF(SALOME_FIELDS_BUILD_FRENCH_DOC) - SET(BUILD_LANGUAGE_SWITCHER "true") - SALOME_CONFIGURE_FILE(static/switchers.js.in static/switchers.js) - ADD_MULTI_LANG_DOCUMENTATION(TARGET_NAME usr_docs MODULE MEDCalc LANGUAGES fr) -ELSE() - SET(BUILD_LANGUAGE_SWITCHER "false") - SALOME_CONFIGURE_FILE(static/switchers.js.in static/switchers.js) - ADD_MULTI_LANG_DOCUMENTATION(TARGET_NAME usr_docs MODULE MEDCalc) -ENDIF() - -INSTALL(CODE "EXECUTE_PROCESS(COMMAND \"${CMAKE_COMMAND}\" --build ${PROJECT_BINARY_DIR} --target usr_docs)") -INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/MEDCalc DESTINATION ${SALOME_INSTALL_DOC}) -IF(SALOME_FIELDS_BUILD_FRENCH_DOC) - INSTALL(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/MEDCalc_fr DESTINATION ${SALOME_INSTALL_DOC}) -ENDIF() diff --git a/src/MEDCalc/doc/conf.py.in b/src/MEDCalc/doc/conf.py.in deleted file mode 100644 index c4678cd08..000000000 --- a/src/MEDCalc/doc/conf.py.in +++ /dev/null @@ -1,240 +0,0 @@ -# -*- coding: utf-8 -*- -# -# yacs documentation build configuration file, created by -# sphinx-quickstart on Fri Aug 29 09:57:25 2008. -# -# This file is execfile()d with the current directory set to its containing dir. -# -# The contents of this file are pickled, so don't put values in the namespace -# that aren't pickleable (module imports are okay, they're removed automatically). -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import sys, os -import sphinx - -# If your extensions are in another directory, add it here. If the directory -# is relative to the documentation root, use os.path.abspath to make it -# absolute, like shown here. -#sys.path.append(os.path.abspath('.')) - -# General configuration -# --------------------- - -# Add any Sphinx extension module names here, as strings. They can be extensions -# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc'] -try: - import sphinx_rtd_theme - extensions += ['sphinx_rtd_theme'] - use_rtd_theme = True -except: - use_rtd_theme = False -#add pdfbuilder to build a pdf with rst2pdf -#extensions = ['rst2pdf.pdfbuilder'] - -# Add any paths that contain templates here, relative to this directory. -templates_path = [os.path.join('@CMAKE_CURRENT_SOURCE_DIR@','templates')] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -#source_encoding = 'utf-8' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = 'Fields' -copyright = '2012-2021 CEA/DEN, EDF R&D' - -# Copyright is shown via custom footer -html_show_copyright = True - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '@SALOMEGUI_VERSION@' -# The full version, including alpha/beta/rc tags. -release = '@SALOMEGUI_VERSION@' - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -#language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -#today = '' -# Else, today_fmt is used as the format for a strftime call. -#today_fmt = '%B %d, %Y' - -# List of documents that shouldn't be included in the build. -#unused_docs = [] - -# List of directories, relative to source directory, that shouldn't be searched -# for source files. -exclude_trees = ['.build','ref','images','CVS'] - -# A list of glob-style patterns that should be excluded when looking for source -# files. They are matched against the source file names relative to the -# source directory, using slashes as directory separators on all platforms. -exclude_patterns = ['**/CVS'] - -# The reST default role (used for this markup: `text`) to use for all documents. -#default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -#add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -#show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - - -# Options for HTML output -# ----------------------- - -# The theme to use for HTML and HTML Help pages. Major themes that come with -# Sphinx are currently 'default' and 'sphinxdoc'. -if use_rtd_theme: - html_theme = 'sphinx_rtd_theme' -else: - html_theme = 'default' if sphinx.version_info[:2] < (1,3) else 'classic' - -themes_options = {} -themes_options['classic'] = { - 'body_max_width':'none', - 'body_min_width':0, -} -html_theme_options = themes_options.get(html_theme, {}) - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -#html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -#html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -#html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -#html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','static')] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -#html_last_updated_fmt = '%b %d, %Y' - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -#html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'],} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -#html_additional_pages = {} - -# If false, no module index is generated. -html_use_modindex = True - -# If false, no index is generated. -html_use_index = False - -# If true, the index is split into individual pages for each letter. -#html_split_index = False - -# If true, the reST sources are included in the HTML build as _sources/. -#html_copy_source = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -#html_use_opensearch = '' - -# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). -#html_file_suffix = '' - -# Output file base name for HTML help builder. -htmlhelp_basename = 'guidoc' - - -# Options for LaTeX output -# ------------------------ - -# The paper size ('letter' or 'a4'). -latex_paper_size = 'a4' - -# The font size ('10pt', '11pt' or '12pt'). -latex_font_size = '10pt' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, document class [howto/manual]). -latex_documents = [ - ('index', 'FIELDS.tex', 'Fields User Documentation', '', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -#latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -#latex_use_parts = False - -# Additional stuff for the LaTeX preamble. -latex_preamble = """ -\RecustomVerbatimEnvironment - {Verbatim}{Verbatim} - {fontsize=\scriptsize} -""" - -# Documents to append as an appendix to all manuals. -#latex_appendices = [] - -# If false, no module index is generated. -latex_use_modindex = True - -#Options for rst2pdf output (through reportlab) -pdf_documents = [ - ('index', 'GUI.tex', 'GUI User Documentation', '', 'manual'), -] - -# A comma-separated list of custom stylesheets. -pdf_stylesheets = ['sphinx','kerning','a4'] - -# Create a compressed PDF -# Use True/False or 1/0 -#pdf_compressed = False - -# A colon-separated list of folders to search for fonts. Example: -# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/'] - -# Language to be used for hyphenation support -#pdf_language = "en_US" - -# Example configuration for intersphinx: refer to the Python standard library. -intersphinx_mapping = {'https://docs.python.org/': None} - -locale_dirs = [os.path.join('@CMAKE_CURRENT_BINARY_DIR@','locale')] # path is example but recommended. -gettext_compact = False # optional diff --git a/src/MEDCalc/doc/locale/fr/README b/src/MEDCalc/doc/locale/fr/README deleted file mode 100644 index 6e2d94823..000000000 --- a/src/MEDCalc/doc/locale/fr/README +++ /dev/null @@ -1 +0,0 @@ -This directory stores French localization files of documentation. \ No newline at end of file diff --git a/src/MEDCalc/doc/static/switchers.js.in b/src/MEDCalc/doc/static/switchers.js.in deleted file mode 100644 index f25369329..000000000 --- a/src/MEDCalc/doc/static/switchers.js.in +++ /dev/null @@ -1,72 +0,0 @@ -(function() { - 'use strict'; - - // Parses versions in URL segments like: - - var all_languages = { - 'en': 'English', - 'fr': 'French', - }; - - function build_language_select(current_language) { - var buf = [''); - return buf.join(''); - } - - function on_language_switch() { - var selected_language = $(this).children('option:selected').attr('value') + '/'; - var url = window.location.href; - - var current_language = language_segment_from_url(url); - var current_suffix = ""; - if (current_language != "") { - current_suffix = "_"; - } else { - current_language = "/"; - } - - var selected_suffix = "_"; - if (selected_language == 'en/') { // Special 'default' case for english. - selected_language = ''; - selected_suffix = "/"; - } - - var new_url = url.replace('/gui/GUI' + current_suffix + current_language, - '/gui/GUI' + selected_suffix + selected_language); - if (new_url != url) { - window.location.href = new_url; - } - } - - // Returns the path segment of the language as a string, like 'fr/' - // or '' if not found. - function language_segment_from_url(url) { - var language_regexp = '\/gui/GUI_([a-z]{2}(?:-[a-z]{2})?/)'; - var match = url.match(language_regexp); - if (match !== null) - return match[1]; - return ''; - } - - $(document).ready(function() { - if(@BUILD_LANGUAGE_SWITCHER@) { - var release = DOCUMENTATION_OPTIONS.VERSION; - var language_segment = language_segment_from_url(window.location.href); - var current_language = language_segment.replace(/\/+$/g, '') || 'English'; - - var language_select = build_language_select(current_language); - - $('.language_switcher_placeholder').html(language_select); - $('.language_switcher_placeholder select').bind('change', on_language_switch); - } - }); -})(); diff --git a/src/MEDCalc/doc/templates/breadcrumbs.html b/src/MEDCalc/doc/templates/breadcrumbs.html deleted file mode 100644 index fd4d4cbb3..000000000 --- a/src/MEDCalc/doc/templates/breadcrumbs.html +++ /dev/null @@ -1,9 +0,0 @@ -{% extends "!breadcrumbs.html" %} - -{% block breadcrumbs_aside %} -{{ super() }} - {{ language or 'English' }} - {{ super() }} -{% endblock %} - -{% block extrahead %} - -{{ super() }} -{% endblock %} - -{%- block sidebarlogo %} -{{ super() }} -{%- -include "searchbox.html" -%} -

-{%- endblock %} -{%- block sidebarsearch %} -{%- endblock %} - -{%- block footer %} -

- Copyright © 2007-2021 CEA/DEN, EDF R&D, OPEN CASCADE -
- Copyright © 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS. -
- {{ super() }} -{%- endblock %} -- 2.39.2