Skip to content
Python Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
deps
docs
externals
flexirest
test
.gitignore
README.rst
TODO.txt
pavement.py
pytest.ini
setup.cfg
setup.py

README.rst

NOTE: This is now officially abandonware. Pandoc has now completely caught up with the purpose of this. It's also using a very out of date programming style. This makes it impossible for me to take it up again. Sorry, past me ;-)

Flexirest is a project that was born out of the authors long-running interest for reStructuredText, and the idea of writing everyday documents like letters, invoices and other simple documents in this way.

Flexirest tries to strike a middle ground between docutils own command line tool chain (rst2html et al), that I find a little to minimalistic and Sphinx, that I find very nice but a little heavy to use for a quickie document like a random letter or some such.

In short, the goal of flexirest is to enable you to use the reST format for everyday documents instead of a word processor or similar with minimal fuzz. Hence you get to stay in the comfy environment of your text editor and tool chain. And you can check in your docs in text format into your version control system of choice. And, if used correctly, you get to reuse a couple of stylings that you only need to create once.

There are some modestly advanced tricks you can do too, primarily writing your own docutils roles, but I wouldn't consider those the major points of flexirest.

For more information on how to operate flexirest, see the quick manual.

Changes

0.8.2

  • A mechanism of two-stage writing used to support a new writer, latex2pdf that renders directly to PDF via LaTeX if a suitable executable is available on the host system.
  • --infile option to specify input from a file
  • --outfile option to specify output to a file
  • --dump-parts option to inspect output from different docutils parts.
  • --list-writer option to list available writers on the host system.
  • No traceback when specifying a non-existant writer
  • All writers have at least the minimal template (%(whole)s)
  • Switch to Distribute instead of setuptools for development and packaging.
  • Many small bugfixes and stability improvements
You can’t perform that action at this time.