IntenseFinance/gnucash
3
0
Fork 0
mirror of https://github.com/Gnucash/gnucash.git synced 2025-02-25 18:55:30 -06:00
Code Issues Packages Projects Releases Wiki Activity

Merge Christoph Holtermann's 'PR-python-bindings-update-source-doc' into maint

Browse Source
This commit is contained in:
John Ralls 2019-04-20 12:55:41 -07:00
commit fc0a729253
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
libgnucash/doc/python-bindings-doxygen.py
View File

@ -27,14 +27,14 @@
## @page python_bindings_page Python bindings
# Also have a look at group @ref python_bindings.
#
# They can be found in src/optional/python-bindings.
# In the source tree they are located at bindings/python.
#
# To enable them in the compilation process you have to add --enable-python-bindings
# to the call of ./configure.
# To enable them in the compilation process you have to add -DWITH_PYTHON=ON
# to the call of cmake.
#
# As a starting point have a look at the \link python_bindings_examples example-scripts\endlink.
#
# @section possibilities What are the Python bindings good for ?
# @section possibilities What can Python Bindings be used for ?
#
# The python bindings supply the ability to access a wide range of the core functions of GnuCash. You
# can read and write Transactions, Commodities, Lots, access the business stuff... You gain the ability
@ -43,6 +43,9 @@
# Not everything GnuCash can is possible to access though. The bindings focus on basic accounting functions.
# Have a look at the examples to get an impression.
#
# Some functions are broken because they have not been wrapped properly. They may crash the program or return unaccessible values.
# Please file a bug report if you find one to help support the development process.
#
# @section python_bindings_section Principles
# The python-bindings are generated using SWIG from parts of the source-files of GnuCash.
#
@ -128,5 +131,5 @@
# @li There is a page in the GnuCash wiki at http://wiki.gnucash.org/wiki/Python
# @li You may also have a look into the archives of gnucash-devel@gnucash.org.
# @li On Bugzilla there is also some interesting talk regarding the development process.
# @li Then you can use the abilities of svn to see the history of the code by @code svn log @endcode done in the directory of the python-bindings.
# @li Then you can use the abilities of git to see the history of the code by @code git log @endcode done in the directory of the python-bindings.
#