https://github.com/jacob414/flexirest

https://github.com/jacob414/flexirest

documentation latex pdf pdf-generation python restructured-text

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/jacob414/flexirest
• Owner: jacob414
• Created: 2010-12-01T17:23:53.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2019-10-25T13:51:44.000Z (about 5 years ago)
• Last Synced: 2025-01-03T03:42:45.246Z (7 days ago)
• Topics: documentation, latex, pdf, pdf-generation, python, restructured-text
• Language: Python
• Homepage: http://www.aspektratio.net/flexirest/
• Size: 486 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
.. -*- mode: rst -*-

.. -*- Coding: utf-8 -*-

**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.

.. _reStructuredText: http://docutils.sourceforge.net/rst.html

`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.

.. _docutils: http://docutils.sourceforge.net/

.. _Sphinx: http://sphinx.pocoo.org/

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.

.. _roles: http://docutils.sourceforge.net/docs/howto/rst-roles.html

For more information on how to operate `flexirest`, see the

`quick manual`_.

.. _quick manual: quick-manual.html

.. _setuptools: http://pypi.python.org/pypi/setuptools

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