added more rst samples (sublists)
[rst2info.git] / README
blobdd0d8e23f12755152f5853ac0908a4500dd0a147
1 ================================================================
2 rst2info - Convert reStructuredText to TexInfo
3 ================================================================
5 Source code
6 ===========
7 http://repo.or.cz/w/rst2info.git
9 Prerequisites
10 =============
11 sudo apt-get install python-nose python-docutils
13 Run tests
14 =========
15 $ nosetests
17 Self-indulgent description
18 ==========================
19 You are dusting cobwebs off rst2info, a project that began in July
20 2009 with the good intentions of eventually being able to convert
21 Python documentation into Texinfo format, so the Author could browse
22 the blasted thing into Emacs as the gods intended.
24 See, Python 2.6 (and 3.0) switched documentation formats to
25 yet-another-light-markup-language which could only produce HTML and
26 PDF files out of the box, meaning the info files we were used to from
27 2.5 and earlier disappeared. Fortunately, the same powers that be that
28 decided to invent yet-another-light-markup-language went some way
29 towards clawing their way out of the pit by developing a decent enough
30 parsing and processing toolkit for the thing.
32 On the upside, there was a good looking framework to start building
33 upon. On the downside, the Author had no real knowledge of either
34 reStructuredText or Texinfo format, and I suspect not enough
35 enthusiasm to learn either in depth suitable for the task, so the
36 whole thing was doomed from the first commit.
38 So while you've been reading this, and wondering what is is about the
39 internet that leads you to spend your time on that sort of thing, the
40 Author has probably long since lost interest and is reading something
41 else on the internet, and wondering what it is that leads him to spend
42 his time on that sort of thing.
44 In the mean time, I suggest you clone the repo, run nosetests, and see
45 just what got done before the Apathycalypse. If it serves as any sort
46 of a useful codebase for you, good luck with it.