Skip to content

Commit fd7c6e8

Browse files
committed
Updated all docs to use the new monai.io URLs
Signed-off-by: M Q <mingmelvinq@nvidia.com>
1 parent eb329a0 commit fd7c6e8

File tree

24 files changed

+39
-38
lines changed

24 files changed

+39
-38
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ MONAI's documentation is located at `docs/`.
143143
./run gen_docs # '-h' for help
144144
```
145145

146-
The above command builds HTML documents in the `dist/docs` folder, they are used to automatically generate documents in [https://docs.monai.io](https://docs.monai.io).
146+
The above command builds HTML documents in the `dist/docs` folder, they are used to automatically generate documents in [https://project-monai.github.io](https://project-monai.github.io).
147147

148148
To test HTML docs locally with development server, execute below command:
149149

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ MONAI Deploy App SDK offers a framework and associated tools to design, develop
2222

2323
## User Guide
2424

25-
User guide is available at [docs.monai.io](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/).
25+
User guide is available at [project-monai.github.io](https://project-monai.github.io/deploy.html).
2626

2727
## Citation
2828

@@ -45,7 +45,7 @@ pip install monai-deploy-app-sdk
4545

4646
## Getting Started
4747

48-
Getting started guide is available at [here](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/index.html).
48+
Getting started guide is available at [here](https://project-monai.github.io/deploy.html#getting-started).
4949

5050
```bash
5151
pip install monai-deploy-app-sdk
@@ -72,30 +72,30 @@ cp examples/apps/simple_imaging_app/input/brain_mr_input.jpg input/
7272
monai-deploy run simple_app-x64-workstation-dgpu-linux-amd64:latest -i input -o output
7373
```
7474

75-
### [Tutorials](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/index.html)
75+
### [Tutorials](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/index.html)
7676

7777
Tutorials are provided to help getting started with the App SDK, to name but a few below.
7878

79-
#### [1) Creating a simple image processing app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/simple_app.html)
79+
#### [1) Creating a simple image processing app](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/simple_app.html)
8080

81-
#### [2) Creating MedNIST Classifier app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/mednist_app.html)
81+
#### [2) Creating MedNIST Classifier app](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/mednist_app.html)
8282

8383
YouTube Video (to be updated with the new version):
8484

8585
- [MedNIST Classification Example](https://www.youtube.com/watch?v=WwjilJFHuU4)
8686

87-
### [3) Creating a Segmentation app](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/segmentation_app.html)
87+
### [3) Creating a Segmentation app](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/segmentation_app.html)
8888

8989
YouTube Video (demonstrating the previous version of the App SDK):
9090

9191
- [Spleen Organ Segmentation - Jupyter Notebook Tutorial](https://www.youtube.com/watch?v=cqDVxzYt9lY)
9292
- [Spleen Organ Segmentation - Deep Dive](https://www.youtube.com/watch?v=nivgfD4pwWE)
9393

94-
### [4) Creating a Segmentation app including visualization with Clara Viz](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/segmentation_clara-viz_app.html)
94+
### [4) Creating a Segmentation app including visualization with Clara Viz](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/segmentation_clara-viz_app.html)
9595

96-
### [5) Creating a Segmentation app consuming a MONAI Bundle](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/monai_bundle_app.html)
96+
### [5) Creating a Segmentation app consuming a MONAI Bundle](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/tutorials/monai_bundle_app.html)
9797

98-
### [Examples](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/getting_started/examples.html)
98+
### [Examples](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/getting_started/examples.html)
9999

100100
<https://github.com/Project-MONAI/monai-deploy-app-sdk/tree/main/examples/apps> has example apps that you can see, to name but a few
101101

@@ -122,8 +122,8 @@ Ask and answer questions over on [MONAI Deploy App SDK's GitHub Discussions tab]
122122

123123
## Links
124124

125-
- Website: <https://monai.io>
126-
- API documentation: <https://docs.monai.io/projects/monai-deploy-app-sdk>
125+
- Website: <https://project-monai.github.io/>
126+
- API documentation: <https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/modules/index.html>
127127
- Code: <https://github.com/Project-MONAI/monai-deploy-app-sdk>
128128
- Project tracker: <https://github.com/Project-MONAI/monai-deploy-app-sdk/projects>
129129
- Issue tracker: <https://github.com/Project-MONAI/monai-deploy-app-sdk/issues>

docs/source/_templates/sidebar-quicklinks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<div class="card d-none d-md-block mt-4">
2-
<h5 class="card-header font-weight-bold">Version {{ release }}</h5>
2+
<h5 class="card-header font-weight-bold">Version: {{ release }}</h5>
33
<div class="card-body">
44
<ul class="list-group list-group-flush list-unstyled quicklinks">
55
<li><a href="{{ pathto('release_notes/v' + version + '.html', 1) }}"><i class="text-muted fas fa-newspaper fa-fw"></i> What's New</a></li>

docs/source/conf.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@
5353
short_version = MONAI_APP_SDK_VERSION.split("+")[0]
5454
release = short_version
5555
version = re.sub(r"(a|b|rc)\d+.*", "", short_version)
56+
release = "Stable" # stable for now since short_version is always 1.0.0 for as of now
5657

5758
# List of patterns, relative to source directory, that match files and
5859
# directories to ignore when looking for source files.
@@ -126,7 +127,7 @@
126127
#
127128
html_theme = "pydata_sphinx_theme"
128129
html_theme_options = {
129-
"logo_link": "https://monai.io",
130+
"logo_link": "https://project-monai.github.io",
130131
"external_links": [
131132
{"url": "https://github.com/Project-MONAI/monai-deploy-app-sdk/issues/new/choose", "name": "SUBMIT ISSUE"}
132133
],

docs/source/getting_started/tutorials/monai_bundle_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Creating a Segmentation App Consuming a MONAI Bundle
22

3-
This tutorial shows how to create an organ segmentation application for a PyTorch model that has been trained with MONAI and packaged in the [MONAI Bundle](https://docs.monai.io/en/latest/bundle_intro.html) format.
3+
This tutorial shows how to create an organ segmentation application for a PyTorch model that has been trained with MONAI and packaged in the [MONAI Bundle](https://monai.readthedocs.io/en/stable/bundle_intro.html) format.
44

55
## Setup
66

docs/source/getting_started/tutorials/multi_model_app.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This tutorial shows how to create an inference application with multiple models, focusing on model files organization, inferring with named model in the application, and packaging.
44

5-
The models used in this example are trained with MONAI, and are packaged in the [MONAI Bundle](https://docs.monai.io/en/latest/bundle_intro.html) format.
5+
The models used in this example are trained with MONAI, and are packaged in the [MONAI Bundle](https://monai.readthedocs.io/en/stable/bundle_intro.html) format.
66

77
## Setup
88

docs/source/release_notes/v0.2.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Version 0.2.1 (January 25, 2022)
22

3-
This is a patch release of [v0.2](https://docs.monai.io/projects/monai-deploy-app-sdk/en/latest/release_notes/v0.2.0.html#).
3+
This is a patch release of [v0.2](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/latest/release_notes/v0.2.0.html#).
44

55
Please visit [GETTING STARTED](/getting_started/index) guide and follow tutorials.
66

docs/source/release_notes/v0.4.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44

55
## What's new in 0.4.0
6-
- New operator to automate inference with the newly introduced [MONAI Bundle](https://docs.monai.io/en/stable/whatsnew_0_9.html)
6+
- New operator to automate inference with the newly introduced [MONAI Bundle](https://monai.readthedocs.io/en/stable/whatsnew_0_9.html)
77

88
### MONAI Bundle Inference Operator
99

docs/source/release_notes/v0.5.1.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Version 0.5.1 (July 12, 2023)
22

3-
This is a patch release of [v0.5](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/release_notes/v0.5.0.html#), to address compatibility
3+
This is a patch release of [v0.5](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/release_notes/v0.5.0.html#), to address compatibility
44
issues with newer versions of dependent packages, as well as adding enhancements to built-in operators.
55

66
## What's new

docs/source/release_notes/v0.6.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- All example applications and Jupyter Notebooks are updated to be compatible with the new version of App SDK.
66
### Key changes and migration guide
77

8-
- In App SDK core module, `monai.deploy.core`, instead of through a wrapper layer, Holoscan SDK core sub modules are all directly imported and exposed under`monai.deploy.core`, mixed in with the ones original to the App SDK. The same also applies to those modules, e.g., `conditions`, `executors`, `graphs`, `logger`, and `resources`. As such, the [Modudle API documentation](https://docs.monai.io/projects/monai-deploy-app-sdk/en/stable/modules/index.html) may show a mixture of `monai.deploy` and `holoscan`.
8+
- In App SDK core module, `monai.deploy.core`, instead of through a wrapper layer, Holoscan SDK core sub modules are all directly imported and exposed under`monai.deploy.core`, mixed in with the ones original to the App SDK. The same also applies to those modules, e.g., `conditions`, `executors`, `graphs`, `logger`, and `resources`. As such, the [Modules API documentation](https://monai.readthedocs.io/projects/monai-deploy-app-sdk/en/stable/modules/index.html) may show a mixture of `monai.deploy` and `holoscan`.
99

1010
- For `monai.deploy.operators`, Holoscan SDK built-in operators are selectively imported and exposed, with the main reason being to avoid introducing extra dependencies on system packages. All of the original and existing App SDK built-in operators are still present and migrated to be based on Holoscan SDK base `operator` class.
1111

0 commit comments

Comments
 (0)