Update documentation links #8637
Conversation
Signed-off-by: Yun Liu <[email protected]>
WalkthroughThis PR updates documentation URLs across the MONAI codebase, transitioning from monai.io and docs.monai.io to project-monai.github.io and monai.readthedocs.io. Changes span configuration files (CITATION.cff, setup.cfg), markdown documentation (README.md, contributing guide, whatsnew files), and Python source docstrings and error messages. No functional logic modifications are introduced. Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes
Pre-merge checks and finishing touches✅ Passed checks (5 passed)
✨ Finishing touches
🧪 Generate unit tests (beta)
Tip 📝 Customizable high-level summaries are now available in beta!You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.
Example instruction:
Note: This feature is currently in beta for Pro-tier users, and pricing will be announced later. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
monai/networks/nets/segresnet_ds.py (1)
431-435: Small typo in SegResNetDS2 docstring“decorder branch” should be “decoder branch” in this description.
README.md (1)
62-62: Line 62:docs.monai.ioreference was not updated.This line still points to the old broken documentation domain, directly contradicting the PR's objective to fix documentation access. Update to an appropriate readthedocs URL (likely
https://monai.readthedocs.io/en/latest/or similar).-Technical documentation is available at [docs.monai.io](https://docs.monai.io). +Technical documentation is available at [docs.monai.io](https://monai.readthedocs.io/en/latest/).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge base: Disabled due to Reviews -> Disable Knowledge Base setting
📒 Files selected for processing (25)
CITATION.cff(1 hunks)CONTRIBUTING.md(1 hunks)README.md(5 hunks)docs/source/applications.md(1 hunks)docs/source/config_syntax.md(1 hunks)docs/source/index.rst(1 hunks)docs/source/modules.md(2 hunks)docs/source/whatsnew_0_6.md(2 hunks)docs/source/whatsnew_0_8.md(1 hunks)docs/source/whatsnew_0_9.md(1 hunks)docs/source/whatsnew_1_0.md(3 hunks)docs/source/whatsnew_1_1.md(1 hunks)docs/source/whatsnew_1_2.md(1 hunks)monai/apps/auto3dseg/auto_runner.py(3 hunks)monai/apps/auto3dseg/ensemble_builder.py(3 hunks)monai/apps/generation/maisi/networks/autoencoderkl_maisi.py(1 hunks)monai/bundle/workflows.py(2 hunks)monai/config/deviceconfig.py(1 hunks)monai/networks/nets/segresnet_ds.py(1 hunks)monai/transforms/io/array.py(2 hunks)monai/transforms/spatial/array.py(2 hunks)monai/utils/module.py(2 hunks)monai/utils/tf32.py(1 hunks)setup.cfg(2 hunks)tests/profile_subclass/README.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
**/*.md
⚙️ CodeRabbit configuration file
Remember that documentation must be updated with the latest information.
Files:
docs/source/whatsnew_1_0.mddocs/source/whatsnew_0_6.mddocs/source/config_syntax.mddocs/source/whatsnew_0_8.mddocs/source/whatsnew_1_1.mddocs/source/whatsnew_0_9.mdCONTRIBUTING.mddocs/source/modules.mddocs/source/whatsnew_1_2.mdtests/profile_subclass/README.mddocs/source/applications.mdREADME.md
**/*.py
⚙️ CodeRabbit configuration file
Review the Python code for quality and correctness. Ensure variable names adhere to PEP8 style guides, are sensible and informative in regards to their function, though permitting simple names for loop and comprehension variables. Ensure routine names are meaningful in regards to their function and use verbs, adjectives, and nouns in a semantically appropriate way. Docstrings should be present for all definition which describe each variable, return value, and raised exception in the appropriate section of the Google-style of docstrings. Examine code for logical error or inconsistencies, and suggest what may be changed to addressed these. Suggest any enhancements for code improving efficiency, maintainability, comprehensibility, and correctness. Ensure new or modified definitions will be covered by existing or new unit tests.
Files:
monai/utils/module.pymonai/config/deviceconfig.pymonai/utils/tf32.pymonai/apps/auto3dseg/auto_runner.pymonai/networks/nets/segresnet_ds.pymonai/transforms/spatial/array.pymonai/apps/auto3dseg/ensemble_builder.pymonai/transforms/io/array.pymonai/apps/generation/maisi/networks/autoencoderkl_maisi.pymonai/bundle/workflows.py
**/*.rst
⚙️ CodeRabbit configuration file
Remember that documentation must be updated with the latest information.
Files:
docs/source/index.rst
🪛 LanguageTool
docs/source/applications.md
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...two-level search. It provides a topology guaranteed discretization algorithm and ...
(QB_NEW_EN_HYPHEN)
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...etization algorithm and a discretization aware topology loss for the search stage...
(QB_NEW_EN_HYPHEN)
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...imize the discretization gap, and a cost usage aware search method which can sear...
(QB_NEW_EN_HYPHEN)
[grammar] ~17-~17: Use a hyphen to join words.
Context: ...the discretization gap, and a cost usage aware search method which can search 3D ...
(QB_NEW_EN_HYPHEN)
🪛 markdownlint-cli2 (0.18.1)
tests/profile_subclass/README.md
15-15: Bare URL used
(MD034, no-bare-urls)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (19)
- GitHub Check: build-docs
- GitHub Check: quick-py3 (windows-latest)
- GitHub Check: quick-py3 (ubuntu-latest)
- GitHub Check: quick-py3 (macOS-latest)
- GitHub Check: flake8-py3 (pytype)
- GitHub Check: flake8-py3 (mypy)
- GitHub Check: packaging
- GitHub Check: flake8-py3 (codeformat)
- GitHub Check: min-dep-pytorch (2.7.1)
- GitHub Check: min-dep-pytorch (2.8.0)
- GitHub Check: min-dep-pytorch (2.5.1)
- GitHub Check: min-dep-pytorch (2.6.0)
- GitHub Check: min-dep-py3 (3.12)
- GitHub Check: min-dep-py3 (3.11)
- GitHub Check: min-dep-os (ubuntu-latest)
- GitHub Check: min-dep-os (windows-latest)
- GitHub Check: min-dep-py3 (3.10)
- GitHub Check: min-dep-py3 (3.9)
- GitHub Check: min-dep-os (macOS-latest)
🔇 Additional comments (28)
monai/config/deviceconfig.py (1)
114-114: LGTM - Documentation URL updated correctly.URL now points to the correct ReadTheDocs installation guide.
CONTRIBUTING.md (1)
201-201: LGTM - Documentation reference updated.Link now correctly points to ReadTheDocs.
docs/source/whatsnew_1_2.md (1)
76-76: LGTM - Documentation link updated.ReadTheDocs URL is correct.
monai/apps/generation/maisi/networks/autoencoderkl_maisi.py (1)
131-131: LGTM - Docstring reference updated.API documentation link now points to ReadTheDocs.
CITATION.cff (1)
17-17: LGTM - Citation metadata updated.Homepage URL now correctly points to project-monai.github.io.
docs/source/applications.md (1)
4-4: LGTM - Research page links updated.All tutorial references now correctly point to project-monai.github.io.
Also applies to: 10-10, 17-17
setup.cfg (1)
5-5: LGTM - Package metadata URLs updated.Homepage and documentation URLs now point to correct locations. These will be published to PyPI.
Also applies to: 14-14
docs/source/whatsnew_1_1.md (1)
53-56: Model Zoo link correctly updatedThe Model Zoo link now targets the project-monai.github.io page and resolves correctly; no further change needed.
monai/transforms/io/array.py (1)
281-287: Installation help URLs point to valid docsBoth error messages now reference the readthedocs “Installing the recommended dependencies” section; links resolve and the guidance remains accurate.
Also applies to: 518-524
monai/bundle/workflows.py (1)
78-82: Bundle specification references updated to stable docsAll three references to the bundle specification now point to the stable readthedocs page, which resolves and matches the intended content.
Also applies to: 86-90, 361-368
docs/source/whatsnew_0_9.md (1)
9-12: MONAI Bundle docs link is correctThe MONAI Bundle reference now targets the bundle_intro page on readthedocs and loads as expected.
docs/source/config_syntax.md (1)
69-72: ConfigParser API link updated to canonical locationThe
monai.bundle.ConfigParserreference now points to the Config Parser section on readthedocs and resolves correctly.monai/networks/nets/segresnet_ds.py (1)
235-241: SegResNet reference points to stable networks docsThe SegResNetDS docstring now links to the SegResNet section on the stable networks page; link resolves and matches the described architecture.
monai/transforms/spatial/array.py (1)
2020-2038: grid-pull documentation references are consistent and validAll Resample docstring mentions of grid-pull now point to the grid-pull section on the stable networks docs, which resolves and matches the described behavior.
Also applies to: 2073-2089
docs/source/whatsnew_0_8.md (1)
14-19: DiNTS tutorial link updated to new hostingThe DiNTS tutorial now points to the project-monai.github.io research page and loads correctly; no further changes needed.
monai/utils/module.py (2)
408-408: Documentation URL correctly updated.Optional dependencies installation reference updated to match the new documentation location.
198-198: Documentation URL verified and accessible.URL update to https://monai.readthedocs.io/en/stable/installation.html confirms the new ReadTheDocs hosting is live. Change approved.
monai/apps/auto3dseg/ensemble_builder.py (1)
480-480: SaveImage documentation URLs correctly updated.All three SaveImage transform documentation references now point to the new ReadTheDocs location.
Also applies to: 528-528, 537-537
docs/source/modules.md (2)
243-243: Bundle documentation URLs correctly updated.Bundle specification and config syntax links migrated to ReadTheDocs.
Also applies to: 265-265
272-284: Federated learning API URLs correctly updated.All federated learning documentation references (MonaiAlgo, ClientAlgo, MonaiAlgoStats) migrated to ReadTheDocs.
docs/source/whatsnew_0_6.md (2)
45-45: UNETR documentation URL correctly updated.Research contribution link migrated to project-monai.github.io.
96-96: MONAILabel documentation URL correctly updated.MONAILabel docs link migrated to ReadTheDocs with projects path.
docs/source/whatsnew_1_0.md (2)
20-20: Auto3DSeg documentation URL correctly updated.Apps page link migrated to project-monai.github.io.
38-38: API documentation URLs correctly updated.Federated learning, SSIMLoss, and FastMRIReader API references migrated to ReadTheDocs.
Also applies to: 63-64
monai/utils/tf32.py (1)
69-69: Precision documentation URL correctly updated.Warning message reference migrated to ReadTheDocs.
monai/apps/auto3dseg/auto_runner.py (1)
90-90: SaveImage documentation URLs correctly updated.All SaveImage transform documentation references in AutoRunner class migrated to ReadTheDocs.
Also applies to: 624-624, 634-634
docs/source/index.rst (1)
88-88: Primary documentation URLs verified and functional.Both project-monai.github.io and monai.readthedocs.io are accessible. The URL updates at lines 88, 94-96 are correct and ready.
README.md (1)
16-16: Link updates are consistent and align with PR objectives.The migrations to
monai.readthedocs.ioandproject-monai.github.iolook correct across badges, feature highlights, installation guidance, bundle documentation, and the Links section.Also applies to: 29-29, 54-54, 71-71, 85-87
|
/build |
2 participants
Fixes #8598 .
Description
Update links to:
Website: https://project-monai.github.io/
Core Docs: https://monai.readthedocs.io/en/stable/
Label Docs: https://monai.readthedocs.io/projects/label/en/latest/
Deploy SDK Docs: https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/
Types of changes
./runtests.sh -f -u --net --coverage../runtests.sh --quick --unittests --disttests.make htmlcommand in thedocs/folder.