Skip to content

Upgrade Sphinx version used in doc deployment #735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
sphinx==4.3.0
sphinx==6.2.1
sphinx-material==0.0.30
myst-parser
sphinx_markdown_tables
sphinx_copybutton
sphinx_favicon
docutils<0.18
sphinx-math-dollar
4 changes: 2 additions & 2 deletions spec/2021.12/assumptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion spec/2021.12/purpose_and_scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ standard is shown in this diagram:
_Rationale: this is an important topic for some array-consuming libraries,
but there is no widely shared C/Cython API and hence it doesn't make sense at
this point in time to standardize anything. See
the [C API section](design_topics/C_API.md) for more details._
the [C API section](design_topics/C_API.rst) for more details._

4. Standardization of these dtypes is out of scope: bfloat16, complex, extended
precision floating point, datetime, string, object and void dtypes.
Expand Down
2 changes: 1 addition & 1 deletion spec/2021.12/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ array implementation as a dependency.

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

1. Testing with another package, manually or in CI, and simply provide a list
Expand Down
4 changes: 2 additions & 2 deletions spec/2022.12/assumptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion spec/2022.12/purpose_and_scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ standard is shown in this diagram:
_Rationale: this is an important topic for some array-consuming libraries,
but there is no widely shared C/Cython API and hence it doesn't make sense at
this point in time to standardize anything. See
the [C API section](design_topics/C_API.md) for more details._
the [C API section](design_topics/C_API.rst) for more details._

4. Standardization of these dtypes is out of scope: bfloat16, extended
precision floating point, datetime, string, object and void dtypes.
Expand Down
2 changes: 1 addition & 1 deletion spec/2022.12/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ array implementation as a dependency.

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

1. Testing with another package, manually or in CI, and simply provide a list
Expand Down
4 changes: 2 additions & 2 deletions spec/draft/assumptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ of functions to be predictable from input dtypes only rather than input values.

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

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

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

Expand Down
2 changes: 1 addition & 1 deletion spec/draft/purpose_and_scope.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,7 +151,7 @@ standard is shown in this diagram:
_Rationale: this is an important topic for some array-consuming libraries,
but there is no widely shared C/Cython API and hence it doesn't make sense at
this point in time to standardize anything. See
the [C API section](design_topics/C_API.md) for more details._
the [C API section](design_topics/C_API.rst) for more details._

4. Standardization of these dtypes is out of scope: bfloat16, extended
precision floating point, datetime, string, object and void dtypes.
Expand Down
2 changes: 1 addition & 1 deletion spec/draft/use_cases.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ array implementation as a dependency.

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

1. Testing with another package, manually or in CI, and simply provide a list
Expand Down
2 changes: 2 additions & 0 deletions src/_array_api_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,12 +52,14 @@
nitpick_ignore = [
("py:class", "collections.abc.Sequence"),
("py:class", "Optional[Union[int, float, Literal[inf, - inf, 'fro', 'nuc']]]"),
("py:class", "int | float | ~typing.Literal[inf, -inf, 'fro', 'nuc'] | None"),
("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", "int | float | ~typing.Literal[inf, -inf]"),
("py:class", "enum.Enum"),
("py:class", "ellipsis"),
]
Expand Down