Skip to content

Commit 1ee58cc

Browse files
author
Ewan Klein
committed
updated source docs for web pages
1 parent d954c8b commit 1ee58cc

File tree

3 files changed

+28
-25
lines changed

3 files changed

+28
-25
lines changed

web/Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ web: clean_api
2323
@echo
2424
@echo "Build finished. The HTML pages are in $(WEB)."
2525

26+
without_api: clean_api
27+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(WEB)
28+
2629
clean_api:
2730
rm -f api/modules.rst api/nltk.*.rst
2831

web/conf.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -44,16 +44,16 @@
4444

4545
# General information about the project.
4646
project = u'NLTK'
47-
copyright = u'2012, NLTK Project'
47+
copyright = u'2013, NLTK Project'
4848

4949
# The version info for the project you're documenting, acts as replacement for
5050
# |version| and |release|, also used in various other places throughout the
5151
# built documents.
5252
#
5353
# The short X.Y version.
54-
version = '2.0'
54+
version = '3.0'
5555
# The full version, including alpha/beta/rc tags.
56-
release = '2.0'
56+
release = '3.0'
5757

5858
# The language for content autogenerated by Sphinx. Refer to documentation
5959
# for a list of supported languages.
@@ -67,7 +67,7 @@
6767

6868
# List of patterns, relative to source directory, that match files and
6969
# directories to ignore when looking for source files.
70-
exclude_patterns = ['_build']
70+
exclude_patterns = ['_build', 'api/modules.rst', 'dev/*.rst']
7171

7272
# The reST default role (used for this markup: `text`) to use for all documents.
7373
#default_role = None
@@ -129,11 +129,11 @@
129129

130130
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
131131
# using the given strftime format.
132-
#html_last_updated_fmt = '%b %d, %Y'
132+
html_last_updated_fmt = '%b %d, %Y'
133133

134134
# If true, SmartyPants will be used to convert quotes and dashes to
135135
# typographically correct entities.
136-
#html_use_smartypants = True
136+
html_use_smartypants = True
137137

138138
# Custom sidebar templates, maps document names to template names.
139139
#html_sidebars = {}

web/index.rst

+19-19
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@ Natural Language Toolkit
22
========================
33

44
NLTK is a leading platform for building Python programs to work with human language data.
5-
It provides easy-to-use interfaces to over 50 corpora and lexical resources such as WordNet,
5+
It provides easy-to-use interfaces to `over 50 corpora and lexical
6+
resources <http://nltk.org/nltk_data/>`_ such as WordNet,
67
along with a suite of text processing libraries for classification, tokenization, stemming, tagging, parsing, and semantic reasoning.
78

89
Thanks to a hands-on guide introducing programming fundamentals alongside topics in computational linguistics,
@@ -17,7 +18,7 @@ introduction to programming for language processing.
1718
Written by the creators of NLTK, it guides the reader through the fundamentals
1819
of writing Python programs, working with corpora, categorizing text, analyzing linguistic structure,
1920
and more.
20-
A `new version <http://nltk.org/book3>` with updates for Python 3 and NLTK 3 is in preparation.
21+
A `new version <http://nltk.org/book3>`_ with updates for Python 3 and NLTK 3 is in preparation.
2122

2223
Some simple things you can do with NLTK
2324
---------------------------------------
@@ -48,41 +49,40 @@ Identify named entities:
4849

4950
Display a parse tree:
5051

51-
.. doctest::
52-
:options: +SKIP
53-
5452
>>> from nltk.corpus import treebank
5553
>>> t = treebank.parsed_sents('wsj_0001.mrg')[0]
5654
>>> t.draw()
5755

5856
.. image:: images/tree.gif
5957

60-
NB. If you publish work that uses NLTK, please cite the NLTK book as follows:
61-
Bird, Steven, Edward Loper and Ewan Klein (2009).
62-
Natural Language Processing with Python. O'Reilly Media Inc.
58+
NB. If you publish work that uses NLTK, please cite the NLTK book as
59+
follows:
60+
61+
Bird, Steven, Edward Loper and Ewan Klein (2009), *Natural Language Processing with Python*. O'Reilly Media Inc.
6362

64-
Links
65-
-----
63+
Community
64+
---------
65+
66+
* `NLTK mailing list <http://groups.google.com/group/nltk>`_ -- release announcements only, very low volume
67+
* `NLTK-Users mailing list <http://groups.google.com/group/nltk-users>`_ -- user discussions
68+
* `NLTK-Dev mailing list <http://groups.google.com/group/nltk-dev>`_ -- developers only
69+
* `NLTK-Translation mailing list <http://groups.google.com/group/nltk-translation>`_ -- discussions about translating the NLTK book
6670

67-
* `NLTK mailing list <http://groups.google.com/group/nltk>`_ - release announcements only, very low volume
68-
* `NLTK-Users mailing list <http://groups.google.com/group/nltk-users>`_ - user discussions
69-
* `NLTK-Dev mailing list <http://groups.google.com/group/nltk-dev>`_ - developers only
70-
* `NLTK-Translation mailing list <http://groups.google.com/group/nltk-translation>`_ - discussions about translating the NLTK book
71-
* `NLTK's previous website <https://sites.google.com/site/naturallanguagetoolkit>`_
72-
* `NLTK development at GitHub <https://github.com/nltk>`_
73-
* `Publications about NLTK <http://scholar.google.com.au/scholar?q=NLTK>`_
7471

7572
Contents
7673
========
7774

75+
7876
.. toctree::
7977
:maxdepth: 1
8078

8179
news
8280
install
8381
data
84-
howto
85-
api/nltk
82+
Wiki <https://github.com/nltk/nltk/wiki>
83+
API <api/nltk>
84+
HOWTO <http://nltk.org/howto>
85+
NLTK Development <https://github.com/nltk>
8686
team
8787

8888
* :ref:`genindex`

0 commit comments

Comments
 (0)