From efbfa3d8671da280615daeeb8682e86ff9160297 Mon Sep 17 00:00:00 2001 From: "W. Trevor King" Date: Sat, 27 Oct 2012 12:38:55 -0400 Subject: [PATCH] README: wrap doc/index.txt reference in backticks File names, code, etc., should have special markup so they aren't confused with regular text. --- README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README b/README index 82f52c8..c143e1c 100644 --- 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. -- 2.26.2