Fix 2021.12 building

honno · honno · commit ada910275c21 · 2023-01-06T14:06:02.000Z
diff --git a/spec/2021.12/API_specification/array_object.rst b/spec/2021.12/API_specification/array_object.rst
@@ -246,7 +246,7 @@ Bitwise Operators
 
 -------------------------------------------------
 
-.. currentmodule:: signatures.array_object
+.. currentmodule:: array_api
 
 Attributes
 ----------
diff --git a/spec/2021.12/API_specification/constants.rst b/spec/2021.12/API_specification/constants.rst
@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.constants
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/creation_functions.rst b/spec/2021.12/API_specification/creation_functions.rst
@@ -11,7 +11,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.creation_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/data_type_functions.rst b/spec/2021.12/API_specification/data_type_functions.rst
@@ -9,7 +9,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.data_type_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/data_types.rst b/spec/2021.12/API_specification/data_types.rst
@@ -100,7 +100,7 @@ Methods
 ..
   NOTE: please keep the functions in alphabetical order
 
-.. currentmodule:: signatures.data_types
+.. currentmodule:: array_api
 
 .. autosummary::
    :toctree: generated
diff --git a/spec/2021.12/API_specification/elementwise_functions.rst b/spec/2021.12/API_specification/elementwise_functions.rst
@@ -19,7 +19,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.elementwise_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/indexing.rst b/spec/2021.12/API_specification/indexing.rst
@@ -154,7 +154,7 @@ Multi-dimensional arrays must extend the concept of single-axis indexing to mult
 - Each ``None`` in the selection tuple must expand the dimensions of the resulting selection by one dimension of size ``1``. The position of the added dimension must be the same as the position of ``None`` in the selection tuple.
 
   .. note::
-    Expanding dimensions can be equivalently achieved via repeated invocation of :func:`~signatures.manipulation_functions.expand_dims`.
+    Expanding dimensions can be equivalently achieved via repeated invocation of :func:`~array_api.expand_dims`.
 
 - Except in the case of providing a single ellipsis (e.g., ``A[2:10, ...]`` or ``A[1:, ..., 2:5]``), the number of provided single-axis indexing expressions (excluding ``None``) should equal ``N``. For example, if ``A`` has rank ``2``, a single-axis indexing expression should be explicitly provided for both axes (e.g., ``A[2:10, :]``). An ``IndexError`` exception should be raised if the number of provided single-axis indexing expressions (excluding ``None``) is less than ``N``.
 
@@ -181,7 +181,7 @@ Boolean Array Indexing
 An array must support indexing where the **sole index** is an ``M``-dimensional boolean array ``B`` with shape ``S1 = (s1, ..., sM)`` according to the following rules. Let ``A`` be an ``N``-dimensional array with shape ``S2 = (s1, ..., sM, ..., sN)``.
 
   .. note::
-     The prohibition against combining boolean array indices with other single-axis indexing expressions includes the use of ``None``. To expand dimensions of the returned array, use repeated invocation of :func:`~signatures.manipulation_functions.expand_dims`.
+     The prohibition against combining boolean array indices with other single-axis indexing expressions includes the use of ``None``. To expand dimensions of the returned array, use repeated invocation of :func:`~array_api.expand_dims`.
 
 - If ``N >= M``, then ``A[B]`` must replace the first ``M`` dimensions of ``A`` with a single dimension having a size equal to the number of ``True`` elements in ``B``. The values in the resulting array must be in row-major (C-style order); this is equivalent to ``A[nonzero(B)]``.
 
diff --git a/spec/2021.12/API_specification/linear_algebra_functions.rst b/spec/2021.12/API_specification/linear_algebra_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 * 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
+.. currentmodule:: array_api
 
 Objects in API
 --------------
diff --git a/spec/2021.12/API_specification/manipulation_functions.rst b/spec/2021.12/API_specification/manipulation_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.manipulation_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/searching_functions.rst b/spec/2021.12/API_specification/searching_functions.rst
@@ -16,7 +16,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.searching_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/set_functions.rst b/spec/2021.12/API_specification/set_functions.rst
@@ -12,7 +12,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.set_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/sorting_functions.rst b/spec/2021.12/API_specification/sorting_functions.rst
@@ -19,7 +19,7 @@ A conforming implementation of the array API standard must provide and support t
 
   While defining a sort order for IEEE 754 floating-point numbers is recommended in order to facilitate reproducible and consistent sort results, doing so is not currently required by this specification.
 
-.. currentmodule:: signatures.sorting_functions
+.. currentmodule:: array_api
 
 Objects in API
 --------------
