10000 PR: Transform sorting functions from md to rst file by steff456 · Pull Request #333 · data-apis/array-api · GitHub
[go: up one dir, main page]
Skip to content

PR: Transform sorting functions from md to rst file #333

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.

Sign up for GitHub

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 10 commits into from
Dec 6, 2021
Merged

PR: Transform sorting functions from md to rst file #333

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
b8a3ff1
Transform sorting functions from md to rst file
steff456 Nov 10, 2021
61836cb
Fix the warning message
steff456 Nov 10, 2021
96e2c37
Add autosummary with signatures for the sorting functions
steff456 Nov 15, 2021
58f3984
Bump CI python to 3.8
steff456 Nov 15, 2021
31d01f0
Complete signatures and add types files
steff456 Nov 22, 2021
2bb72cc
Remove module names and add autodoc typehints
steff456 Nov 22, 2021
bdf41eb
Bump Sphinx version
steff456 Nov 22, 2021
3bd71a9
Remove module import from signature and return annonation
steff456 Nov 22, 2021
7c80b2c
Add jinja template for autosummary
steff456 Nov 22, 2021
5b1ec76
Put return section style as parameters and remove return type section
steff456 Dec 1, 2021
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
Prev Previous commit
Put return section style as parameters and remove return type section
  • Loading branch information
@steff456
steff456 committed Dec 1, 2021
commit 5b1ec764f4ec2f94bf1ef0db1696f494671f226b
4 changes: 2 additions & 2 deletions spec/API_specification/signatures/sorting_functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ def argsort(x: array, /, *, axis: int = -1, descending: bool = False, stable: bo

Returns
-------
out: array
out : array
an array of indices. The returned array must have the same shape as ``x``. The returned array must have the default array index data type.
"""

Expand All @@ -38,7 +38,7 @@ def sort(x: array, /, *, axis: int = -1, descending: bool = False, stable: bool

Returns
-------
out: array
out : array
a sorted array. The returned array must have the same data type and shape as ``x``.
"""

Expand Down
3 changes: 2 additions & 1 deletion spec/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,9 @@
]

autosummary_generate = True
autodoc_typehints = 'both'
autodoc_typehints = 'signature'
add_module_names = False
napoleon_custom_sections = [('Returns', 'params_style')]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
Expand Down
0