Skip to content

Commit

Permalink
Merge pull request nryoung#129 from nryoung/add-docs-link
Browse files Browse the repository at this point in the history
Add docs link to README
  • Loading branch information
nryoung committed Dec 26, 2015
2 parents 180c2f1 + 209094c commit 64e62a9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
7 changes: 5 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The main purpose of this library is to be an educational tool. You probably
shouldn't use these in production, instead, opting for the optimized versions of
these algorithms that can be found else where.

You should totally check out the docs for implementation details, complexities
You should totally check out the `docs`_ for implementation details, complexities
and further info.

Usage
Expand All @@ -32,7 +32,7 @@ Features

- Pseudo code, algorithm complexities and futher info with each algorithm.
- Test coverage for each algorithm and data structure.
- Super sweet documentation.
- Super sweet `documentation`_.

Installation:
-------------
Expand All @@ -59,3 +59,6 @@ Contributing:

Contributions are always welcome. Check out the contributing guidelines to get
started.

.. _`docs`: http://algorithms.readthedocs.org/en/latest/
.. _`documentation`: http://algorithms.readthedocs.org/en/latest/
8 changes: 5 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The main purpose of this library is to be an educational tool. You probably
shouldn't use these in production, instead, opting for the optimized versions of
these algorithms that can be found else where.

You should totally check out the docs for implementation details, complexities
You should totally check out the `docs`_ for implementation details, complexities
and further info.

Usage
Expand All @@ -30,8 +30,8 @@ Features
--------

- Pseudo code, algorithm complexities and futher info with each algorithm.
- Test coverage for each algorithm and data structure.
- Super sweet documentation.
- Test coverage for each algorithm and data structure.
- Super sweet `documentation`_.

Installation:
-------------
Expand Down Expand Up @@ -59,6 +59,8 @@ Contributing:
Contributions are always welcome. Check out the contributing guidelines to get
started.

.. _`docs`: http://algorithms.readthedocs.org/en/latest/
.. _`documentation`: http://algorithms.readthedocs.org/en/latest/

Table of Contents:
------------------
Expand Down

0 comments on commit 64e62a9

Please sign in to comment.