Mirror of our build engine
Go to file
Martin A. Brown 9ffdd1df5d support SourceDocument as directory nam
allow the driver to use the new feature of sources.py and SourceDocument, so
user can refer to simply a directory as the document
2016-02-26 18:04:39 -08:00
tests pep8 fixes 2016-02-26 13:24:10 -08:00
tldp support SourceDocument as directory nam 2016-02-26 18:04:39 -08:00
.gitignore no need to track the .pyc files 2016-02-15 21:06:07 -08:00
LICENSE adding the text of the MIT license 2016-02-22 12:43:59 -08:00
README.rst better introductory text 2016-02-22 12:46:49 -08:00
TODO do not forget about cleanup of index.sgml files 2016-02-26 10:10:08 -08:00
setup.py adjusting trove classifiers, removing six dep 2016-02-22 12:46:35 -08:00

README.rst

tldp - tools for publishing from TLDP sources
=============================================
A toolset for publishing multiple output formats of a source document to an
output directory.  The supported source formats can be listed, but contain at
least, Linuxdoc, DocBookSGML and DocBook XML 4.x.

TLDP = The Linux Documentation Project.

These are a set of scripts that process committed documents in the
TLDP document source repository to an output tree of choice.


Installation
------------

You can install, upgrade, uninstall tldp tools with these commands::

  $ pip install tldp
  $ pip install --upgrade tldp
  $ pip uninstall tldp

There's also a package for Debian/Ubuntu, but it's not always the
latest version.

Example usages:
---------------

FIXME:  Missing examples.

Links
-----

* `Output documentation tree (sample) <http://www.tldp.org/>`_

* `Source tree on GitHub <https://github.com/tLDP/LDP>`_