Skip to content

Sort transforms alphabetically in docs #6556

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

Closed
brudfors opened this issue May 25, 2023 · 1 comment · Fixed by #6593
Closed

Sort transforms alphabetically in docs #6556

brudfors opened this issue May 25, 2023 · 1 comment · Fixed by #6593

Comments

@brudfors
Copy link
Contributor

The transforms documentation would be easier to navigate if the transforms were sorted alphabetically. It would, for example, then be easier to see what transforms have a random implementation (prefixed Rand*), compared to currently:

image

@wyli
Copy link
Contributor

wyli commented Jun 8, 2023

thanks for the suggestion, adding an indexing page
https://docs.monai.io/en/latest/transforms_idx.html

so that the transform classes are generated automatically and listed by names

https://github.com/Project-MONAI/MONAI/blob/dev/docs/source/transforms_idx.rst

example: https://docs.monai.io/en/latest/_gen/monai.transforms.croppad.array.html#module-monai.transforms.croppad.array

Screenshot 2023-06-08 at 15 13 56

@wyli wyli closed this as completed in #6593 Jun 8, 2023
wyli added a commit that referenced this issue Jun 8, 2023
part of #6151 
fixes #6556
fixes #6594


### Types of changes
<!--- Put an `x` in all the boxes that apply, and remove the not
applicable items -->
- [x] Non-breaking change (fix or new feature that would not break
existing functionality).
- [ ] Breaking change (fix or new feature that would cause existing
functionality to change).
- [ ] New tests added to cover the changes.
- [ ] Integration tests passed locally by running `./runtests.sh -f -u
--net --coverage`.
- [ ] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [ ] In-line docstrings updated.
- [ ] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: Wenqi Li <[email protected]>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants