diff options
| author | W. Trevor King <wking@tremily.us> | 2012-10-27 12:38:55 -0400 |
|---|---|---|
| committer | W. Trevor King <wking@tremily.us> | 2012-10-27 12:38:59 -0400 |
| commit | efbfa3d8671da280615daeeb8682e86ff9160297 (patch) | |
| tree | 3a3ec12995d2392927c67b1d35f55c3a1176858b /README | |
| parent | cf2dccfb50ccddb1d0a308f8f15f0a9362c57e2b (diff) | |
| download | bugseverywhere-efbfa3d8671da280615daeeb8682e86ff9160297.tar.gz | |
README: wrap doc/index.txt reference in backticks
File names, code, etc., should have special markup so they aren't
confused with regular text.
Diffstat (limited to 'README')
| -rw-r--r-- | README | 4 |
1 files changed, 2 insertions, 2 deletions
@@ -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. |