Skip to content

Commit 6a2dea2

Browse files
committed
Fix documentation for constants
Sphinx cannot find the docstring corresponding to a constant unless you point it to the exact file where it is, since it doesn't actually live on the object itself. See sphinx-doc/sphinx#6495 Fixes data-apis#601
1 parent 2056a94 commit 6a2dea2

File tree

3 files changed

+3
-3
lines changed

3 files changed

+3
-3
lines changed

spec/2021.12/API_specification/constants.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
1010
Objects in API
1111
--------------
1212

13-
.. currentmodule:: array_api
13+
.. currentmodule:: array_api.constants
1414

1515
..
1616
NOTE: please keep the functions in alphabetical order

spec/2022.12/API_specification/constants.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
1010
Objects in API
1111
--------------
1212

13-
.. currentmodule:: array_api
13+
.. currentmodule:: array_api.constants
1414

1515
..
1616
NOTE: please keep the functions in alphabetical order

spec/draft/API_specification/constants.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ A conforming implementation of the array API standard must provide and support t
1010
Objects in API
1111
--------------
1212

13-
.. currentmodule:: array_api
13+
.. currentmodule:: array_api.constants
1414

1515
..
1616
NOTE: please keep the functions in alphabetical order

0 commit comments

Comments
 (0)