[Debexpo-devel] [debexpo] 01/32: Add links to the debexpo docs on Read the Docs to README.rst

[Kentaro Hayashi]

This is an automated email from the git hooks/post-receive script.

kenhys-guest pushed a commit to branch master
in repository debexpo.

commit e76fa7439cde25505812d193a9ae4b878a582a39
Author: Eeshan Garg <jerryguitarist at gmail.com>
Date:   Thu May 7 19:08:08 2015 +0530

    Add links to the debexpo docs on Read the Docs to README.rst
---
 README.rst | 30 ++++++++++++++++++++----------
 1 file changed, 20 insertions(+), 10 deletions(-)

diff --git a/README.rst b/README.rst
index 18806ce..9bd4aa4 100644
--- a/README.rst
+++ b/README.rst
@@ -1,18 +1,20 @@
 .. image:: https://travis-ci.org/alex/what-happens-when.svg?branch=master
     :target: https://travis-ci.org/alex/what-happens-when
 
-installing and running debexpo
+Installing and running debexpo
 ==============================
 
-For installation instructions, see docs/installing.rst
+For installation instructions, see `Installing and setting up debexpo`_.
 
+.. _Installing and setting up debexpo: http://debexpo.readthedocs.org/en/latest/installing.html#installing
 
-running tests
+
+Running tests
 =============
 
 Hooray! Now you're ready to run the automated tests. (The code for the
-tests lives in debexpo/tests/*. This is a test suite; you can read more at
-http://en.wikipedia.org/wiki/Test_suite .)
+tests lives in ``debexpo/tests/*``. This is a test suite; you can read
+more about test suites `here`_.)
 
 ::
 
@@ -23,7 +25,9 @@ As of the time of writing, all the tests pass.
 (Nosetests is a "test runner" package that provides some useful add-ons. It
 has its own idiosyncracies, though.)
 
-debugging a debexpo test that fails
+.. _here: http://en.wikipedia.org/wiki/Test_suite
+
+Debugging a debexpo test that fails
 ===================================
 
 So you've found a test that fails (F) or exits with an unhandled exception (E)?
@@ -33,21 +37,27 @@ Run the test suite with these parameters::
 
   % nosetests --with-pylons=test.ini --pdb-failures --pdb-errors
 
-(If you've used pdb.set_trace(), this is an automatic way that Nose gives
+(If you've used ``pdb.set_trace()``, this is an automatic way that Nose gives
 you that functionality.)
 
 debexpo documentation
 =====================
 
-The debexpo documentation is being stored in restructured text inside the
-docs/ directory. You can find the current installation guide at
-docs/installing.rst. You should build and view the html docs by executing::
+You can read the `debexpo documentation on Read the Docs`_.
+
+The debexpo documentation is written in `reStructuredText`_ and can be found
+inside the ``docs/`` directory. You can find the current installation guide at
+``docs/installing.rst``. You can build and view the HTML docs locally by
+executing::
 
   % sudo apt-get install python-sphinx # needed to build the docs
   % cd docs/
   % make html
   % sensible-browser .build/html/index.html
 
+.. _reStructuredText: http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html
+.. _debexpo documentation on Read the Docs: http://debexpo.readthedocs.org/en/latest/index.html
+
 Git synchronization
 ===================
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debexpo/debexpo.git