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
Copy file name to clipboardExpand all lines: docs/sphinx/source/api/Installation.md
+45-21Lines changed: 45 additions & 21 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,34 +59,55 @@ Make sure that the directory containing the dot executable is on your system's P
59
59
60
60
61
61
62
-
# Generating ModECI MDF documentation offline
62
+
##Generating ModECI MDF documentation offline
63
63
64
64
The ModECI MDF Documentation can be found online [here](https://mdf.readthedocs.io/en/latest). If you are working on MDF documentation or you make changes to the documentation, it is good practice to see if it is working as expected before pushing to the Github repository.
65
65
Here is a walkthrough on how to generate the ModECI MDF documentation offline
66
66
67
67
## Requirements
68
68
69
-
Python (3.9.0)
69
+
Python (3.10)
70
70
71
-
See Installation [here](https://www.python.org/downloads/release/python-390)
71
+
Make library
72
72
73
-
Add python version-3.9.0 to path
73
+
**Python version-3.10 is ideally used for generating MDF documentation offline but if did not work, use python version-3.9. The steps are the same except in creating a virtual environment.**
74
74
75
-
### 1). Create a virtual environment with python 3.9.0
75
+
See Installation for python [here](https://www.python.org/downloads/)
76
+
77
+
Ensure the python version you are using is added to path
78
+
79
+
For **windows** installation of Make, see [here](https://stackoverflow.com/questions/32127524/how-to-install-and-use-make-in-windows)
80
+
81
+
for **mac** installation of Make, see [here](https://formulae.brew.sh/formula/make)
82
+
83
+
84
+
85
+
### 1). Create a virtual environment with python
76
86
```
77
87
# install virtual environment
78
88
79
89
pip install virtualenv
80
90
81
-
# create virtual environment using python 3.9.0
91
+
# create virtual environment for python 3.9
82
92
83
93
python3.9 -m virtualenv venv39
84
94
85
-
# Activate virtual environment
95
+
or
96
+
97
+
# create virtual environment for python 3.10
98
+
99
+
python3.10 -m virtualenv venv310
100
+
101
+
# Activate virtual environment for python3.9
102
+
86
103
venv39\Scripts\activate
104
+
105
+
# Activate virtual environment for python3.10
106
+
107
+
venv310\Scripts\activate
87
108
```
88
109
89
-
### 2). Clone MDF repository from Github into the virtual environment
110
+
### 2). Clone MDF repository from Github into your local machine
0 commit comments