Skip to content

Commit 1b46e7d

Browse files
committed
issue2550774: Fix generation of documentation
- sphinx has replaced rst2html to generate the documentation, so the rst2html stuff is removed, and update the README - add the missing sphinx docs/conf.py file to the MANIFEST
1 parent c716239 commit 1b46e7d

File tree

4 files changed

+9
-26
lines changed

4 files changed

+9
-26
lines changed

CHANGES.txt

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,11 @@ Fixed:
6969
also consume xml data and do something different. So require the use
7070
of 'http(s)://.../xmlrpc' uri to trigger the xmlrpc interface.
7171
(John Rouillard)
72+
- issue2550774: Remove generating documentation with rst2html, and update the
73+
README.txt with how to create the html docs using sphinx, thanks Kai Storbeck
74+
(John Kristensen)
75+
- issue2550774: Include doc/conf.py in the release tarball, so people can build
76+
their own documentation in html, thanks Kai Storbeck (John Kristensen)
7277

7378
2012-05-15: 1.4.20
7479

MANIFEST.in

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ recursive-include doc *.html *.png *.txt *.css *.1 *.example
88
recursive-include detectors *.py
99
recursive-include templates *.* home* page*
1010
global-exclude .svn .cvsignore *.pyc *.pyo .DS_Store
11-
include run_tests.py *.txt demo.py MANIFEST.in MANIFEST
11+
include run_tests.py *.txt demo.py MANIFEST.in MANIFEST doc/conf.py
1212
exclude BUILD.txt I18N_PROGRESS.txt TODO.txt
1313
exclude doc/security.txt doc/templating.txt
1414
include locale/*.po locale/*.mo locale/roundup.pot

README.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ Usage and Other Information
3737
===========================
3838
See the index.txt file in the "doc" directory.
3939
The *.txt files in the "doc" directory are written in reStructedText. If
40-
you have rst2html installed (part of the docutils suite) you can convert
41-
these to HTML by running "make html" in the "doc" directory.
40+
you have Sphinx installed, you can convert these to HTML by running
41+
$ python setup.py build_doc
42+
from the top of the release directory.
4243

4344

4445
For Developers

doc/Makefile

Lines changed: 0 additions & 23 deletions
This file was deleted.

0 commit comments

Comments
 (0)