Merge pull request #3224 from rajat2004/docs-gh-action

Add Actions script to build and deploy to gh-pages

.github/workflows/test_docs.yml

@@ -0,0 +1,47 @@
+name: Documentation Build & Deploy
+
+# Controls when the action will run.
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.7'
+          architecture: 'x64'
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install mkdocs pymdown-extensions    # Mkdocs requirements
+
+      - name: Build API reference docs
+        run: |
+          python3 -m venv .env                            # Virtual env to avoid dep. issues 
+          source .env/bin/activate
+          pip install Sphinx sphinx_rtd_theme numpy msgpack-rpc-python
+
+          pushd PythonClient >/dev/null
+          ./build_api_docs.sh
+          popd >/dev/null
+          cp -r PythonClient/docs/_build docs/api_docs/   # Copy generated files
+
+          deactivate
+
+      - name: Build AirSim Documentation
+        run: ./build_docs.sh
+
+      # Only on commits to 'master' branch
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
+        with:
+          github_token: $
+          publish_dir: ./build_docs
+

PythonClient/airsim/client.py

@@ -836,10 +836,12 @@ def simCreateVoxelGrid(self, position, x, y, z, res, of):
 
         Args:
             position (Vector3r): Position around which voxel grid is centered in m
-            x, y, z (float): Size of each voxel grid dimension in m
+            x, y, z (int): Size of each voxel grid dimension in m
             res (float): Resolution of voxel grid in m
             of (str): Name of output file to save voxel grid as
 
+        Returns:
+            bool: True if output written to file successfully, else False
         """
         return self.client.call('simCreateVoxelGrid', position, x, y, z, res, of)
 

PythonClient/airsim/utils.py

@@ -6,7 +6,6 @@
 import inspect
 import types
 import re
-import cv2      # pip install opencv-python
 import logging
 
 from .types import *
@@ -202,6 +201,8 @@ def write_pfm(file, image, scale=1):
 def write_png(filename, image):
     """ image must be numpy array H X W X channels
     """
+    import cv2      # pip install opencv-python
+
     ret = cv2.imwrite(filename, image)
     if not ret:
         logging.error(f"Writing PNG file {filename} failed")

PythonClient/build_api_docs.sh

@@ -1,2 +1,4 @@
-cd docs;
-make html;
+#!/bin/sh
+
+cd docs
+make html