aboutsummaryrefslogtreecommitdiffstats
path: root/doc/generatingdocs.rst
diff options
context:
space:
mode:
authorLuciano Wolf <luciano.wolf@openbossa.org>2010-10-08 18:13:17 -0300
committerLuciano Wolf <luciano.wolf@openbossa.org>2010-10-11 10:35:38 -0300
commit87c67294301eb53c67e949ff50b991afe24d80c0 (patch)
tree8e1399074ed417be4e3bb42007951ce27f3f6471 /doc/generatingdocs.rst
parentba54f0956e50c9a667ce160c69592d08ce514382 (diff)
Updating documentation to reflect adoption of wikipages.
Reviewer: Renato Ara├║jo <renato.filho@openbossa.org>
Diffstat (limited to 'doc/generatingdocs.rst')
-rw-r--r--doc/generatingdocs.rst42
1 files changed, 0 insertions, 42 deletions
diff --git a/doc/generatingdocs.rst b/doc/generatingdocs.rst
deleted file mode 100644
index 666df8146..000000000
--- a/doc/generatingdocs.rst
+++ /dev/null
@@ -1,42 +0,0 @@
-How to generate this documentation
-**********************************
-
-Pre-requisites
---------------
-
-You will need:
-
-1. Qt4 source code (for API documentation).
-2. Generator runner with shiboken plugin
-3. PySide source code
-4. cmake
-5. sphinx
-6. graphviz
-
-Extracting documentation from Qt4
----------------------------------
-
-The API documentation is generated from source code comments (for now, just
-``qdoc3`` tool is supported, ``doxygen`` support will be added soon).
-
-``qdoc3`` is the tool used to generate the oficial Qt4 documentation, you will
-use it to generate a bunch of XML files that will be used by the generator
-to create the documentation.
-
-You need to tell PySide where it can find the Qt source code, to do this, when running cmake add the following parameters:
-
-::
-
- $ mkdir build
- $ cmake -DQT_SRC_DIR=PATH_TO_QT_SOURCE_DIR ..
- $ make apidoc
- $ make apidocinstall
-
-Where:
- * *PATH_TO_QT_SOURCE_DIR* is the path to the Qt sources.
-
-The documentation will be installed at ``<INSTALL_PREFIX>/share/doc/pyside/index.html``, change
-the *CMAKE_INSTALL_PREFIX* value if you want to install the documentation in another
-directory.
-
-If you want to have inheritance graphs on the generated documentation, make sure you have the bindings installed before generate the documentation.