Skip to content

Commit 616321c

Browse files
additional updates to generating mdf documentation offline
1 parent 2bada93 commit 616321c

File tree

1 file changed

+45
-21
lines changed

1 file changed

+45
-21
lines changed

docs/sphinx/source/api/Installation.md

Lines changed: 45 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -59,34 +59,55 @@ Make sure that the directory containing the dot executable is on your system's P
5959

6060

6161

62-
# Generating ModECI MDF documentation offline
62+
## Generating ModECI MDF documentation offline
6363

6464
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.
6565
Here is a walkthrough on how to generate the ModECI MDF documentation offline
6666

6767
## Requirements
6868

69-
Python (3.9.0)
69+
Python (3.10)
7070

71-
See Installation [here](https://www.python.org/downloads/release/python-390)
71+
Make library
7272

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.**
7474

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
7686
```
7787
# install virtual environment
7888
7989
pip install virtualenv
8090
81-
# create virtual environment using python 3.9.0
91+
# create virtual environment for python 3.9
8292
8393
python3.9 -m virtualenv venv39
8494
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+
86103
venv39\Scripts\activate
104+
105+
# Activate virtual environment for python3.10
106+
107+
venv310\Scripts\activate
87108
```
88109

89-
### 2). Clone MDF repository from Github into the virtual environment
110+
### 2). Clone MDF repository from Github into your local machine
90111
```
91112
git clone https://github.com/ModECI/MDF.git
92113
```
@@ -96,22 +117,21 @@ git clone https://github.com/ModECI/MDF.git
96117
cd MDF
97118
```
98119

99-
### 4). Install MDF package
100-
```
101-
pip install .
102-
```
103-
104-
### 5). Install all dependencies
120+
### 4). Install all MDF package into the virtual environment
105121
```
106122
pip install .[all]
107123
```
108124

109-
### 6). Change directory into sphinx folder
125+
### 5). Change directory into sphinx folder
110126
```
127+
# for windows
111128
cd docs\sphinx
129+
130+
# for mac
131+
cd docs/sphinx
112132
```
113133

114-
### 7). Create offline documentation in sphinx folder
134+
### 6). Create offline documentation in sphinx folder
115135
```
116136
# To allow fresh start when making the documentation
117137
make clean
@@ -120,12 +140,16 @@ make clean
120140
make html
121141
```
122142

123-
### 8). change directory into html folder
143+
### 7). change directory into html folder and run the documentation offline
124144
```
145+
# for windows
146+
Go into build\html folder and double click on the index.html file.
147+
or
125148
cd build\html
126-
```
127-
128-
### 9). Run the documentation offline
129-
```
130149
index.html
150+
151+
# for mac
152+
Go into build/html folder and double click on the index.html file
131153
```
154+
155+
The documentation will open up in your browser automatically or right click on the file and open in any browser of your choice

0 commit comments

Comments
 (0)