Adding ./doc from boost

Reviewer: Lauro Moura <lauro.neto@openbossa.org>
          Luciano Wolf <luciano.wolf@openbossa.org>

1 files changed, 56 insertions, 0 deletions

diff --git a/doc/generatingdocs.rst b/doc/generatingdocs.rst
new file mode 100644
index 000000000..7d33cb817
--- /dev/null
+++ b/doc/generatingdocs.rst
@@ -0,0 +1,56 @@
+How to generate this documentation
+**********************************
+
+Pre-requisites
+--------------
+
+You will need:
+
+1. Qt4 source code (for API documentation).
+2. boostpythongenerator
+3. PySide source code
+4. cmake
+5. sphinx
+
+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 boostpythongenerator
+to create the documentation.
+
+So, go to Qt4 source directory and type:
+
+::
+
+    $ cp /path/to/pyside/sources/doc/pyside.qdocconf tools/qdoc3/test/pyside.qdocconf
+    $ QTDIR=`pwd` qdoc3 tools/qdoc3/test/pyside.qdocconf
+    $ export QT_SRC_DIR=`pwd` # the next step uses this variable.
+
+The xml files now can be found at ``$QT_SRC_DIR/qt4xmldoc``.
+
+Last step
+---------
+
+You need to tell PySide where it can find the generated XML files and the Qt4
+source directory (XML files refers to it in some tags). So, go to the PySide
+directory and type:
+
+::
+
+    $ mkdir build
+    $ cmake -DCMAKE_INSTALL_PREFIX=/usr -DDOC_DATA_DIR=$QT_SRC_DIR/qt4xmldoc -DQT_SRC_DIR=$QT_SRC_DIR ..
+    $ make apidoc
+    $ make apidocinstall
+
+Where:
+    * *PATH_TO_QT_SOURCE_DIR* is the path to the Qt4 sources.
+    * *PATH_TO_XMLS* is the path to the xml's generated by qdoc3 tool.
+
+The documentation will be installed at ``/usr/share/doc/pyside/index.html``, change
+the *CMAKE_INSTALL_PREFIX* value if you want to install the documentation in another
+directory.
+