diff --git a/spec/2021.12/API_specification/statistical_functions.rst b/spec/2021.12/API_specification/statistical_functions.rst
@@ -15,7 +15,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.statistical_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/API_specification/utility_functions.rst b/spec/2021.12/API_specification/utility_functions.rst
@@ -15,7 +15,7 @@ A conforming implementation of the array API standard must provide and support t
 Objects in API
 --------------
 
-.. currentmodule:: signatures.utility_functions
+.. currentmodule:: array_api
 
 ..
   NOTE: please keep the functions in alphabetical order
diff --git a/spec/2021.12/conf.py b/spec/2021.12/conf.py
@@ -1,206 +1,7 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
 import sys
-import sphinx_material
-sys.path.insert(0, os.path.abspath('./API_specification'))
-
-# -- Project information -----------------------------------------------------
-
-project = 'Python array API standard'
-copyright = '2020, Consortium for Python Data API Standards'
-author = 'Consortium for Python Data API Standards'
-
-# The full version, including alpha/beta/rc tags
-release = '2021.12'
-
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    'myst_parser',
-    'sphinx.ext.extlinks',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
-    'sphinx_markdown_tables',
-    'sphinx_copybutton',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autodoc',
-]
-
-autosummary_generate = True
-autodoc_typehints = 'signature'
-add_module_names = False
-napoleon_custom_sections = [('Returns', 'params_style')]
-default_role = 'code'
-
-# nitpicky = True makes Sphinx warn whenever a cross-reference target can't be
-# found.
-nitpicky = True
-# autodoc wants to make cross-references for every type hint. But a lot of
-# them don't actually refer to anything that we have a document for.
-nitpick_ignore = [
-    ('py:class', 'array'),
-    ('py:class', 'device'),
-    ('py:class', 'dtype'),
-    ('py:class', 'NestedSequence'),
-    ('py:class', 'SupportsBufferProtocol'),
-    ('py:class', 'collections.abc.Sequence'),
-    ('py:class', "Optional[Union[int, float, Literal[inf, - inf, 'fro', 'nuc']]]"),
-    ('py:class', "Union[int, float, Literal[inf, - inf]]"),
-    ('py:obj', "typing.Optional[typing.Union[int, float, typing.Literal[inf, - inf, 'fro', 'nuc']]]"),
-    ('py:obj', "typing.Union[int, float, typing.Literal[inf, - inf]]"),
-    ('py:class', 'PyCapsule'),
-    ('py:class', 'enum.Enum'),
-    ('py:class', 'ellipsis'),
-    ('py:class', 'finfo_object'),
-    ('py:class', 'iinfo_object'),
-]
-# In array_object.py we have to use aliased names for some types because they
-# would otherwise refer back to method objects of array
-autodoc_type_aliases = {
-    'array': 'array',
-    'Device': 'device',
-    'Dtype': 'dtype',
-}
-
-# Make autosummary show the signatures of functions in the tables using actual
-# Python syntax. There's currently no supported way to do this, so we have to
-# just patch out the function that processes the signatures. See
-# https://github.com/sphinx-doc/sphinx/issues/10053.
-import sphinx.ext.autosummary as autosummary_mod
-if hasattr(autosummary_mod, '_module'):
-    # It's a sphinx deprecated module wrapper object
-    autosummary_mod = autosummary_mod._module
-autosummary_mod.mangle_signature = lambda sig, max_chars=30: sig
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
-# MyST options
-myst_heading_anchors = 3
-myst_enable_extensions = ["colon_fence"]
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-extensions.append("sphinx_material")
-html_theme_path = sphinx_material.html_theme_path()
-html_context = sphinx_material.get_html_context()
-html_theme = 'sphinx_material'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
-
-
-# -- Material theme options (see theme.conf for more information) ------------
-html_show_sourcelink = False
-html_sidebars = {
-    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
-}
-
-html_theme_options = {
-
-    # Set the name of the project to appear in the navigation.
-    'nav_title': f'Python array API standard {release}',
-
-    # Set you GA account ID to enable tracking
-    #'google_analytics_account': 'UA-XXXXX',
-
-    # Specify a base_url used to generate sitemap.xml. If not
-    # specified, then no sitemap will be built.
-    #'base_url': 'https://project.github.io/project',
-
-    # Set the color and the accent color (see
-    # https://material.io/design/color/the-color-system.html)
-    'color_primary': 'indigo',
-    'color_accent': 'green',
-
-    # Set the repo location to get a badge with stats
-    #'repo_url': 'https://github.com/project/project/',
-    #'repo_name': 'Project',
-
-    "html_minify": False,
-    "html_prettify": False,
-    "css_minify": True,
-    "logo_icon": "&#xe869",
-    "repo_type": "github",
-    "touch_icon": "images/apple-icon-152x152.png",
-    "theme_color": "#2196f3",
-    "master_doc": False,
-
-    # Visible levels of the global TOC; -1 means unlimited
-    'globaltoc_depth': 2,
-    # If False, expand all TOC entries
-    'globaltoc_collapse': True,
-    # If True, show hidden TOC entries
-    'globaltoc_includehidden': True,
-
-    "nav_links": [
-        {"href": "index", "internal": True, "title": "Array API standard"},
-        {
-            "href": "https://data-apis.org",
-            "internal": False,
-            "title": "Consortium for Python Data API Standards",
-        },
-    ],
-    "heroes": {
-        "index": "A common API for array and tensor Python libraries",
-        #"customization": "Configuration options to personalize your site.",
-    },
-
-    "version_dropdown": True,
-    "version_json": "../versions.json",
-    "table_classes": ["plain"],
-}
-
-
-todo_include_todos = True
-#html_favicon = "images/favicon.ico"
-
-html_use_index = True
-html_domain_indices = True
-
-extlinks = {
-    "duref": (
-        "http://docutils.sourceforge.net/docs/ref/rst/" "restructuredtext.html#%s",
-        "",
-    ),
-    "durole": ("http://docutils.sourceforge.net/docs/ref/rst/" "roles.html#%s", ""),
-    "dudir": ("http://docutils.sourceforge.net/docs/ref/rst/" "directives.html#%s", ""),
-    "pypa": ("https://packaging.python.org/%s", ""),
-}
-
 
