build, package and release documentation

Author: cbellot000

.ci/azure-pipelines.yml

@@ -189,7 +189,7 @@ jobs:
     DISPLAY: ':99.0'
     PYANSYS_OFF_SCREEN: True
     DPF_PORT: 32772
-    GH_DOC_BRANCH: 'cbellot/doc_try'
+    GH_DOC_BRANCH: 'gh-pages'
   pool:
     vmImage: 'windows-2019'
 
@@ -225,20 +225,20 @@ jobs:
     - powershell: |
         git init
         git checkout -b $(GH_DOC_BRANCH)
-        git config --local user.name "pyansys-ci-bot"
-        git config --local user.email "$(GH_EMAIL)"
-        git config --local http.https://github.com/.extraheader "AUTHORIZATION: Basic ${GH_PAT}"
+        git config --global user.name "pyansys-ci-bot"
+        git config --global user.email "$(GH_EMAIL)"
         New-Item -ItemType file .nojekyll
         git add .
         git commit -m "Documentation generated by $(Build.DefinitionName)"
       displayName: "Init git and add docs"
       workingDirectory: docs\build\html
 
     - script: |
-        git remote add origin https://github.com/pyansys/DPF-Core-docs.git
+        git remote add origin https://$(GH_PAT)@github.com/pyansys/DPF-Core-docs
         git push -u origin $(GH_DOC_BRANCH) --force
       displayName: "Publish GitHub Pages merge commit"
       workingDirectory: docs\build\html
+      condition: contains(variables['Build.SourceBranch'], 'refs/tags/')
           
     - template: templates\kill-servers-windows.yml    
 

.ci/templates/prepare-environment-windows.yml

@@ -33,14 +33,7 @@ steps:
         python -c "from ansys.dpf import core; print(core.Report(gpu=False))"           
       
       displayName: Install ansys-dpf-core
-    
-    - task: PublishBuildArtifacts@1
-      displayName: 'WHEEL: publish artifacts'
-      inputs:
-        PathtoPublish: '$(System.DefaultWorkingDirectory)\dist'
-        ArtifactName: 'ansys_dpf_core_wheel'
-      enabled: true
-      
+
     - task: UniversalPackages@0
       inputs:
         command: 'download'

ansys/dpf/core/check_version.py

@@ -119,7 +119,7 @@ def version_tuple(ver):
     
     Parameters
     ----------
-    ver : string
+    ver : str
     
     Returns
     -------

ansys/dpf/core/collection.py

@@ -66,7 +66,7 @@ def set_labels(self, labels):
 
         Parameters
         ----------
-        labels : list[string], optional
+        labels : list[str], optional
             labels on which the entries will be scoped, for example:
                 ['time','complex']
 
@@ -110,7 +110,7 @@ def _get_labels(self):
 
         Returns
         -------
-        labels: list[string]
+        labels: list[str]
             labels on which the entries are scoped, for example:
                 ``['time', 'complex']``
         """
@@ -123,12 +123,13 @@ def has_label(self, label):
 
         Parameters
         ----------
-        label: string
+        label: str
             Labels that must be searched, for example ``'time'``.
             
         Returns
         -------
-        bool: True if the specified value have been found in the collection. 
+        bool
+            ``True`` if the specified value has been found in the collection. 
 
         Examples
         --------
@@ -137,25 +138,19 @@ def has_label(self, label):
         >>> coll.add_label('time')
         >>> coll.has_label('time')
         True
+        
         >>> coll.has_label('complex')
         False
         
         """
-        result = False
-        labels = self.labels
-        i = 0
-        while i < len(labels):
-            if labels[i] == label:
-                result = True
-            i += 1
-        return result
+        return label in self.labels
 
     def _get_entries(self, label_space_or_index):
         """Returns the entries at a requested index or label space
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int]
+        label_space_or_index : dict[str,int]
             Label space of the requested entry, for example:
             ``{"time": 1, "complex": 0}`` or index of the field.
 
@@ -199,7 +194,7 @@ def _get_entry(self, label_space_or_index):
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int]
+        label_space_or_index : dict[str,int]
             Label space of the requested entry, for example:
             ``{"time": 1, "complex": 0}`` or index of the field.
 
@@ -228,7 +223,7 @@ def get_label_space(self, index):
 
         Returns
         -------
-        label_space : dict(string:int)
+        label_space : dict(str:int)
             Scoping of the requested entry, for example:
             ``{"time": 1, "complex": 0}``
         """
@@ -320,7 +315,7 @@ def _add_entry(self, label_space, entry):
 
         parameters
         ----------
