Skip to content

Commit 2b5bd8a

Browse files
Kanta Vekariaglikely
authored andcommitted
Add build instructions for Mac OS X
- Provides build instructions for Mac users who either use macports or brew - Also provides commands to install Sphinx - Update formatting to accomodate the above and tidy layout - Fixed spelling to python-sphinx Signed-off-by: Kanta Vekaria <[email protected]> Acked-by: Charles Garcia-Tobin <[email protected]> Signed-off-by: Grant Likely <[email protected]>
1 parent 84d5daf commit 2b5bd8a

File tree

1 file changed

+47
-21
lines changed

1 file changed

+47
-21
lines changed

README.md

Lines changed: 47 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -18,27 +18,53 @@ Requirements:
1818

1919
On Ubuntu:
2020

21-
```
22-
# apt-get install python-sphinx latexdiff texlive texlive-latex-extra \
23-
texlive-humanities texlive-generic-recommended graphviz
24-
```
25-
26-
If the version of python-spinx installed is too old, then an additional
27-
new version can be installed with the Python package installer:
28-
29-
```
30-
$ apt-get install python-pip
31-
$ pip install --user --upgrade Sphinx
32-
$ export SPHINXBUILD=~/.local/bin/sphinx-build
33-
```
34-
35-
Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then:
36-
37-
```
38-
$ make latexpdf # For generating pdf
39-
$ make html # For generating a hierarchy of html pages
40-
$ make singlehtml # For generating a single html page
41-
```
21+
>```
22+
># apt-get install python-sphinx latexdiff texlive texlive-latex-extra \
23+
> texlive-humanities texlive-generic-recommended graphviz
24+
>```
25+
>
26+
>If the version of python-sphinx installed is too old, then an additional
27+
>new version can be installed with the Python package installer:
28+
>
29+
>```
30+
>$ apt-get install python-pip
31+
>$ pip install --user --upgrade Sphinx
32+
>$ export SPHINXBUILD=~/.local/bin/sphinx-build
33+
>```
34+
>
35+
>Export SPHINXBUILD (see above) if Sphinx was installed with pip --user, then follow Make commands below
36+
37+
On Mac OS X:
38+
39+
> Install [MacTeX](http://tug.org/mactex/)
40+
>
41+
> Install pip if you don't have it:
42+
>```
43+
>$ sudo easy_install pip
44+
>```
45+
>Install Sphinx
46+
>```
47+
>pip install --user --upgrade Sphinx
48+
>Or
49+
>sudo pip install --upgrade Sphinx
50+
>```
51+
>
52+
>If your are using [brew](http://brew.sh) then you can install graphviz like this:
53+
>```
54+
brew install graphviz
55+
>```
56+
>If you are using [macports](https://www.macports.org/) then you can install graphviz like this:
57+
>```
58+
>$ sudo port install graphviz
59+
>```
60+
61+
Make commands:
62+
63+
>```
64+
>$ make latexpdf # For generating pdf
65+
>$ make html # For generating a hierarchy of html pages
66+
>$ make singlehtml # For generating a single html page
67+
>```
4268
4369
Output goes in ./build subdirectory.
4470

0 commit comments

Comments
 (0)