Enable all keyword arguments and extend documentation (#2)

Author: devmotion

.github/workflows/CI.yml

@@ -16,7 +16,6 @@ jobs:
         version:
           - '1.0'
           - '1'
-          - 'nightly'
         os:
           - ubuntu-latest
           - macOS-latest
@@ -62,6 +61,8 @@ jobs:
         env:
           PYTHON: ${{ matrix.python }}
       - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: ${{ matrix.coverage || false }}
         env:
           PYTHON: ${{ matrix.python }}
       - uses: julia-actions/julia-processcoverage@v1

.github/workflows/JuliaNightly.yml

@@ -0,0 +1,64 @@
+name: JuliaNightly
+
+# Nightly Version of Julia. Runs on PRs and pushes to `master`,
+# but seperate workflow to `CI` to avoid failure notifications.
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ (matrix.python && 'system Python') || 'conda' }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - 'nightly'
+        os:
+          - ubuntu-latest
+          - macOS-latest
+          - windows-latest
+        arch:
+          - x64
+        python:
+          - ''
+          - python
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.x'
+          architecture: ${{ matrix.arch }}
+        if: matrix.python
+      # Limitation of pip: https://pythonot.github.io/index.html#pip-installation
+      - run: python -m pip install cython numpy
+        if: matrix.python
+      - run: python -m pip install pot
+        if: matrix.python
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: actions/cache@v1
+        env:
+          cache-name: cache-artifacts
+        with:
+          path: ~/.julia/artifacts
+          key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-test-${{ env.cache-name }}-
+            ${{ runner.os }}-test-
+            ${{ runner.os }}-
+      - uses: julia-actions/julia-buildpkg@v1
+        env:
+          PYTHON: ${{ matrix.python }}
+      - uses: julia-actions/julia-runtest@v1
+        with:
+          coverage: ${{ matrix.coverage }}
+        env:
+          PYTHON: ${{ matrix.python }}

README.md

@@ -5,6 +5,7 @@
 [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://devmotion.github.io/POT.jl/stable)
 [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://devmotion.github.io/POT.jl/dev)
 [![Build Status](https://github.com/devmotion/POT.jl/workflows/CI/badge.svg?branch=main)](https://github.com/devmotion/POT.jl/actions?query=workflow%3ACI+branch%3Amain)
+[![Build Status (Julia nightly)](https://github.com/devmotion/POT.jl/workflows/JuliaNightly/badge.svg?branch=main)](https://github.com/devmotion/POT.jl/actions?query=workflow%3AJuliaNightly+branch%3Amain)
 [![Coverage](https://codecov.io/gh/devmotion/POT.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/devmotion/POT.jl)
 [![Coverage](https://coveralls.io/repos/github/devmotion/POT.jl/badge.svg?branch=main)](https://coveralls.io/github/devmotion/POT.jl?branch=main)
 [![Code Style: Blue](https://img.shields.io/badge/code%20style-blue-4495d1.svg)](https://github.com/invenia/BlueStyle)

docs/make.jl

@@ -22,6 +22,11 @@ makedocs(;
     pages=["Home" => "index.md", "api.md"],
     strict=true,
     checkdocs=:exports,
+    doctestfilters=[
+        r"{([a-zA-Z0-9]+,\s?)+[a-zA-Z0-9]+}",
+        r"(Array{[a-zA-Z0-9]+,\s?1}|Vector{[a-zA-Z0-9]+})",
+        r"(Array{[a-zA-Z0-9]+,\s?2}|Matrix{[a-zA-Z0-9]+})",
+    ],
 )
 
 deploydocs(; repo="github.com/devmotion/POT.jl", push_preview=true, devbranch="main")