Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Quick an dirty tool to transform text in Trac Wiki formatting to Restructured Text

Project Description

trac2rst

I use trac2rst to help me in the task to pass documentacion from trac to sphinx (reStructuredText). I usally copy the trac wiki page to a temporaly file, run the script, copy the output to the new rest file and do manual changes.

Features

The idea is use this tool to do the more tedious work (I mean transforming lists, links and inliners). You must review and fix the result later.

It only processes:
  • Headers (sections at 4 levels)
  • Lists (bullets and numbered)
  • Trac links.
  • A subject of trac and rest inliners
It does NOT support (a lot):
  • Trac macros
  • Trac processors
  • Links between wiki pages
  • Rest definition lists, etc
  • Preformatting
  • Images
  • Tables
  • Footnotes
  • Anchors
  • Citations
  • Comments
  • A lot more …

Usage example

Type trac2rst –help

You can view a simple wiki transfomation (used for manual test):

$ bin/trac2rst -i src/trac2rst/tests/wikitext.txt -u https://trac.yaco.es/project/  -o /tmp/test.rst && rst2html /tmp/test.rst /tmp/test.html && firefox /tmp/test.html

Disclaimer

This is a quick and dirty tool. It does not use reST or wiki processor. The work is done using regular expressions.

License

trac2rst is offered under the MIT license.

Authors

trac2rst is made available by Yaco Sistemas

Changelog

0.2.1 (2011-12-19)

  • fix error in project url

0.2 (2011-12-19)

  • pep8 compliant
  • Global variables removed
  • Set a TODO comment por preformated text

0.1 (2011-12-19)

  • First Release
Release History

Release History

This version
History Node

0.2.1

History Node

0.2

History Node

0.1

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
trac2rst-0.2.1.tar.gz (9.5 kB) Copy SHA256 Checksum SHA256 Source Dec 19, 2011

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting