Skip to content

Commit 698349a

Browse files
authored
docs: update the v0 & v1 envd reference (#1969)
Signed-off-by: Keming <kemingyang@tensorchord.ai>
1 parent 6b49023 commit 698349a

File tree

10 files changed

+30
-30
lines changed

10 files changed

+30
-30
lines changed

envd/api/v0/__init__.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22+
23+
::: warning
24+
v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
25+
26+
If you want to use v0 syntax, try `pip install 'envd<1'`.
27+
:::
2228
"""
2329

2430
from typing import List, Optional

envd/api/v0/config.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22+
23+
::: warning
24+
v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
25+
26+
If you want to use v0 syntax, try `pip install 'envd<1'`.
27+
:::
2228
"""
2329

2430
from typing import List, Optional

envd/api/v0/install.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22+
23+
::: warning
24+
v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
25+
26+
If you want to use v0 syntax, try `pip install 'envd<1'`.
27+
:::
2228
"""
2329

2430
from typing import List, Optional

envd/api/v0/io.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22+
23+
::: warning
24+
v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
25+
26+
If you want to use v0 syntax, try `pip install 'envd<1'`.
27+
:::
2228
"""
2329

2430
from typing import Optional

envd/api/v0/runtime.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22+
23+
::: warning
24+
v0 syntax is no longer supported from `envd>=v1.0`. Check the [upgrade guide](https://envd.tensorchord.ai/guide/v1.html).
25+
26+
If you want to use v0 syntax, try `pip install 'envd<1'`.
27+
:::
2228
"""
2329

2430
from typing import Dict, List, Optional

envd/api/v1/__init__.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22-
23-
::: warning
24-
Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
25-
26-
v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
27-
:::
2822
"""
2923

3024
from typing import List, Optional

envd/api/v1/config.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22-
23-
::: warning
24-
Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
25-
26-
v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
27-
:::
2822
"""
2923

3024
from typing import List, Optional

envd/api/v1/install.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22-
23-
::: warning
24-
Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
25-
26-
v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
27-
:::
2822
"""
2923

3024
from typing import Optional, Sequence

envd/api/v1/io.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22-
23-
::: warning
24-
Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
25-
26-
v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
27-
:::
2822
"""
2923

3024
from typing import Optional

envd/api/v1/runtime.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,6 @@
1919
in [tensorchord/envd](https://github.com/tensorchord/envd/tree/main/envd/api) repo.
2020
Please update the python file there instead of directly editing file inside envd-docs repo.
2121
:::
22-
23-
::: warning
24-
Enable v1 by adding `# syntax=v1` to the 1st line of your envd file.
25-
26-
v1 is experimental and may change in the future. Make sure to freeze the envd version for online CI/CD.
27-
:::
2822
"""
2923

3024
from typing import Dict, List, Optional

0 commit comments

Comments
 (0)