Merge pull request #55 from SanketDG/docfix

Minor doc fixes
networkx · Aug 18, 2015 · 82e4f50 · 82e4f50
2 parents a6ac493 + 87903ae
commit 82e4f50
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 9 deletions.
diff --git a/doc/source/bibliography.rst b/doc/source/bibliography.rst
@@ -0,0 +1,11 @@
+..  -*- coding: utf-8 -*-
+
+Bibliography
+============
+
+.. [Langtangen04] H.P. Langtangen, "Python Scripting for Computational
+    Science.", Springer Verlag Series in Computational Science and
+    Engineering, 2004.
+
+.. [Martelli03]  A. Martelli, "Python in a Nutshell", O'Reilly Media
+   Inc, 2003.
diff --git a/doc/source/download.rst b/doc/source/download.rst
@@ -5,7 +5,7 @@ Download
 Software
 ~~~~~~~~
 
-Source and binary releases: https://pypi.python.org/pypi/networkx/
+Source and binary releases: https://pypi.python.org/pypi/networkx-metis/
 
 Github (latest development): https://github.com/networkx/networkx-metis/
 
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -15,6 +15,7 @@ Contents:
    download
    install
    reference/index
+   bibliography
 
 Indices and tables
 ==================

diff --git a/doc/source/overview.rst b/doc/source/overview.rst
@@ -3,25 +3,24 @@
 Overview
 ========
 
-NetworkX-METIS is an add-on for the python language software NetworkX which depends uses METIS for graph partitioning.
+NetworkX-METIS is an add-on for the `NetworkX`_ python package using `METIS`_ for graph partitioning.
 
 
 Who uses NetworkX-METIS?
-------------------
-  
+------------------------
+
 Goals
 -----
 
 The Python programming language
 -------------------------------
 
-Python is a powerful programming language that allows simple and flexible representations of networks, and  clear and concise expressions of network algorithms (and other algorithms too).  Python has a vibrant and growing ecosystem of packages that NetworkX uses to provide more features such as numerical linear algebra and drawing.  In addition 
-Python is also an excellent "glue" language for putting together pieces of software from other languages which allows reuse of legacy code and engineering of high-performance algorithms [Langtangen04]_. 
+Python is a powerful programming language that allows simple and flexible representations of networks, and  clear and concise expressions of network algorithms (and other algorithms too).  Python has a vibrant and growing ecosystem of packages that NetworkX uses to provide more features such as numerical linear algebra and drawing.  In addition
+Python is also an excellent "glue" language for putting together pieces of software from other languages which allows reuse of legacy code and engineering of high-performance algorithms [Langtangen04]_.
 
-Equally important, Python is free, well-supported, and a joy to use. 
+Equally important, Python is free, well-supported, and a joy to use.
 
-In order to make the most out of NetworkX you will want to know how to write basic programs in Python.  
-Among the many guides to Python, we recommend the documentation at
+In order to make the most out of NetworkX-METIS you will want to know how to write basic programs in Python. Among the many guides to Python, we recommend the documentation at
 http://www.python.org and the text by Alex Martelli [Martelli03]_.
 
 Free software
@@ -47,3 +46,7 @@ What Next
  - :doc:`Installing </install>`
 
  - :doc:`Reference </reference/index>`
+
+ .. _NetworkX: http://http://networkx.github.io/
+
+ .. _METIS: http://glaros.dtc.umn.edu/gkhome/metis/metis/overview