Mercurial > p > roundup > code
comparison README.txt @ 4702:3dc458554d68
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
| author | John Kristensen <john@jerrykan.com> |
|---|---|
| date | Sun, 16 Dec 2012 13:10:52 +1100 |
| parents | ef3e3c5e3501 |
| children | bbfc87ecfdf1 |
comparison
equal
deleted
inserted
replaced
| 4701:93c5489c0ede | 4702:3dc458554d68 |
|---|---|
| 35 | 35 |
| 36 Usage and Other Information | 36 Usage and Other Information |
| 37 =========================== | 37 =========================== |
| 38 See the index.txt file in the "doc" directory. | 38 See the index.txt file in the "doc" directory. |
| 39 The *.txt files in the "doc" directory are written in reStructedText. If | 39 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 | 40 you have Sphinx installed, you can convert these to HTML by running |
| 41 these to HTML by running "make html" in the "doc" directory. | 41 $ python setup.py build_doc |
| 42 from the top of the release directory. | |
| 42 | 43 |
| 43 | 44 |
| 44 For Developers | 45 For Developers |
| 45 ============== | 46 ============== |
| 46 To get started on development work, read the developers.txt file in | 47 To get started on development work, read the developers.txt file in |