Skip to content

Minor edits to update module names in the doc#584

Merged
MMelQin merged 1 commit into
mainfrom
mq/update_doc
Jun 9, 2026
Merged

Minor edits to update module names in the doc#584
MMelQin merged 1 commit into
mainfrom
mq/update_doc

Conversation

@MMelQin

@MMelQin MMelQin commented Jun 9, 2026

Copy link
Copy Markdown
Collaborator

Update the module names in graph.md and executor.md in doc/source/modules

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated API documentation structure for executors and graphs modules to reflect current organization and improve reference accuracy.

Signed-off-by: M Q <mingmelvinq@nvidia.com>
@MMelQin MMelQin requested a review from Copilot June 9, 2026 06:31
@coderabbitai

coderabbitai Bot commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 0a310a7c-b649-4ea6-b326-74a04aca5bea

📥 Commits

Reviewing files that changed from the base of the PR and between ed0e50a and 54ce97a.

📒 Files selected for processing (2)
  • docs/source/modules/executors.md
  • docs/source/modules/graphs.md

Walkthrough

Two documentation module references were updated to import from top-level module paths. The Sphinx automodule directives in the executors and graphs documentation now target monai.deploy.executors and monai.deploy.graphs respectively, rather than their core submodule variants.

Changes

Documentation module references

Layer / File(s) Summary
Automodule directive updates
docs/source/modules/executors.md, docs/source/modules/graphs.md
Sphinx automodule directives updated to reference monai.deploy.executors and monai.deploy.graphs instead of monai.deploy.core.executors and monai.deploy.core.graphs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'Minor edits to update module names in the doc' is directly related to the changeset, which updates module references in documentation files (executors.md and graphs.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mq/update_doc

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@sonarqubecloud

sonarqubecloud Bot commented Jun 9, 2026

Copy link
Copy Markdown

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Sphinx autodoc targets in the module API documentation so the “Graphs” and “Executors” pages reference the current monai.deploy package layout (rather than non-existent monai.deploy.core.* paths), keeping generated API docs accurate and buildable.

Changes:

  • Point graphs.md autodoc to monai.deploy.graphs.
  • Point executors.md autodoc to monai.deploy.executors.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/source/modules/graphs.md Updates autodoc module path to the current monai.deploy.graphs package.
docs/source/modules/executors.md Updates autodoc module path to the current monai.deploy.executors package.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@MMelQin MMelQin merged commit bf07f49 into main Jun 9, 2026
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants