Skip to content

Commit 5e25990

Browse files
committedDec 5, 2015
Merge pull request #236 from codestergit/patch-9
Created HyperLink to sphinx-doc for easy access.
2 parents f13b331 + 7c2cea7 commit 5e25990

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed
 

Diff for: ‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ modules, eliminating the need for headers and the code duplication they entail.
1616

1717
## Documentation
1818

19-
To read the documentation, start by installing the Sphinx documentation
20-
generator tool (http://sphinx-doc.org, just run `easy_install -U Sphinx` from
21-
the command line and you're good to go). Once you have that, you can build the
22-
Swift documentation by going into `docs` and typing `make`. This compiles
23-
the `.rst` files in the `docs` directory into HTML in the `docs/_build/html`
24-
directory.
19+
To read the documentation, start by installing the
20+
[Sphinx](http://sphinx-doc.org) documentation generator tool (just run
21+
`easy_install -U Sphinx` from the command line and you're good to go). Once you
22+
have that, you can build the Swift documentation by going into `docs` and
23+
typing `make`. This compiles the `.rst` files in the `docs` directory into
24+
HTML in the `docs/_build/html` directory.
2525

2626
Once built, the best place to start is with the Swift white paper, which gives a
2727
tour of the language (in `docs/_build/html/whitepaper/index.html`).

0 commit comments

Comments
 (0)
Please sign in to comment.