Skip to content

Created HyperLink to sphinx-doc for easy acess #236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2015
Merged

Created HyperLink to sphinx-doc for easy acess #236

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ modules, eliminating the need for headers and the code duplication they entail.

## Documentation

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

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