docstring12

ameli · Feb 7, 2021 · b3fb735 · b3fb735
1 parent 8dab875
commit b3fb735
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 40 deletions.
diff --git a/.github/workflows/build-linux.yml b/.github/workflows/build-linux.yml
@@ -1,9 +1,9 @@
 name: build-linux
 
 on:
-    # push:
-    #     branches:
-    #         - main
+    push:
+        branches:
+            - main
     release:
         types: 
             - published

diff --git a/.github/workflows/build-macos.yml b/.github/workflows/build-macos.yml
@@ -1,9 +1,9 @@
 name: build-macos
 
 on:
-    # push:
-    #     branches:
-    #         - main
+    push:
+        branches:
+            - main
     release:
         types: 
             - published

diff --git a/.github/workflows/build-windows.yml b/.github/workflows/build-windows.yml
@@ -1,9 +1,9 @@
 name: build-windows
 
 on:
-    # push:
-    #     branches:
-    #         - main
+    push:
+        branches:
+            - main
     release:
         types: 
             - published

diff --git a/.github/workflows/deploy-conda.yml b/.github/workflows/deploy-conda.yml
@@ -1,9 +1,9 @@
 name: deploy-conda
 
 on:
-    # push:
-    #     branches:
-    #         - main
+    push:
+        branches:
+            - main
     release:
         types: 
             - published

diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml
@@ -15,24 +15,6 @@ jobs:
             - name: Checkout
               uses: actions/checkout@v2
 
-            # - name: Set up Python
-            #   uses: actions/setup-python@v2
-            #   with:
-            #       python-version: 3.8
-
-            # - name: Install package and dependencies
-            #   run: |
-            #       export PATH=$HOME/.local/bin:$PATH
-            #       which python3
-            #       python3 --version
-            #       python3 -m pip install --upgrade pip
-            #       python3 -m pip install --upgrade setuptools
-            #       python3 -m pip install --upgrade numpy
-            #       export CYTHON_BUILD_IN_SOURCE=1
-            #       python3 setup.py build_ext --inplace
-            #   env:
-            #       CYTHON_BUILD_IN_SOURCE: 1
-
             - name: Build and Deploy
               uses: JacksonMaxfield/github-pages-deploy-action-python@master
               env:
@@ -42,21 +24,16 @@ jobs:
                   FOLDER: docs/_build/html
                   CYTHON_BUILD_IN_SOURCE: 1
                   BUILD_SCRIPT: |
-                      set -e
-                      set -x
                       apt-get update
                       apt-get install gfortran -y
                       apt-get install gcc -y
-                      which gfortran
-                      export PATH=$HOME/.local/bin:$PATH
-                      which python3
-                      python3 --version
                       python3 -m pip install --upgrade pip
                       python3 -m pip install --upgrade setuptools
                       python3 -m pip install --upgrade numpy
                       export CYTHON_BUILD_IN_SOURCE=1
                       python3 setup.py build_ext --inplace
                       python3 -m pip install sphinx sphinx-math-dollar sphinx-toggleprompt sphinx_rtd_theme sphinx-automodapi
+                      export PATH=$HOME/.local/bin:$PATH
                       sphinx-apidoc -f -o docs/_modules/ ./special_functions
                       make html --directory=docs
                       touch docs/_build/html/.nojekyll

diff --git a/.github/workflows/deploy-pypi.yml b/.github/workflows/deploy-pypi.yml
@@ -1,9 +1,9 @@
 name: deploy-pypi
 
 on:
-    # push:
-    #     branches:
-    #         - main
+    push:
+        branches:
+            - main
     release:
         types:
             - published

diff --git a/docs/index.rst b/docs/index.rst
@@ -80,7 +80,7 @@ We welcome contributions via `Github's pull request <https://github.com/ameli/sp
 Related Packages
 ================
 
-* `scipy.special <https://docs.scipy.org/doc/scipy/reference/special.html>`_: Many special functions were implemented in Scipy's special sub-package. This package is reimplements Bessel functions similar to ``scipy.special``, but with simplified python and cython different interfaces.
+* `scipy.special <https://docs.scipy.org/doc/scipy/reference/special.html>`_: Many special functions are available in *scipy.special* package.
 * `Gaussian Process <https://github.com/ameli/gaussian-process-param-estimation>`_: A python package that makes use of ``special_functions``.