-        label_space : list[string,int]
+        label_space : list[str,int]
             label space of the requested fields, ex : {"time":1, "complex":0}
 
         entry : Field or Scoping

ansys/dpf/core/fields_container.py

@@ -164,7 +164,7 @@ def get_fields(self, label_space):
 
         Parameters
         ----------
-        label_space : dict[string,int] 
+        label_space : dict[str,int] 
             Scoping of the requested fields, for example:
             ``{"time": 1, "complex": 0}``
 
@@ -202,7 +202,7 @@ def get_field(self, label_space_or_index):
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int] , int 
+        label_space_or_index : dict[str,int] , int 
             Scoping of the requested fields, for example:
             ``{"time": 1, "complex": 0}``
             or Index of the field.
@@ -305,7 +305,7 @@ def add_field(self, label_space, field):
 
         Parameters
         ----------
-        label_space : dict[string,int]
+        label_space : dict[str,int]
             label_space of the requested fields, ex : {"time":1, "complex":0}
 
         field : Field

ansys/dpf/core/fields_container_factory.py

@@ -22,7 +22,7 @@ def over_time_freq_fields_container(fields, time_freq_unit = None, server = None
     fields : Dictionary(time_int_key : Field) or list of Field
         Dictionary of Field entities to add to the fields container
     
-    time_freq_unit : string , optional
+    time_freq_unit : str , optional
         String that defines the unit symbol of the time_freq_support. Will be taken 
         into account if the fields attribute has a dictionary type.
     
@@ -86,7 +86,7 @@ def over_time_freq_complex_fields_container(real_fields, imaginary_fields, time_
     imaginary_fields : Dictionary(time_int_key : Field) or list of Field
         Dictionary or list of Field entities to add to the fields container
         
-    time_freq_unit : string , optional
+    time_freq_unit : str , optional
         String that defines the unit symbol of the time_freq_support. Will be taken 
         into account if the fields attribute has a dictionary type.
     

ansys/dpf/core/mesh_scoping_factory.py

@@ -58,7 +58,7 @@ def named_selection_scoping(named_selection_name, model, server = None):
 
     Parameters
     ----------
-    named_selection_name : string
+    named_selection_name : str
     
     server : server.DPFServer, optional
         Server with channel connected to the remote or local instance. When

ansys/dpf/core/meshes_container.py

@@ -41,7 +41,7 @@ def get_meshes(self, label_space):
 
         Parameters
         ----------
-        label_space : dict[string,int] 
+        label_space : dict[str,int] 
             Meshes corresponding to the filter (label space) in input, for example:
             ``{"elshape":1, "body":12}``
 
@@ -58,7 +58,7 @@ def get_mesh(self, label_space_or_index):
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int] , int 
+        label_space_or_index : dict[str,int] , int 
             Scoping of the requested mesh, for example:
             ``{"time": 1, "complex": 0}``
             or Index of the mesh.
@@ -90,7 +90,7 @@ def add_mesh(self, label_space, mesh):
 
         Parameters
         ----------
-        label_space : dict[string,int]
+        label_space : dict[str,int]
             label_space of the requested meshes, ex : {"elshape":1, "body":12}
 
         mesh : MeshedRegion

ansys/dpf/core/scopings_container.py

@@ -41,7 +41,7 @@ def get_scopings(self, label_space):
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int] , int
+        label_space_or_index : dict[str,int] , int
             Scopings corresponding to the filter (label space) in input, for example:
             ``{"elshape":1, "body":12}``
 
@@ -58,7 +58,7 @@ def get_scoping(self, label_space_or_index):
 
         Parameters
         ----------
-        label_space_or_index : dict[string,int] , int
+        label_space_or_index : dict[str,int] , int
             Scopings corresponding to the filter (label space) in input, for example:
             ``{"elshape":1, "body":12}``
             or Index of the scoping.
@@ -90,7 +90,7 @@ def add_scoping(self, label_space, scoping):
 
         Parameters
         ----------
-        label_space : dict[string,int]
+        label_space : dict[str,int]
             label_space of the requested scopings, ex : {"elshape":1, "body":12}
 
         scoping : Scoping

ansys/dpf/core/server.py

@@ -332,7 +332,7 @@ def ip(self):
         
         Returns
         -------
-        ip : string
+        ip : str
         """
         try:
             return self._base_service.server_info["server_ip"]
@@ -358,7 +358,7 @@ def version(self):
         
         Returns
         -------
-        version : string
+        version : str
         """
         return self._base_service.server_info["server_version"]