Skip to content

Commit 293512d

Browse files
authored
Upgrade Sphinx version used in doc deployment (#735)
* Upgrade Sphinx version used in doc deployment It was breaking with: ``` sphinx-build "spec/2021.12" "_site/2021.12" -W --keep-going Running Sphinx v4.3.0 Sphinx version error: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. ``` * Fix some doc build warnings that broke in CI
1 parent 0cde841 commit 293512d

11 files changed

+15
-14
lines changed

Diff for: doc-requirements.txt

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
sphinx==4.3.0
1+
sphinx==6.2.1
22
sphinx-material==0.0.30
33
myst-parser
44
sphinx_markdown_tables
55
sphinx_copybutton
66
sphinx_favicon
7-
docutils<0.18
87
sphinx-math-dollar

Diff for: spec/2021.12/assumptions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.
2626

2727
The only dependency that's assumed in this standard is that on Python itself.
2828
Python >= 3.8 is assumed, motivated by the use of positional-only parameters
29-
(see [function and method signatures](API_specification/function_and_method_signatures.md)).
29+
(see [function and method signatures](API_specification/function_and_method_signatures.rst)).
3030

3131
Importantly, array libraries are not assumed to be aware of each other, or of
3232
a common array-specific layer. The [use cases](use_cases.md) do not require
@@ -39,7 +39,7 @@ for that is:
3939

4040
Array libraries may know how to interoperate with each other, for example by
4141
constructing their own array type from that of another library or by shared
42-
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.md)).
42+
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.rst)).
4343
This can be done without a dependency though - only adherence to a protocol is
4444
enough.
4545

Diff for: spec/2021.12/purpose_and_scope.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ standard is shown in this diagram:
151151
_Rationale: this is an important topic for some array-consuming libraries,
152152
but there is no widely shared C/Cython API and hence it doesn't make sense at
153153
this point in time to standardize anything. See
154-
the [C API section](design_topics/C_API.md) for more details._
154+
the [C API section](design_topics/C_API.rst) for more details._
155155

156156
4. Standardization of these dtypes is out of scope: bfloat16, complex, extended
157157
precision floating point, datetime, string, object and void dtypes.

Diff for: spec/2021.12/use_cases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ array implementation as a dependency.
5959

6060
It's clear that SciPy functionality that relies on compiled extensions (C,
6161
C++, Cython, Fortran) directly can't easily be run on another array library
62-
than NumPy (see [C API](design_topics/C_API.md) for more details about this topic). Pure Python
62+
than NumPy (see [C API](design_topics/C_API.rst) for more details about this topic). Pure Python
6363
code can work though. There's two main possibilities:
6464

6565
1. Testing with another package, manually or in CI, and simply provide a list

Diff for: spec/2022.12/assumptions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.
2626

2727
The only dependency that's assumed in this standard is that on Python itself.
2828
Python >= 3.8 is assumed, motivated by the use of positional-only parameters
29-
(see [function and method signatures](API_specification/function_and_method_signatures.md)).
29+
(see [function and method signatures](API_specification/function_and_method_signatures.rst)).
3030

3131
Importantly, array libraries are not assumed to be aware of each other, or of
3232
a common array-specific layer. The [use cases](use_cases.md) do not require
@@ -39,7 +39,7 @@ for that is:
3939

4040
Array libraries may know how to interoperate with each other, for example by
4141
constructing their own array type from that of another library or by shared
42-
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.md)).
42+
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.rst)).
4343
This can be done without a dependency though - only adherence to a protocol is
4444
enough.
4545

Diff for: spec/2022.12/purpose_and_scope.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ standard is shown in this diagram:
151151
_Rationale: this is an important topic for some array-consuming libraries,
152152
but there is no widely shared C/Cython API and hence it doesn't make sense at
153153
this point in time to standardize anything. See
154-
the [C API section](design_topics/C_API.md) for more details._
154+
the [C API section](design_topics/C_API.rst) for more details._
155155

156156
4. Standardization of these dtypes is out of scope: bfloat16, extended
157157
precision floating point, datetime, string, object and void dtypes.

Diff for: spec/2022.12/use_cases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ array implementation as a dependency.
5959

6060
It's clear that SciPy functionality that relies on compiled extensions (C,
6161
C++, Cython, Fortran) directly can't easily be run on another array library
62-
than NumPy (see [C API](design_topics/C_API.md) for more details about this topic). Pure Python
62+
than NumPy (see [C API](design_topics/C_API.rst) for more details about this topic). Pure Python
6363
code can work though. There's two main possibilities:
6464

6565
1. Testing with another package, manually or in CI, and simply provide a list

Diff for: spec/draft/assumptions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.
2626

2727
The only dependency that's assumed in this standard is that on Python itself.
2828
Python >= 3.8 is assumed, motivated by the use of positional-only parameters
29-
(see [function and method signatures](API_specification/function_and_method_signatures.md)).
29+
(see [function and method signatures](API_specification/function_and_method_signatures.rst)).
3030

3131
Importantly, array libraries are not assumed to be aware of each other, or of
3232
a common array-specific layer. The [use cases](use_cases.md) do not require
@@ -39,7 +39,7 @@ for that is:
3939

4040
Array libraries may know how to interoperate with each other, for example by
4141
constructing their own array type from that of another library or by shared
42-
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.md)).
42+
memory use of an array (see [Data interchange mechanisms](design_topics/data_interchange.rst)).
4343
This can be done without a dependency though - only adherence to a protocol is
4444
enough.
4545

Diff for: spec/draft/purpose_and_scope.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ standard is shown in this diagram:
151151
_Rationale: this is an important topic for some array-consuming libraries,
152152
but there is no widely shared C/Cython API and hence it doesn't make sense at
153153
this point in time to standardize anything. See
154-
the [C API section](design_topics/C_API.md) for more details._
154+
the [C API section](design_topics/C_API.rst) for more details._
155155

156156
4. Standardization of these dtypes is out of scope: bfloat16, extended
157157
precision floating point, datetime, string, object and void dtypes.

Diff for: spec/draft/use_cases.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ array implementation as a dependency.
5959

6060
It's clear that SciPy functionality that relies on compiled extensions (C,
6161
C++, Cython, Fortran) directly can't easily be run on another array library
62-
than NumPy (see [C API](design_topics/C_API.md) for more details about this topic). Pure Python
62+
than NumPy (see [C API](design_topics/C_API.rst) for more details about this topic). Pure Python
6363
code can work though. There's two main possibilities:
6464

6565
1. Testing with another package, manually or in CI, and simply provide a list

Diff for: src/_array_api_conf.py

+2
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,14 @@
5252
nitpick_ignore = [
5353
("py:class", "collections.abc.Sequence"),
5454
("py:class", "Optional[Union[int, float, Literal[inf, - inf, 'fro', 'nuc']]]"),
55+
("py:class", "int | float | ~typing.Literal[inf, -inf, 'fro', 'nuc'] | None"),
5556
("py:class", "Union[int, float, Literal[inf, - inf]]"),
5657
(
5758
"py:obj",
5859
"typing.Optional[typing.Union[int, float, typing.Literal[inf, - inf, 'fro', 'nuc']]]",
5960
),
6061
("py:obj", "typing.Union[int, float, typing.Literal[inf, - inf]]"),
62+
("py:class", "int | float | ~typing.Literal[inf, -inf]"),
6163
("py:class", "enum.Enum"),
6264
("py:class", "ellipsis"),
6365
]

0 commit comments

Comments
 (0)