README

# Copyright (c) 2009 Ars Aperta, Itaapy, Pierlis, Talend.
#
# This file is part of Lpod (see: http://lpod-project.org).
# Lpod is free software; you can redistribute it and/or modify it under
# the terms of either:
#
# a) the GNU General Public License as published by the Free Software
#    Foundation, either version 3 of the License, or (at your option)
#    any later version.
#    Lpod is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#    You should have received a copy of the GNU General Public License
#    along with Lpod.  If not, see <http://www.gnu.org/licenses/>.
#
# b) the Apache License, Version 2.0 (the "License");
#    you may not use this file except in compliance with the License.
#    You may obtain a copy of the License at
#    http://www.apache.org/licenses/LICENSE-2.0
#

Build the doc
-------------

Before attempting to build the documentation, you should::

- install the python part of the lpOD project[1]. 
- install Sphinx http://sphinx.pocoo.org 
- install texlive http://www.tug.org/texlive/ 

Makefile
---------
::

  luis@spinoza ~/lpod/sandbox/lpod/doc $ make
  Please use `make <target>' where <target> is one of
    html      to make standalone HTML files
    latex     to make LaTeX files, you can set PAPER=a4 or PAPER=letter
    pdf       to make PDF files, you can set PAPER=a4 or PAPER=letter
    changes   to make an overview over all changed/added/deprecated items
    linkcheck to check all external links for integrity
    release   to make html/pdf and store the files in two tar.gz