Remove outdated docs about Python bindings

parent 774cd3ff
These Python bindings are experimental meaning that there is no guarantee of backwards compatibility with future KDE 4 series releases. This is because the C++ marble library itself doesn't carry a guarantee of backwards compatibility, although this may change in the future.
The bindings are not built by default. To build them pass the option -DEXPERIMENTAL_PYTHON_BINDINGS=TRUE to cmake and make sure that the Python support from the kde-bindings module is installed.
-- Simon Edwards <simon@simonzone.com>
This diff is collapsed.
########### install files ###############
install(FILES
artistic-license.html
bsd-license.html fdl-license fdl-license.html gpl-license gpl-license.html
lgpl-license lgpl-license.html qpl-license.html x11-license.html
xml.dcl
doxygen.css
tabs.css
header.html
footer.html
mainheader.html
mainfooter.html
fdl-notice.html
favicon.ico
block_title_bottom.png
block_title_mid.png
block_title_top.png
top-kde.jpg
top-left.jpg
top-right.jpg
top.jpg
bottom-left.png
bottom-right.png
bottom-middle.png
kde-default.css
kde_logo_bg.png
top-middle.png
top-right.png
top-left.png
1.png 2.png 3.png 4.png 5.png 6.png 7.png 8.png 9.png 10.png
DESTINATION ${HTML_INSTALL_DIR}/en/common)
OUTPUT_LANGUAGE = English
USE_WINDOWS_ENCODING = NO
BRIEF_MEMBER_DESC = NO
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF =
ALWAYS_DETAILED_SEC = YES
INLINE_INHERITED_MEMB = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
SHORT_NAMES = NO
JAVADOC_AUTOBRIEF = YES
MULTILINE_CPP_IS_BRIEF = NO
INHERIT_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 4
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
SUBGROUPING = YES
EXTRACT_ALL = YES
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = YES
EXTRACT_LOCAL_CLASSES = NO
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = YES
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = YES
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_BRIEF_DOCS = YES
SORT_BY_SCOPE_NAME = NO
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_FORMAT =
WARN_LOGFILE =
INPUT =
FILE_PATTERNS = *.h \
*.cpp \
*.cc \
*.hpp \
*.dox \
*.c++ \
*.cxx \
*.h++ \
*.hh
RECURSIVE = YES
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS = */.svn/* \
*/.git/* \
*/cmake/* \
*.moc.* \
moc* \
*.all_cpp.* \
*unload.* \
*/test/* \
*/tests/* \
*_p.h *_p.cpp
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
SOURCE_BROWSER = YES
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 3
HTML_OUTPUT =
HTML_FILE_EXTENSION = .html
HTML_HEADER = ../apidocs/common/header.html
HTML_FOOTER = ../apidocs/common/footer.html
HTML_STYLESHEET = ../apidocs/common/doxygen.css
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = YES
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
GENERATE_LATEX = NO
LATEX_OUTPUT =
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
GENERATE_RTF = NO
RTF_OUTPUT =
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
GENERATE_MAN = NO
MAN_OUTPUT =
MAN_EXTENSION = .kde3
MAN_LINKS = YES
GENERATE_XML = NO
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = NO
GENERATE_AUTOGEN_DEF = NO
GENERATE_PERLMOD = NO
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
ENABLE_PREPROCESSING = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
ALLEXTERNALS = NO
EXTERNAL_GROUPS = NO
PERL_PATH =
CLASS_DIAGRAMS = YES
HIDE_UNDOC_RELATIONS = NO
HAVE_DOT = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
MAX_DOT_GRAPH_WIDTH = 800
MAX_DOT_GRAPH_HEIGHT = 1024
MAX_DOT_GRAPH_DEPTH = 0
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
SEARCHENGINE = NO
### KDE Settings
ALIASES = \
"intern=\par<b>Internal use only.</b>" \
"reimp=\par<b>Reimplemented from superclass.</b>" \
"obsolete=@deprecated" \
"feature=\xrefitem features \"Feature(s)\" \"Features\"" \
"unmaintained=\xrefitem unmaintained \"Unmaintained\" \"Unmaintained\"" \
"requirement=\xrefitem requirements \"Requirement(s)\" \"Requirements\"" \
"faq=\xrefitem FAQ \"F.A.Q.\" \"F.A.Q.\"" \
"authors=\xrefitem authors \"Author(s)\" \"Authors\"" \
"maintainers=\xrefitem maintainers \"Maintainer(s)\" \"Maintainers\"" \
"port4=\xrefitem port4 \"KDE 4 Porting Guide\" \"KDE 4 Porting Guide\"" \
"glossary=\xrefitem glossary \"KDE 4 Glossary\" \"KDE 4 Glossary\"" \
"acronym=\b "\
"licenses=\xrefitem licenses \"License(s)\" \"Licenses\"" \
"FIXME=\xrefitem fixme \"Fixme\" \"Fixme\"" \
"bc=\xrefitem bc \"Binary Compatible\" \"Binary Compatible\"" \
"threadsafe=\xrefitem threadsafe \"Threadsafe\" \"Threadsafe\"" \
"artistic=<a href=\"http://www.opensource.org/licenses/artistic-license.php\">Artistic</a>" \
"bsd=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#5\">BSD</a>" \
"x11=<a href=\"http://www.xfree86.org/3.3.6/COPYRIGHT2.html#3\">X11</a>" \
"gpl=<a href=\"http://www.gnu.org/licenses/old-licenses/gpl-2.0.html#SEC1\">GPLv2</a>" \
"lgpl=<a href=\"http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html#SEC1\">LGPLv2</a>" \
"qpl=<a href=\"http://www.trolltech.com/products/qt/licenses\">QPL</a>"
HTML_ALIGN_MEMBERS = YES
REFERENCED_BY_RELATION = NO
REFERENCES_RELATION = NO
VERBATIM_HEADERS = NO
SOURCE_BROWSER = YES
GENERATE_AUTOGEN_DEF = NO
DETAILS_AT_TOP = YES
SORT_MEMBER_DOCS = YES
GENERATE_TODOLIST = YES
IGNORE_PREFIX = K
CLASS_GRAPH = YES
COLLABORATION_GRAPH = NO
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
***
*** README for KDE's Doxygen tools
***
This directory contains tools and data files for Doxygen
generation. These are the GENERIC files; any module may
override them by putting specific replacements in doc/api/ .
This allows modules to customize their appearance as desired.
The files that may be overridden are:
- doxygen.css Stylesheet.
- mainheader.html Header for front page of dox. This should
not be terribly different from header.html.
It might contain special CSS for the footer.
- mainfooter.html Footer for front page of dox. This should at
least credit Doxygen [1] and point to the dox
guidelines [2].
- header.html Header file for regular pages.
- footer.html Footer file for regular pages.
- Doxyfile.global The global (brief) Doxyfile. For a long-style
Doxyfile, see KDE PIM's doc/api/Doxyfile.pim.
The tool for generating dox lives in admin/ :
- doxygen.sh Script that does all the dox generation work.
See below for usage information.
In a configured build directory, you can use "make apidox" to
generate the API dox for the module -- assuming it has any, of course.
Writing dox is beyond the scope of this README -- see the notes at
http://techbase.kde.org/Policies/Library_Documentation_Policy .
You can generate dox by hand -- without even having a configured
build directory -- as explained below. There is also documentation
for the special tags you can enter in Makefile.am anywhere
in a module to modify dox generation.
***
*** Tool usage.
***
Usage:
doxygen.sh [--recurse] [--modulename] [--doxdatadir=<dir>] [--installdir=<dir>]
<top_srcdir> [<subdir>]
--recurse Also generate dox in subdirs of the given <subdir>. If no
<subdir> is given, --recurse is the default and can be
turned off with --no-recurse.
--modulename By default, apidox are generated in a subdirectory
<modulename>-apidocs/ . You can use --no-modulename to
suppress the <modulename> and generate the apidox in
a subdirectory apidocs/ . Modulename is the last part of
the <top_srcdir> (usually a KDE SVN module name).
--doxdatadir=<dir> Locate the HTML header files and support graphics.
In kdelibs, the subdirectory doc/common/ contains these
files (and this README). In an installed KDE system,
$KDEDIR/share/doc/HTML/en/common/ contains a copy.
This argument is mandatory if doxygen.sh can't guess where
the doxdata lives.
--installdir=<dir> Locate the directory where apidox from other modules
is installed. Subdirectories named *-apidocs/ under the
named <dir> are searched for tag files, for cross-module
cross-referencing.
How to generate dox manually: <TODO>
Plan to fit these tools into ../Doxyfile.am: <TODO>
Differences with current dox: <TODO>
# A shell script that builds dox without all the tedious mucking about with
# autoconf and configure. Run it in the "top builddir" with one argument,
# the "top srcdir". Something like this:
#
# cd /mnt/build/kdepim
# sh /mnt/src/kdepim/doc/api/doxygen.sh /mnt/src/kdepim
#
# You can also build single subdirs (for instance, after updating some
# dox and you don't want to rebuild for the enitre module) by giving the
# subdirectory _relative to the top srcdir_ as a second argument:
#
# sh /mnt/src/kdepim/doc/api/doxygen.sh /mnt/src/kdepim kpilot/lib
#
# When generating dox for kdelibs, a tag file for Qt is also created.
# The location of Qt is specified indirectly through $QTDOCDIR or,
# if that is not set, $QTDIR, or otherwise guessed. You may explicitly
# set the location of a pre-generated tag file with $QTDOCTAG. One
# typical approach might be:
#
# QTDOCTAG=$QTDIR/doc/qt.tag QTDOCDIR=http://doc.trolltech.com/3.3/
#
# Finally, there is a --no-recurse option for top-level generation
# that avoids generating all the subdirectories as well. It also
# suppresses cleaning up (rm -rf) of the dox direction beforehand.
#
# Post-finally, there is a --no-modulename option that builds the
# dox in "apidocs/" instead of "modulename-apidocs". The former is
# compatible with the KDE 3.4 build system, the latter is more convenient
# for the installed dox.
#
# A shell script to post-process doxy-generated files; the purpose
# is to make the menu on the left in the file match the actually
# generated files (ie. leave out namespaces if there are none).
#
# Usage: doxyndex.sh <toplevel-apidocs-dir> <relative-html-output-directory>
#
# Typically, this means $(top_builddir)/apidocs and something like
# libfoo/html for the output. For the top-level dig, set relative-html
# to "." . In non-top directories, both <!-- menu --> and <!-- gmenu -->
# are calculated and replaced. Top directories get an empty <!-- menu -->
# if any.
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html40/strict.dtd">
<HTML LANG="en-US">
<HEAD>
<TITLE>The "Artistic License"</TITLE>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=us-ascii">
<META HTTP-EQUIV="Content-Language" CONTENT="en-US">
<META NAME="description" CONTENT="Artistic License">
<META NAME="keywords" CONTENT="Artistic, artistic, Artistic License, Artistic license, Artisticlicense, artistic license, artisticlicense, Artistic Licence, Artistic licence, Artisticlicence, artistic licence, artisticlicence, license, licence, software, softwarelicense">
<META NAME="robots" CONTENT="none">
<META HTTP-EQUIV="Content-Style-Type" CONTENT="text/css">
<LINK REL="stylesheet" HREF="kde-default.css" TYPE="text/css">
</HEAD>
<BODY CLASS="license">
<H1>The "Artistic License"</H1>
<H2>Preamble</H2>
<P>The intent of this document is to state the conditions under
which a Package may be copied, such that the Copyright Holder
maintains some semblance of artistic control over the
development of the package, while giving the users of the
package the right to use and distribute the Package in a
more-or-less customary fashion, plus the right to make
reasonable modifications.</P>
<H2>Definitions</H2>
<P>"Package" refers to the collection of files distributed by the
Copyright Holder, and derivatives of that collection of files
created through textual modification.</P>
<P>"Standard Version" refers to such a Package if it has not been
modified, or has been modified in accordance with the wishes of
the Copyright Holder as specified below.</P>
<P>"Copyright Holder" is whoever is named in the copyright or
copyrights for the package.</P>
<P>"You" is you, if you're thinking about copying or distributing
this Package.</P>
<P>"Reasonable copying fee" is whatever you can justify on the
basis of media cost, duplication charges, time of people
involved, and so on. (You will not be required to justify it to
the Copyright Holder, but only to the computing community at
large as a market that must bear the fee.)</P>
<P>"Freely Available" means that no fee is charged for the item
itself, though there may be fees involved in handling the
item. It also means that recipients of the item may redistribute
it under the same conditions they received it.</P>
<OL STYLE="list-style-type: decimal;">
<LI><DIV CLASS="li">You may make and give away verbatim copies of the source
form of the Standard Version of this Package without
restriction, provided that you duplicate all of the original
copyright notices and associated disclaimers.</DIV></LI>
<LI>You may apply bug fixes, portability fixes and other
modifications derived from the Public Domain or from the
Copyright Holder. A Package modified in such a way shall still
be considered the Standard Version.</LI>
<LI>You may otherwise modify your copy of this Package in any
way, provided that you insert a prominent notice in each
changed file stating how and when you changed that file, and
provided that you do at least ONE of the following:
<OL STYLE="list-style-type: lower-alpha;">
<LI>place your modifications in the Public Domain or
otherwise make them Freely Available, such as by posting
said modifications to Usenet or an equivalent medium, or
placing the modifications on a major archive site such as
uunet.uu.net, or by allowing the Copyright Holder to
include your modifications in the Standard Version of the
Package.</LI>
<LI>use the modified Package only within your corporation or
organization.</LI>
<LI>rename any non-standard executables so the names do not
conflict with standard executables, which must also be
provided, and provide a separate manual page for each
non-standard executable that clearly documents how it
differs from the Standard Version. d. make other
distribution arrangements with the Copyright Holder.</LI>
</OL>
</LI>
</OL>
<P>You may distribute the programs of this Package in object code
or executable form, provided that you do at least ONE of the
following:</P>
<OL STYLE="list-style-type: lower-alpha;">
<LI>distribute a Standard Version of the executables and library
files, together with instructions (in the manual page or
equivalent) on where to get the Standard Version.</LI>
<LI>accompany the distribution with the machine-readable source
of the Package with your modifications.</LI>
<LI>give non-standard executables non-standard names, and
clearly document the differences in manual pages (or
equivalent), together with instructions on where to get the
Standard Version.</LI>
<LI>make other distribution arrangements with the Copyright
Holder.</LI>
</OL>
<P>You may charge a reasonable copying fee for any distribution of
this Package. You may charge any fee you choose for support of
this Package. You may not charge a fee for this Package
itself. However, you may distribute this Package in aggregate
with other (possibly commercial) programs as part of a larger
(possibly commercial) software distribution provided that you do
not advertise this Package as a product of your own. You may
embed this Package's interpreter within an executable of yours
(by linking); this shall be construed as a mere form of
aggregation, provided that the complete Standard Version of the
interpreter is so embedded.</P>
<P>The scripts and library files supplied as input to or produced
as output from the programs of this Package do not automatically
fall under the copyright of this Package, but belong to whomever
generated them, and may be sold commercially, and may be
aggregated with this Package. If such scripts or library files
are aggregated with this Package via the so-called "undump" or
"unexec" methods of producing a binary executable image, then
distribution of such an image shall neither be construed as a
distribution of this Package nor shall it fall under the
restrictions of Paragraphs 3 and 4, provided that you do not
represent such an executable image as a Standard Version of this
Package.</P>
<P>C subroutines (or comparably compiled subroutines in other
languages) supplied by you and linked into this Package in order
to emulate subroutines and variables of the language defined by
this Package shall not be considered part of this Package, but
are the equivalent of input as in Paragraph 6, provided these
subroutines do not change the language in any way that would
cause it to fail the regression tests for the language.</P>
<P>Aggregation of this Package with a commercial distribution is
always permitted provided that the use of this Package is
embedded; that is, when no overt attempt is made to make this
Package's interfaces visible to the end user of the commercial
distribution. Such use shall not be construed as a distribution
of this Package.</P>
<P>The name of the Copyright Holder may not be used to endorse or
promote products derived from this software without specific
prior written permission.</P>
<P>THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR
PURPOSE.</P>
<DIV STYLE="text-align: center;">The End</DIV>
</BODY>
</HTML>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html40/strict.dtd">
<HTML LANG="en-US">
<HEAD>