Skip to content
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

Jump to bottom

Better autodoc generation -- bundle properties #6725

Closed
wyli opened this issue Jul 14, 2023 · 0 comments · Fixed by #6918
Closed

Better autodoc generation -- bundle properties #6725

wyli opened this issue Jul 14, 2023 · 0 comments · Fixed by #6918
Assignees
@wyli @KumoLiu
Labels
documentation Improvements or additions to documentation Feature request

Comments

@wyli
Copy link
Contributor

wyli commented Jul 14, 2023 •
edited
Loading

detailed documentation about bundle.properties and usage on docs.monai.io

https://github.com/Project-MONAI/MONAI/blob/dev/monai/bundle/properties.py#L78
@wyli wyli converted this from a draft issue Jul 14, 2023
@wyli wyli added documentation Improvements or additions to documentation Feature request labels Jul 14, 2023
@wyli wyli assigned wyli and KumoLiu Aug 29, 2023
@wyli wyli moved this from Bundle Todo to In Progress in MONAI v1.3 Aug 31, 2023
@wyli wyli mentioned this issue Aug 31, 2023
Merged
7 tasks
@wyli wyli closed this as completed in #6918 Sep 1, 2023
@github-project-automation github-project-automation bot moved this from In Progress to Done in MONAI v1.3 Sep 1, 2023
wyli added a commit that referenced this issue Sep 1, 2023
@wyli @KumoLiu
6725 generate properties for bundle docs (#6918)
e48c3e2 
Fixes #6725

- adding the bundle properties to
https://monai-dev.readthedocs.io/en/fixes-sphinx/mb_properties.html



### 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`.
- [x] Quick tests passed locally by running `./runtests.sh --quick
--unittests --disttests`.
- [x] In-line docstrings updated.
- [x] Documentation updated, tested `make html` command in the `docs/`
folder.

---------

Signed-off-by: Wenqi Li <wenqil@nvidia.com>
Co-authored-by: YunLiu <55491388+KumoLiu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@wyli wyli

@KumoLiu KumoLiu

Labels
documentation Improvements or additions to documentation Feature request
Projects
No open projects
MONAI v1.3
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

6725 generate properties for bundle docs wyli/MONAI
2 participants
@wyli @KumoLiu