You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs: fix font-family loading style
* docs: enhance plugin documentation according with current tutor version
* docs: add indentation to code in list
* docs: add badges status
TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor versions and configurations.
4
9
5
10
TVM is also the acronym for:
6
11
7
-
- Tutor Version Manager: manages the version of Tutor.
8
-
- Tutor enVironment Manager: for creating project-based environments with Tutor.
12
+
-**Tutor Version Manager:** Handle the Tutor versions.
13
+
-**Tutor enVironment Manager:** Create project-based environments with Tutor.
9
14
10
15
# Installing TVM
11
16
@@ -27,39 +32,42 @@ Create and activate a new project with the following steps:
27
32
28
33
1. Install the version of Tutor you want to use with TVM.
29
34
30
-
```bash
31
-
tvm install <tutor-version>
35
+
```bash
36
+
tvm install <tutor-version>
32
37
33
-
# For example:
34
-
# tvm install v14.0.0
35
-
```
38
+
# For example:
39
+
# tvm install v14.0.0
40
+
```
36
41
37
42
2. Create a new project with TVM.
38
43
39
-
```bash
40
-
tvm project init <project-name><tutor-version>
44
+
```bash
45
+
tvm project init <project-name><tutor-version>
41
46
42
-
# For example:
43
-
# tvm project init tvm-test v14.0.0
44
-
```
47
+
# For example:
48
+
# tvm project init tvm-test v14.0.0
49
+
```
45
50
46
51
3. Open the project folder.
47
52
48
-
```bash
49
-
cd<project-name>
50
-
```
53
+
```bash
54
+
cd<project-name>
55
+
```
51
56
52
57
4. Activate the project environment.
53
58
54
-
```bash
55
-
source .tvm/bin/activate
56
-
```
59
+
```bash
60
+
source .tvm/bin/activate
61
+
```
57
62
58
63
5. Run your project.
59
64
60
-
```bash
61
-
tutor local quickstart
62
-
```
65
+
```bash
66
+
tutor local launch
67
+
```
68
+
69
+
> [!NOTE]
70
+
> For Tutor versions <15, init a project with `tutor local quickstart`
63
71
64
72
You can start configuring and using your Tutor instance.
Copy file name to clipboardExpand all lines: docs/source/index.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
TVM
2
2
####
3
3
4
-
TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor versions and configurations.
4
+
TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor version and configurations.
5
5
6
6
User Guide
7
7
-----------
@@ -17,7 +17,7 @@ User Guide
17
17
Releases
18
18
---------
19
19
20
-
The Releases are listed on the `Github release page <https://github.com/eduNEXT/tvm/releases>`_. And all notable changes to this project are documented in the `CHANGELOG <https://github.com/eduNEXT/tvm/blob/main/CHANGELOG.md>`_ file.
20
+
The Releases are listed on the `Github release page <https://github.com/eduNEXT/tvm/releases>`_. All notable changes to this project are documented in the `CHANGELOG <https://github.com/eduNEXT/tvm/blob/main/CHANGELOG.md>`_ file.
21
21
22
22
Source code
23
23
-----------
@@ -27,7 +27,7 @@ The complete source code for TVM is available on Github: https://github.com/eduN
27
27
Support
28
28
--------
29
29
30
-
To get support, go to the TVM Github discussion forum: https://github.com/eduNEXT/tvm/discussions
30
+
Get support in the TVM Github discussion forum: https://github.com/eduNEXT/tvm/discussions
Copy file name to clipboardExpand all lines: docs/source/tvm_advanced_information.rst
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ Advanced Information
3
3
4
4
TVM is the acronym for:
5
5
6
-
- Tutor Version Manager: manages the version of Tutor.
7
-
- Tutor enVironment Manager: for creating project-based environments with Tutor.
6
+
- Tutor Version Manager: handles the version of Tutor.
7
+
- Tutor enVironment Manager: creates project-based environments with Tutor.
8
8
9
9
To develop this tool, we separate the code into two apps accord the two meanings of TVM, and we use a `Hexagonal Architecture <https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)>`_.
Copy file name to clipboardExpand all lines: docs/source/tvm_topic_guides/environment_manager.rst
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ Remove a Project Environment
38
38
# tvm project remove v14.0.0@tvm-test
39
39
40
40
41
-
.. note:: You can use the flag --prune to remove all the project folder. Ex: `tvm project remove v14.0.0@tvm-test --prune`
41
+
.. note:: You can use the flag --prune to remove all the project folder. E.g. ``tvm project remove v14.0.0@tvm-test --prune``
42
42
43
43
44
44
Activate a Project Environment
@@ -57,7 +57,7 @@ Deactivate a Project Environment
57
57
tvmoff
58
58
59
59
60
-
.. warning:: If you also have another environment like a python virtual environment, you need to deactivate each virtual environment in order. For example, if you have `(venv) [v12.2.0@project-name]`, you need to run `deactivate` and then `tvmoff`.
60
+
.. warning:: If you also have another environment like a python virtual environment, you need to deactivate each virtual environment in order. For example, if you have ``(venv) [v12.2.0@project-name]``, you need to run ``deactivate`` and then ``tvmoff``.
61
61
62
62
List Environments and Projects
63
63
--------------------------------
@@ -67,7 +67,7 @@ List Environments and Projects
67
67
tvm list
68
68
69
69
70
-
.. note:: You can use the flag -l or --limit and an integer to limit the output. Ex: `tvm list --limit 10`
70
+
.. note:: You can use the flag -l or --limit and an integer to restrict the output. E.g. ``tvm list --limit 10``
71
71
72
72
Install Tutor Plugins
73
73
----------------------
@@ -90,7 +90,7 @@ Pip
90
90
pip install <plugin>
91
91
92
92
93
-
.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
93
+
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.
94
94
95
95
96
96
Uninstall Tutor Plugins
@@ -115,7 +115,7 @@ Pip
115
115
pip uninstall <plugin>
116
116
117
117
118
-
.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
118
+
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.
Copy file name to clipboardExpand all lines: docs/source/tvm_topic_guides/version_manager.rst
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -84,7 +84,7 @@ List Environments and Projects
84
84
tvm list
85
85
86
86
87
-
.. note:: You can use the flag -l or --limit and an integer to limit the output. Ex: `tvm list --limit 10`
87
+
.. note:: You can use the flag -l or --limit and an integer to restrict the output. E.g. ``tvm list --limit 10``
88
88
89
89
90
90
Install Tutor Plugins
@@ -108,7 +108,7 @@ Pip
108
108
pip install <plugin>
109
109
110
110
111
-
.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
111
+
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.
112
112
113
113
114
114
Uninstall Tutor Plugins
@@ -133,7 +133,7 @@ Pip
133
133
pip uninstall <plugin>
134
134
135
135
136
-
.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
136
+
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.
0 commit comments