@@ -7,39 +7,53 @@ is hosted on ReadTheDocs.
7
7
8
8
#### Change directory to documentation root:
9
9
10
- cd docs
10
+ ```
11
+ cd docs
12
+ ```
11
13
12
14
#### Create environment
13
15
14
- - [ ** conda** ] Create conda env (and install relevant dependencies):
16
+ - \ [** conda** \ ] Create conda env (and install relevant dependencies):
15
17
16
- conda env create -f environment.yml
18
+ ```
19
+ conda env create -f environment.yml
20
+ ```
17
21
18
- - [ ** pip** ] Create virtual environment (and install relevant dependencies):
22
+ - \ [** pip** \ ] Create virtual environment (and install relevant dependencies):
19
23
20
- virtualenv traitlets_docs -p python3
21
- pip install -r requirements.txt
24
+ ```
25
+ virtualenv traitlets_docs -p python3
26
+ pip install -r requirements.txt
27
+ ```
22
28
23
29
#### Activate the newly built environment ` traitlets_docs `
24
30
25
- - [ ** conda** ] Activate conda env:
31
+ - \ [** conda** \ ] Activate conda env:
26
32
27
- source activate traitlets_docs
33
+ ```
34
+ source activate traitlets_docs
35
+ ```
28
36
29
- - [ ** pip** ] The virtualenv should have been automatically activated. If
37
+ - \ [** pip** \ ] The virtualenv should have been automatically activated. If
30
38
not:
31
39
32
- source activate
40
+ ```
41
+ source activate
42
+ ```
33
43
34
44
#### Build documentation using:
35
45
36
46
- Makefile for Linux and OS X:
37
47
38
- make html
48
+ ```
49
+ make html
50
+ ```
39
51
40
52
- make.bat for Windows:
41
53
42
- make.bat html
54
+ ```
55
+ make.bat html
56
+ ```
43
57
44
58
#### Display the documentation locally
45
59
@@ -48,7 +62,9 @@ is hosted on ReadTheDocs.
48
62
- Or alternatively you may run a local server to display
49
63
the docs. In Python 3:
50
64
51
- python -m http.server 8000
65
+ ```
66
+ python -m http.server 8000
67
+ ```
52
68
53
69
In your browser, go to ` http://localhost:8000 ` .
54
70
0 commit comments