rst2textile 0.1.0

rst2textile is docutils textile writer convert reStructuredText(rst) to Textile format.

rst2textile is docutils textile writer convert reStructuredText(rst) to Textile format.

Features

• Docutils writer for textile.
  • supported syntaxes are:
    • headings: h1/h2..
    • docinfo: field-list (like :Date: today) at top of rst file.
    • paragraph
    • emphasis: *em*
    • strong: **strong**
    • list-item: * egg
    • enum-item: #. ham
    • blockquote
    • link: `foo <http://example.com/>`_
    • image: .. image:: http://example.com/image.png
    • literal: ``some code`` and ::
• Sphinx textile builder (experimental).
  1. write conf.py extensions = [‘docutils_textile’]
  2. build by sphinx-build -b textile source _build/textile

Install

$ pip install rst2textile

or:

$ pysetup install docutils
$ pysetup install rst2textile

If you wanto to use unrelease version, you can install from repository:

$ pysetup install https://bitbucket.org/shimizukawa/rst2textile/get/tip.zip

Run

$ rst2textile.py input.rst output.txt

or:

$ python -m rst2textile input.rst output.txt

Test

$ python setup.py test

or:

$ python test.py

currently, ‘pysetup run test’ not working.

Depends

• Python 2.7 (other version are not tested)
• Docutils 8.1 (other version are not tested)

Limitation

• Not supported: some textile syntax at http://redcloth.org/textile
• pysetup: Not support auto install dependency libraries(docutils).

ToDo

• Documentation
• Python3 Support & test
• Python2.6 Support & test

History

0.1.0 (2012/4/22)

• first release
• supported syntax: h1/h2.., docinfo, paragraph, em, strong, list-item, enum-item, blockquote, link, image, literal

Convert Samples

Heading1

rst:

==========
Heading1
==========

textile:

h1. Heading1

Headings

rst:

==========
Heading1
==========

Heading2
==========

Heading3
----------

Heading4
^^^^^^^^^^

textile:

h1. Heading1


h2. Heading2


h3. Heading3


h4. Heading4

Document Information

rst:

HelloWorld
===========

:Date: Today
:Author: SpamEgg
:Location: Here

textile:

h1. HelloWorld

Date:
   Today

Author:
   SpamEgg

Location:
   Here

Paragraph

rst:

Normal Text

textile:

Normal Text

Emphasized

rst:

*emphasized* (e.g., italics)

textile:

_emphasized_ (e.g., italics)

Strongly emphasized

rst:

**strongly emphasized** (e.g., boldface)

textile:

*strongly emphasized* (e.g., boldface)

List items

rst:

- An item in a bulleted (unordered) list

- Another item in a bulleted list

  - Second Level

  * Second Level Items

    * Third level

textile:

* An item in a bulleted (unordered) list
* Another item in a bulleted list
** Second Level
** Second Level Items
*** Third level

Enumerated list items

rst:

#. An item in an enumerated (ordered) list xxxxxxx
#. Another item in an enumerated list yyyyyy

   #. Another level in an enumerated list vvvvvvvv
   #. Another level in an enumerated list vvvvvvvv

#. 3rd element at indent level1

textile:

# An item in an enumerated (ordered) list xxxxxxx
# Another item in an enumerated list yyyyyy
## Another level in an enumerated list vvvvvvvv
## Another level in an enumerated list vvvvvvvv
# 3rd element at indent level1

Blockquotes

rst:

Blockquotes

   This text will be enclosed in an HTML blockquote element.

   Second Paragraph.

textile:

Blockquotes

bq. This text will be enclosed in an HTML blockquote element.
bq. Second Paragraph.

Links

rst:

`link text and link target url <http://www.example.com/link/target/address>`_

textile:

"link text and link target url":http://www.example.com/link/target/address

Images

rst:

.. image:: http://example.com/image.jpg

.. figure:: local/image/path.png

textile:

!http://example.com/image.jpg!

!local/image/path.png!

Inner Reference

rst:

HelloWorld
===========

reference to HelloWorld_ !

textile:

h1. HelloWorld

reference to "HelloWorld" !

Literal (code)

rst:

::

   class Foo(object):

       def __init__(self, value):
           print "value = %d" % value
           raise NotImplementedError(u'EmptyClass')

textile:

<pre>
class Foo(object):

    def __init__(self, value):
        print "value = %d" % value
        raise NotImplementedError(u'EmptyClass')
</pre>