-def process_signature(app, what, name, obj, options, signature, return_annotation):
-    if signature:
-        signature = signature.replace("signatures._types.", "")
-    if return_annotation:
-        return_annotation = return_annotation.replace("signatures._types.", "")
-    return signature, return_annotation
+from array_api_stubs import _2021_12 as stubs_mod
+from _array_api_conf import *
 
-def setup(app):
-    app.connect("autodoc-process-signature", process_signature)
+release = "2021.12"
+sys.modules["array_api"] = stubs_mod
diff --git a/spec/2021.12/extensions/linear_algebra_functions.rst b/spec/2021.12/extensions/linear_algebra_functions.rst
@@ -74,7 +74,7 @@ Accordingly, the standardization process affords the opportunity to reduce inter
 
     where ``dot`` is overloaded based on input array dimensionality and ``vdot`` and ``inner`` exhibit a high degree of overlap with other interfaces. By consolidating interfaces and more clearly delineating behavior, this specification aims to ensure that each interface has a unique purpose and defined use case.
 
-.. currentmodule:: signatures.linalg
+.. currentmodule:: array_api.linalg
 
 Objects in API
 --------------
diff --git a/spec/2022.12/API_specification/data_types.rst b/spec/2022.12/API_specification/data_types.rst
@@ -101,13 +101,13 @@ Methods
 ..
   NOTE: please keep the functions in alphabetical order
 
-.. currentmodule:: array_api.data_types
+.. currentmodule:: array_api
 
 .. autosummary::
    :toctree: generated
    :template: method.rst
 
-   __eq__
+   dtype.__eq__
 
 
 .. _data-type-defaults:
diff --git a/src/array_api_stubs/_2021_12/__init__.py b/src/array_api_stubs/_2021_12/__init__.py
@@ -0,0 +1,22 @@
+"""Function stubs and API documentation for the array API standard."""
+
+from .array_object import *
+from .constants import *
+from .creation_functions import *
+from .data_type_functions import *
+from . import data_types as dtype
+from .elementwise_functions import *
+from .linear_algebra_functions import *
+from .manipulation_functions import *
+from .searching_functions import *
+from .set_functions import *
+from .sorting_functions import *
+from .statistical_functions import *
+from .utility_functions import *
+from . import linalg
+
+
+__array_api_version__: str = "YYYY.MM"
+"""
+String representing the version of the array API specification which the conforming implementation adheres to.
+"""
diff --git a/src/array_api_stubs/_2021_12/array_object.py b/src/array_api_stubs/_2021_12/array_object.py
diff --git a/src/array_api_stubs/_2021_12/creation_functions.py b/src/array_api_stubs/_2021_12/creation_functions.py
diff --git a/src/array_api_stubs/_2021_12/linalg.py b/src/array_api_stubs/_2021_12/linalg.py
diff --git a/src/array_api_stubs/_2022_12/__init__.py b/src/array_api_stubs/_2022_12/__init__.py
diff --git a/src/array_api_stubs/_draft/__init__.py b/src/array_api_stubs/_draft/__init__.py
