Skip to content

Commit c39e7b3

Browse files
committed
Small docs fixes
1 parent 72f61c1 commit c39e7b3

File tree

3 files changed

+19
-9
lines changed

3 files changed

+19
-9
lines changed

README.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Features
3838
Quickstart
3939
----------
4040

41-
Installing WordSegment is simple with
41+
Installing `WordSegment`_ is simple with
4242
`pip <http://www.pip-installer.org/>`_::
4343

4444
$ pip install wordsegment
@@ -63,10 +63,10 @@ phrase into a list of its parts::
6363
The `load` function reads and parses the unigrams and bigrams data from
6464
disk. Loading the data only needs to be done once.
6565

66-
WordSegment also provides a command-line interface for batch processing. This
67-
interface accepts two arguments: in-file and out-file. Lines from in-file are
68-
iteratively segmented, joined by a space, and written to out-file. Input and
69-
output default to stdin and stdout respectively. ::
66+
`WordSegment`_ also provides a command-line interface for batch
67+
processing. This interface accepts two arguments: in-file and out-file. Lines
68+
from in-file are iteratively segmented, joined by a space, and written to
69+
out-file. Input and output default to stdin and stdout respectively. ::
7070

7171
$ echo thisisatest | python -m wordsegment
7272
this is a test
@@ -123,8 +123,19 @@ Some bigrams begin with `<s>`. This is to indicate the start of a bigram::
123123
The unigrams and bigrams data is stored in the `wordsegment` directory in
124124
the `unigrams.txt` and `bigrams.txt` files respectively.
125125

126-
Reference and Indices
127-
---------------------
126+
User Guide
127+
----------
128+
129+
* `Word Segment API Reference`_
130+
* `Using a Different Corpus`_
131+
* `Python: Load dict Fast From File`_
132+
133+
.. _`Word Segment API Reference`: http://www.grantjenks.com/docs/wordsegment/api.html
134+
.. _`Using a Different Corpus`: http://www.grantjenks.com/docs/wordsegment/using-a-different-corpus.html
135+
.. _`Python: Load dict Fast From File`: http://www.grantjenks.com/docs/wordsegment/python-load-dict-fast-from-file.html
136+
137+
References
138+
----------
128139

129140
* `WordSegment Documentation`_
130141
* `WordSegment at PyPI`_

docs/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151

5252
# General information about the project.
5353
project = u'Word Segment'
54-
copyright = u'2016, Grant Jenks'
54+
copyright = u'2017, Grant Jenks'
5555
author = u'Grant Jenks'
5656

5757
# The version info for the project you're documenting, acts as replacement for

docs/python-load-dict-fast-from-file.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
Python: Load Dict Fast from File
32
================================
43

0 commit comments

Comments
 (0)