Templates for pythonbindings docs
authorEmilio Mancini <emilio.mancini@inria.fr>
Wed, 12 Feb 2014 15:18:20 +0100
changeset 567 77b382e17c52
parent 566 234d33ce2692
child 568 f6566512945c
Templates for pythonbindings docs
doc/source/dce-dev-doc.rst
doc/source/dce-dev-python.rst
doc/source/dce-user-basic.rst
doc/source/dce-user-python.rst
--- a/doc/source/dce-dev-doc.rst	Tue Feb 11 17:05:33 2014 +0100
+++ b/doc/source/dce-dev-doc.rst	Wed Feb 12 15:18:20 2014 +0100
@@ -16,4 +16,5 @@
 
    dce-kernel
    dce-poll
+   dce-dev-python
 ..   dce-readme
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/source/dce-dev-python.rst	Wed Feb 12 15:18:20 2014 +0100
@@ -0,0 +1,10 @@
+.. include:: replace.txt
+
+Python Bindings
+***************
+
+  --disable-python      Don't build Python bindings.
+  --genbind             Rescan the API for Python bindings. Needs working GCCXML / pygccxml environment.
+  --with-pybindgen=WITH_PYBINDGEN
+                        Path to an existing pybindgen source tree to use.
+  --with-python=WITH_PYTHON
--- a/doc/source/dce-user-basic.rst	Tue Feb 11 17:05:33 2014 +0100
+++ b/doc/source/dce-user-basic.rst	Wed Feb 12 15:18:20 2014 +0100
@@ -7,6 +7,7 @@
    :maxdepth: 2
 
    dce-user-newapps
+   dce-user-python
    dce-user-kernel
    dce-user-syscalls
    dce-user-submodule
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/source/dce-user-python.rst	Wed Feb 12 15:18:20 2014 +0100
@@ -0,0 +1,19 @@
+.. include:: replace.txt
+
+Write Python Scripts
+********************
+
+Currently DCE includes an experimental support to the `Python <http://www.python.org/>`_ language. 
+To enable it, you may need to recompile it with the flags:
+
+::
+
+  --with-pybindgen=HERE_THE_PYBINDGEN_PATH
+
+indicating the path to an existing `Pybindgen <http://packages.python.org/PyBindGen>`_ source tree to use. 
+Or in case waf didn't find the interpreter, you can try to use the flags:
+
+::
+
+  --with-python=HERE_THE_PYTHON_PATH
+