Merge pull request #367 from steff456/linalg-rst

PR: Transform linear algebra functions md to rst

Author: asmeurer

.circleci/config.yml

@@ -5,7 +5,7 @@ _defaults: &defaults
   docker:
     # CircleCI maintains a library of pre-built images
     # documented at https://circleci.com/docs/2.0/circleci-images/
-    - image: circleci/python:3.8.0
+    - image: cimg/python:3.10.2
   working_directory: ~/repo
 
 jobs:
@@ -19,7 +19,7 @@ jobs:
           name: build docs
           no_output_timeout: 25m
           command: |
-            sudo pip install -r requirements.txt
+            pip install -r requirements.txt
             sphinx-build -b html -WT --keep-going spec build/latest -d doctrees
       - store_artifacts:
           path: build/latest

.github/workflows/pages.yml

@@ -15,7 +15,7 @@ jobs:
     - uses: actions/checkout@master
     - uses: actions/setup-python@v2
       with:
-        python-version: '3.8' # Version range or exact version of a Python version to use, using semvers version range syntax.
+        python-version: '3.10.2' # Version range or exact version of a Python version to use, using semvers version range syntax.
         architecture: 'x64' # (x64 or x86)
     - run: |
         # add dependencies based on the conf.py

spec/API_specification/linear_algebra_functions.md

@@ -0,0 +1,29 @@
+Linear Algebra Functions
+========================
+
+  Array API specification for linear algebra functions.
+
+A conforming implementation of the array API standard must provide and support the following functions adhering to the following conventions.
+
+* Positional parameters must be `positional-only <https://www.python.org/dev/peps/pep-0570/>`_ parameters. Positional-only parameters have no externally-usable name. When a function accepting positional-only parameters is called, positional arguments are mapped to these parameters based solely on their order.
+* Optional parameters must be `keyword-only <https://www.python.org/dev/peps/pep-3102/>`_ arguments.
+* Broadcasting semantics must follow the semantics defined in :ref:`broadcasting`.
+* Unless stated otherwise, functions must support the data types defined in :ref:`data-types`.
+* Unless stated otherwise, functions must adhere to the type promotion rules defined in :ref:`type-promotion`.
+* Unless stated otherwise, floating-point operations must adhere to IEEE 754-2019.
+
+.. currentmodule:: signatures.linear_algebra_functions
+
+Objects in API
+--------------
+..
+  NOTE: please keep the functions in alphabetical order
+
+.. autosummary::
+   :toctree: generated
+   :template: method.rst
+
+   matmul
+   matrix_transpose
+   tensordot
+   vecdot

spec/API_specification/linear_algebra_functions.rst

@@ -614,7 +614,7 @@ def __matmul__(self: array, other: array, /) -> array:
 
 
         .. note::
-           Results must equal the results returned by the equivalent function :ref:`function-matmul`.
+           Results must equal the results returned by the equivalent function :func:`signatures.linear_algebra_functions.matmul`.
 
         **Raises**