summaryrefslogtreecommitdiff
path: root/pyuno
diff options
context:
space:
mode:
authorHossein <hossein.ir@gmail.com>2021-03-29 21:55:26 +0430
committerAdolfo Jayme Barrientos <fitojb@ubuntu.com>2021-04-07 17:47:16 +0200
commitea5641baeef73af60d025d185901a303844e2d85 (patch)
tree94b343b35e7b8805beb9a1745fe1de2f382574fb /pyuno
parent33da78c21f4243a3e469fb7df79ed1745df70078 (diff)
Updated README.md files to represent current code / use Markdown format
Previously, all of the README files have been renamed to README.md and now, the contents of these files were changed to use Markdown format. Other than format inconsistency, some README.md files lacked information about modules, or were out of date. By using LibreOffice / OpenOffice wiki and other documentation websites, these files were updated. Now every README.md file has a title, and some description. The top-level README.md file is changed to add links to the modules. The result of processing the Markdown format README.md files can be seen at: https://docs.libreoffice.org/ Change-Id: Ic3b0c3c064a2498d6a435253b041df010cd7797a Reviewed-on: https://gerrit.libreoffice.org/c/core/+/113424 Tested-by: Jenkins Reviewed-by: Michael Stahl <michael.stahl@allotropia.de> Reviewed-by: Adolfo Jayme Barrientos <fitojb@ubuntu.com>
Diffstat (limited to 'pyuno')
-rw-r--r--pyuno/README.md25
1 files changed, 14 insertions, 11 deletions
diff --git a/pyuno/README.md b/pyuno/README.md
index 4d88391229f1..95e487706788 100644
--- a/pyuno/README.md
+++ b/pyuno/README.md
@@ -1,19 +1,22 @@
+# Python UNO Bindings
+
UNO bindings for the Python programming language.
-To have much joy debugging python extensions you need to:
- a) edit pythonloader.py in your install setting DEBUG=1 at the top
- b) touch pyuno/source/module/pyuno_runtime.cxx and 'make debug=true' in pyuno
+To have much joy debugging Python extensions you need to:
+
++ a) edit `pythonloader.py` in your install setting `DEBUG=1` at the top
++ b) `touch pyuno/source/module/pyuno_runtime.cxx` and `make debug=true` in `pyuno`
Then you'll start to see your exceptions on the console instead of them getting
lost at the UNO interface.
Python also comes with a gdb script
-libpython$(PYTHON_VERSION_MAJOR).$(PYTHON_VERSION_MINOR)m.so.1.0-gdb.py
-that is copied to instdir and will be auto-loaded by gdb;
-it provides commands like "py-bt" to get a python-level backtrace,
-and "py-print" to print python variables.
+`libpython$(PYTHON_VERSION_MAJOR).$(PYTHON_VERSION_MINOR)m.so.1.0-gdb.py`
+that is copied to `instdir` and will be auto-loaded by `gdb`;
+it provides commands like `py-bt` to get a Python-level backtrace,
+and `py-print` to print Python variables.
-Another way to debug Python code is to use pdb: edit some initialization
-function to insert "import pdb; pdb.set_trace()" (somewhere so that it is
-executed early), then run soffice from a terminal and a command-line python
-debugger will appear where you can set python-level breakpoints.
+Another way to debug Python code is to use `pdb`: edit some initialization
+function to insert `import pdb; pdb.set_trace()` (somewhere so that it is
+executed early), then run `soffice` from a terminal and a command-line Python
+debugger will appear where you can set Python-level breakpoints.