seperate doc deploy workflow

Author: bearzx

.github/workflows/deploy-doc.yml

@@ -0,0 +1,48 @@
+name: Deploy Doc
+on:
+  schedule:
+    - cron: "0 0 * * *"
+
+  pull_request:
+    branches:
+      - main
+      # For PR created by ghstack
+      - gh/*/*/base
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Setup Python environment
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.7
+
+      - name: Check out source repository
+        uses: actions/checkout@v2
+        with:
+            # ref: "release/0.1.0"
+            submodules: recursive
+
+      - name: Install TorchArrow
+        run: |
+          pip install --pre torcharrow -f https://download.pytorch.org/whl/nightly/cpu/torch_nightly.html
+
+      - name: Build the docs
+        run: |
+          cd ./docs
+          pip install -r requirements.txt --user
+          make html
+          cd ..
+
+      - name: Deploy Docs on Push
+        uses: JamesIves/github-pages-deploy-action@releases/v3
+        with:
+          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages # The branch the action should deploy to.
+          FOLDER: docs/build/html # The folder the action should deploy.
+          TARGET_FOLDER: 0.1.0

.github/workflows/ubuntu.yml

@@ -77,18 +77,3 @@ jobs:
       - name : Install TorchArrow
         run: |
           CCACHE_DIR=$GITHUB_WORKSPACE/.ccache python setup.py install --user
-        
-      - name: Build the docs
-        run: |
-          cd ./docs
-          pip3 install -r requirements.txt --user
-          make html 
-          cd ..
-
-      - name: Deploy Docs on Push
-        if: ${{ github.event_name == 'push' }}
-        uses: JamesIves/github-pages-deploy-action@releases/v3
-        with:
-          ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          BRANCH: gh-pages # The branch the action should deploy to.
-          FOLDER: docs/build/html # The folder the action should deploy.

docs/source/column.rst

@@ -40,6 +40,7 @@ Column class reference
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: class.rst
 
     Column.head
     Column.tail
@@ -73,6 +74,7 @@ NumericalColumn class reference
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: class.rst
 
     NumericalColumn.abs
     NumericalColumn.ceil
@@ -96,6 +98,7 @@ StringColumn class reference
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: class.rst
 
     istring_column.StringMethods.length
     istring_column.StringMethods.slice
@@ -131,6 +134,7 @@ ListColumn class reference
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: class.rst
 
     ilist_column.ListMethods.length
     ilist_column.ListMethods.slice

docs/source/dataframe.rst

@@ -25,6 +25,7 @@ DataFrame Class and General APIs
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: class.rst
 
     DataFrame.head
     DataFrame.tail
@@ -42,6 +43,7 @@ Functional API
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.map
     DataFrame.filter
@@ -54,6 +56,7 @@ Relational API
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.select
     DataFrame.where
@@ -64,6 +67,7 @@ Data Cleaning
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.fill_null
     DataFrame.drop_null
@@ -74,6 +78,7 @@ Conversions
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.to_arrow
     DataFrame.to_tensor
@@ -85,6 +90,7 @@ Statistics
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.min
     DataFrame.max
@@ -100,5 +106,6 @@ Arithmtic Operations
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     DataFrame.log

docs/source/functional.rst

@@ -37,6 +37,7 @@ Recommendation Operations
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     bucketize
     sigrid_hash
@@ -55,5 +56,6 @@ High-level Operations
 .. autosummary::
     :toctree: generated
     :nosignatures:
+    :template: function.rst
 
     scale_to_0_1

docs/source/torcharrow.rst

@@ -4,8 +4,8 @@ torcharrow
 ==========================
 
 The torcharrow package contains data structures for two-dimensional, potentially heterogeneous tabular data,
-denoted as dataframe. 
-It also defines relational operations over these dataframes. 
+denoted as dataframe.
+It also defines relational operations over these dataframes.
 Additionally, it provides utilities for conversion with other formats (especially zero-copy conversion with Arrow arrays),
 and other useful utilities.
 
@@ -28,4 +28,3 @@ Mutating Ops
 
     concat
     if_else
-