Mirror of our build engine
Go to file
Martin A. Brown 85b2b15c3b build a graph of method dependencies
to allow individual subclasses of BaseDoctype to be able to implement as many
methods as they want to create document outputs, the BaseDoctype now
implements a graph of method dependencies.  The sequence of tasks is
determined by applying the @depends decorator to the methods in the
heavy-lifting classes which actually implement the document procsesing.

For example, the Linuxdoc class will probably have about 6 or 7 methods to
generate the outputs, whereas, the more complex DocbookSGML class will have at
least two or three more to handle the build-time index-generation (if
necessary for the document).
2016-02-26 00:30:37 -08:00
tests beefing up some testing for new functions 2016-02-23 13:10:10 -08:00
tldp build a graph of method dependencies 2016-02-26 00:30:37 -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 add automatic detection of config_fragments 2016-02-25 09:58:11 -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>`_