Add linux doc build (#122)

* Add linux doc build

* Add sphinx-apidoc

Author: jleonatti

.ci/azure-pipelines.yml

@@ -33,7 +33,7 @@ jobs:
     vmImage: 'windows-2019'
 
   steps:  
-    - template: templates\prepare-environment-windows.yml   
+    - template: templates\prepare-environment-windows.yml
 
     - task: PublishBuildArtifacts@1
       displayName: 'WHEEL: publish artifacts'
@@ -114,80 +114,20 @@ jobs:
     PYANSYS_OFF_SCREEN: True
     DPF_PORT: 50055
     TEMP: $(System.DefaultWorkingDirectory)/temp
+    AWP_ROOT212: $(System.DefaultWorkingDirectory)/server/v212
 
   pool:
     vmImage: 'ubuntu-20.04'
   steps:
-    - task: UsePythonVersion@0
-      inputs:
-        versionSpec: '$(python.version)'
-      displayName: 'Use Python $(python.version)'
-
-    - task: PipAuthenticate@1
-      inputs:
-        artifactFeeds: 'pyansys'
-        onlyAddExtraIndex: true
-
-    - script: |
-        .ci/setup_headless_display.sh
-        pip install -r .ci/requirements_test_xvfb.txt
-        python .ci/display_test.py
-      displayName: Install and start a virtual framebuffer
-
-    - script: |
-        pip install -r requirements_build.txt
-        python setup.py bdist_wheel
-        export WHEELNAME=`ls dist/*.whl`
-        echo ${WHEELNAME}
-        pip install ${WHEELNAME}
-        cd tests
-        python -c "from ansys.dpf import core; print(core.Report())"
-      displayName: Install ansys-dpf-core
+    - template: templates\prepare-environment-linux.yml
 
-    - task: UniversalPackages@0
-      inputs:
-        command: 'download'
-        downloadDirectory: '$(System.DefaultWorkingDirectory)'
-        feedsToUse: 'internal'
-        vstsFeed: '705e121a-9631-49f5-8aaf-c7142856f923'
-        vstsFeedPackage: 'dpf-linux' #TODO: update hash of packages
-        vstsPackageVersion: '21.2.5'
-        
-    - script : |
-        echo $0
-        if pgrep -x "Ans.Dpf.Grpc" > /dev/null
-        then
-            pkill -f Ans.Dpf.Grpc.exe
-        fi
-      displayName: 'Kill all servers'
-      condition: always()
-      continueOnError: true
-      
-    - script: |
-        env
-      displayName: Display env
-      
-    - script: |
-        echo $0
-        export THISDIR=${SYSTEM_DEFAULTWORKINGDIRECTORY}
-        echo ${THISDIR}
-        export AWP_ROOT212=${THISDIR}/server/v212
-        cd ${THISDIR}/server/v212/aisol/bin/linx64
-        pwd
-        chmod 755 Ans.Dpf.Grpc.sh
-        chmod 755 Ans.Dpf.Grpc.exe        
-        ./Ans.Dpf.Grpc.sh --port 50054 & > log.txt
-        export DPF_IP=$(hostname -i)
-        python -c "from ansys.dpf import core; core.connect_to_server(ip= '${DPF_IP}', port=50054); print('Python Connected')"
-      displayName: Start DPF Server
-      
     - script: |
         pip install -r requirements_test.txt
         pip install pytest-azurepipelines        
         export AWP_ROOT212=${SYSTEM_DEFAULTWORKINGDIRECTORY}/server/v212
         cd tests
         export DPF_IP=$(hostname -i)
-        pytest -v --junitxml=junit/test-results.xml --cov ansys.dpf.core --cov-report=xml  --reruns 3      
+        xvfb-run pytest -v --junitxml=junit/test-results.xml --cov ansys.dpf.core --cov-report=xml  --reruns 3      
         export PATH=`pwd`
         echo ${PATH} 
       displayName: Test Core API
@@ -212,46 +152,45 @@ jobs:
       condition: always()
       continueOnError: true
 
-
-- job: DocumentationWindows
+- job: DocumentationLinux
   variables:
-    python.version: '3.8'
-    DISPLAY: ':99.0'
+    python.version: '3.7'  # due to VTK 8.1.2 requirement for docbuild
     PYANSYS_OFF_SCREEN: True
-    DPF_PORT: 32772
+    DPF_PORT: 50055
+    TEMP: $(System.DefaultWorkingDirectory)/temp
+    AWP_ROOT212: $(System.DefaultWorkingDirectory)/server/v212
     GH_DOC_BRANCH: 'gh-pages'
+    
   pool:
-    vmImage: 'windows-2019'
+    vmImage: 'ubuntu-20.04'
+  steps:
+    - template: templates\prepare-environment-linux.yml
 
-  steps:  
-    - template: templates\prepare-environment-windows.yml    
-   
     - script: |
-          pip install -r requirements_docs.txt
-          cd .ci
-          dir 
-          set THISDIR=$(System.DefaultWorkingDirectory)
-          set AWP_ROOT212=%THISDIR%\server\v212
-          ECHO %AWP_ROOT212%
-          build_doc.bat
+        pip install -r requirements_docs.txt
+      displayName: Install documentation packages for Python
+
+    - script: |
+        sphinx-apidoc -o docs/source/api ansys ansys/dpf/core/aeneid.py -f --implicit-namespaces --separate --no-headings
+        xvfb-run make -C docs html SPHINXOPTS="-w build_errors.txt -N"
       displayName: Build Documentation
-        
+
     - task: ArchiveFiles@2
       inputs:
-        rootFolderOrFile: '$(System.DefaultWorkingDirectory)\docs\build' 
+        rootFolderOrFile: '$(System.DefaultWorkingDirectory)/docs/build' 
         includeRootFolder: false 
         archiveType: 'zip'
-        archiveFile: '$(System.DefaultWorkingDirectory)\docs\archive\doc-ansys-dpf-core.zip'
+        archiveFile: '$(System.DefaultWorkingDirectory)/docs/archive/doc-ansys-dpf-core.zip'
         replaceExistingArchive: true 
       displayName: 'DOCUMENTATION: zip artifacts'
 
     - task: PublishBuildArtifacts@1
       displayName: 'DOCUMENTATION: publish artifacts'
       inputs:
-        PathtoPublish: '$(System.DefaultWorkingDirectory)\docs\archive'
+        PathtoPublish: '$(System.DefaultWorkingDirectory)/docs/archive'
         ArtifactName: doc-ansys-dpf-core
-      enabled: true      
-        
+      enabled: true   
+
     - powershell: |
         git init
         git checkout -b $(GH_DOC_BRANCH)
@@ -261,15 +200,21 @@ jobs:
         git add .
         git commit -m "Documentation generated by $(Build.DefinitionName)"
       displayName: "Init git and add docs"
-      workingDirectory: docs\build\html
+      workingDirectory: docs/build/html
 
     - script: |
         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
+      workingDirectory: docs/build/html
       condition: contains(variables['Build.SourceBranch'], 'refs/tags/')
-          
-    - template: templates\kill-servers-windows.yml    
-    
-      
+
+    - script : |
+        echo $0
+        if pgrep -x "Ans.Dpf.Grpc" > /dev/null
+        then
+            pkill -f Ans.Dpf.Grpc.exe
+        fi
+      displayName: 'Kill all servers'
+      condition: always()
+      continueOnError: true

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

@@ -0,0 +1,64 @@
+steps:
+  - task: UsePythonVersion@0
+    inputs:
+      versionSpec: "$(python.version)"
+    displayName: "Use Python $(python.version)"
+
+  - task: PipAuthenticate@1
+    inputs:
+      artifactFeeds: "pyansys"
+      onlyAddExtraIndex: true
+
+  - script: |
+      sudo apt update
+      sudo apt install zip pandoc libgl1-mesa-glx xvfb
+    displayName: Install OS packages
+
+  - script: |
+      pip install -r .ci/requirements_test_xvfb.txt
+      xvfb-run python .ci/display_test.py
+    displayName: Test virtual framebuffer
+
+  - script: |
+      pip install -r requirements_build.txt
+      python setup.py bdist_wheel
+      export WHEELNAME=`ls dist/*.whl`
+      echo ${WHEELNAME}
+      pip install ${WHEELNAME}
+      cd tests
+      xvfb-run python -c "from ansys.dpf import core; print(core.Report())"
+    displayName: Install ansys-dpf-core
+
+  - task: UniversalPackages@0
+    inputs:
+      command: "download"
+      downloadDirectory: "$(System.DefaultWorkingDirectory)"
+      feedsToUse: "internal"
+      vstsFeed: "705e121a-9631-49f5-8aaf-c7142856f923"
+      vstsFeedPackage: "dpf-linux" #TODO: update hash of packages
+      vstsPackageVersion: "21.2.5"
+    displayName: Download DPF linux package
+
+  - script: |
+      echo $0
+      if pgrep -x "Ans.Dpf.Grpc" > /dev/null
+      then
+          pkill -f Ans.Dpf.Grpc.exe
+      fi
+    displayName: "Kill all servers"
+    condition: always()
+    continueOnError: true
+
+  - script: |
+      env
+    displayName: Display env
+
+  - script: |
+      cd ${AWP_ROOT212}/aisol/bin/linx64
+      pwd
+      chmod 755 Ans.Dpf.Grpc.sh
+      chmod 755 Ans.Dpf.Grpc.exe
+      ./Ans.Dpf.Grpc.sh --port 50054 & > log.txt
+      export DPF_IP=$(hostname -i)
+      python -c "from ansys.dpf import core; core.connect_to_server(ip= '${DPF_IP}', port=50054); print('Python Connected')"
+    displayName: Start DPF Server

examples/00-basic/06-load_plugin.py

@@ -8,14 +8,17 @@
 """
 
 ###############################################################################
-# Import DPF-Core:
+import os
 
+# Import DPF-Core:
 from ansys.dpf import core as dpf
 
 ###############################################################################
 # Create a base service for loading a plugin:
-
-dpf.core.load_library("Ans.Dpf.Math.dll", "math_operators")
+if os.name == "posix":
+    dpf.core.load_library("libAns.Dpf.Math.so", "math_operators")
+else:
+    dpf.core.load_library("Ans.Dpf.Math.dll", "math_operators")
 
 ###############################################################################
 # Math operators are now loaded and accessible in ``ansys.dpf.core.operators``:

examples/04-specific-requests/00-hdf5_double_float_comparison.py

@@ -56,20 +56,24 @@
 ###############################################################################
 # Export with simple precision
 
-h5op.inputs.file_path.connect(os.path.join(tmpdir, "c:/temp/dpf_float.h5"))
+directory = "c:/temp/"
+if os.name == "posix":
+    directory = "/tmp/"
+
+h5op.inputs.file_path.connect(os.path.join(tmpdir, directory, "dpf_float.h5"))
 h5op.run()
 
 ###############################################################################
 # Export with simple precision
 
 h5op.inputs.export_floats.connect(False)
-h5op.inputs.file_path.connect(os.path.join(tmpdir, "c:/temp/dpf_double.h5"))
+h5op.inputs.file_path.connect(os.path.join(tmpdir, directory, "dpf_double.h5"))
 h5op.run()
 
 ###############################################################################
 # Comparison
-float_precision = os.stat(os.path.join(tmpdir, "c:/temp/dpf_float.h5")).st_size
-double_precision = os.stat(os.path.join(tmpdir, "c:/temp/dpf_double.h5")).st_size
+float_precision = os.stat(os.path.join(tmpdir, directory, "dpf_float.h5")).st_size
+double_precision = os.stat(os.path.join(tmpdir, directory, "dpf_double.h5")).st_size
 print(
     f"size with float precision: {float_precision}\n"
     f"size with double precision: {double_precision}"