diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 00000000..4abd9773 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,12 @@ +on: [status] +jobs: + circleci_artifacts_redirector_job: + runs-on: ubuntu-latest + name: Run CircleCI artifacts redirector + steps: + - name: GitHub Action step + uses: larsoner/circleci-artifacts-redirector-action@master + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + artifact-path: 0/html/index.html + circleci-jobs: build_docs diff --git a/doc/example.py b/doc/example.py index 33c55ccb..26522830 100644 --- a/doc/example.py +++ b/doc/example.py @@ -35,7 +35,7 @@ # numpy module itself, unabbreviated. -def foo(var1, var2, long_var_name='hi'): +def foo(var1, var2, *args, long_var_name='hi', **kwargs): r"""Summarize the function in one line. Several sentences providing an extended description. Refer to @@ -51,8 +51,12 @@ def foo(var1, var2, long_var_name='hi'): The type above can either refer to an actual Python type (e.g. ``int``), or describe the type of the variable in more detail, e.g. ``(N,) ndarray`` or ``array_like``. + *args : iterable + Other arguments. long_var_name : {'hi', 'ho'}, optional Choices in brackets, default first when optional. + **kwargs : dict + Keyword arguments. Returns -------