README: wrap doc/index.txt reference in backticks
authorW. Trevor King <wking@tremily.us>
Sat, 27 Oct 2012 16:38:55 +0000 (12:38 -0400)
committerW. Trevor King <wking@tremily.us>
Sat, 27 Oct 2012 16:38:59 +0000 (12:38 -0400)
File names, code, etc., should have special markup so they aren't
confused with regular text.

README

diff --git a/README b/README
index 82f52c8b5649a807cb8a6a0447fb4bf2a21e967e..c143e1cb86b4ecd4bab84f84803303404b6fbaad 100644 (file)
--- a/README
+++ b/README
@@ -57,8 +57,8 @@ If ``be help`` isn't scratching your itch, the full documentation is
 available in the doc directory as reStructuredText_ .  You can build
 the full documentation with Sphinx_ , convert single files with
 docutils_ , or browse through the doc directory by hand.
-doc/index.txt is a good place to start.  If you do use Sphinx, you'll
-need to install numpydoc_ for automatically generating API
+``doc/index.txt`` is a good place to start.  If you do use Sphinx,
+you'll need to install numpydoc_ for automatically generating API
 documentation.  See the ``NumPy/SciPy documentation guide``_ for an
 introduction to the syntax.