diff options
Diffstat (limited to 'doc')
-rw-r--r-- | doc/HACKING.txt | 74 | ||||
-rw-r--r-- | doc/dbus.bus.rst | 1 | ||||
-rw-r--r-- | doc/dbus.connection.rst | 1 | ||||
-rw-r--r-- | doc/dbus.decorators.rst | 1 | ||||
-rw-r--r-- | doc/dbus.exceptions.rst | 1 | ||||
-rw-r--r-- | doc/dbus.gi_service.rst | 1 | ||||
-rw-r--r-- | doc/dbus.glib.rst | 1 | ||||
-rw-r--r-- | doc/dbus.lowlevel.rst | 1 | ||||
-rw-r--r-- | doc/dbus.mainloop.rst | 2 | ||||
-rw-r--r-- | doc/dbus.proxies.rst | 1 | ||||
-rw-r--r-- | doc/dbus.server.rst | 1 | ||||
-rw-r--r-- | doc/dbus.service.rst | 1 | ||||
-rw-r--r-- | doc/dbus.types.rst | 1 | ||||
-rw-r--r-- | doc/index.rst | 8 | ||||
-rw-r--r-- | doc/redirects | 6 | ||||
-rw-r--r-- | doc/redirects.py | 2 |
16 files changed, 26 insertions, 77 deletions
diff --git a/doc/HACKING.txt b/doc/HACKING.txt deleted file mode 100644 index b53655c..0000000 --- a/doc/HACKING.txt +++ /dev/null @@ -1,74 +0,0 @@ -=============== -Developer notes -=============== - -:Author: Simon McVittie, `Collabora`_ -:Date: 2007-01-24 - -.. _Collabora: http://www.collabora.co.uk/ - -Upstream development -==================== - -dbus-python is developed at freedesktop.org using ``git``. -See UsingGit_ for some details. - -.. _UsingGit: http://www.freedesktop.org/wiki/UsingGit - -Anonymous access - ``git clone git://anongit.freedesktop.org/git/dbus/dbus-python`` -Committer access (requires freedesktop.org shell account) - ``git clone git+ssh://git.freedesktop.org/git/dbus/dbus-python`` - -dbus-gmain is maintained via `git subtree`. To update, assuming you have -a checkout of the dbus-gmain branch of the dbus-glib repository in -../dbus-gmain:: - - git subtree pull -P dbus-gmain ../dbus-gmain HEAD - -Modules -======= - -``dbus``, ``dbus.service`` and ``dbus.mainloop`` are core public API. - -``dbus.lowlevel`` provides a lower-level public API for advanced use. - -``dbus.mainloop.glib`` is the public API for the GLib main loop integration. - -``dbus.types`` and ``dbus.exceptions`` are mainly for backwards -compatibility - use ``dbus`` instead in new code. Ditto ``dbus.glib``. - -``dbus._dbus``, ``dbus.introspect_parser``, ``dbus.proxies`` are internal -implementation details. - -``_dbus_bindings`` is the real implementation of the Python/libdbus -integration, while ``_dbus_bindings`` is the real implementation of -Python/libdbus-glib integration. Neither is public API, although some -of the classes and functions are exposed as public API in other modules. - -Threading/locking model -======================= - -All Python functions must be called with the GIL (obviously). - -Before calling into any D-Bus function that can block, release the GIL; -as well as the usual "be nice to other threads", D-Bus does its own -locking and we don't want to deadlock with it. Most Connection methods -can block. - -Other notes -=========== - -Code needs to be Python 2.5 compatible - use Py_ssize_t where appropriate. -See http://www.python.org/dev/peps/pep-0353/ for details. - -Indentation and other holy wars -=============================== - -Python code is meant to follow PEP8, and has 4-space indentation, no hard tabs. - -C code is meant to follow what PEP7 refers to as "Python 3000" style - 4-space -indentation, no hard tabs, otherwise consistent with historical Python 2.x -code. - -Docstrings etc. are reStructuredText. diff --git a/doc/dbus.bus.rst b/doc/dbus.bus.rst index 1f78f3e..957f66a 100644 --- a/doc/dbus.bus.rst +++ b/doc/dbus.bus.rst @@ -3,5 +3,6 @@ dbus.bus module .. automodule:: dbus.bus :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.connection.rst b/doc/dbus.connection.rst index 7b78212..97798c3 100644 --- a/doc/dbus.connection.rst +++ b/doc/dbus.connection.rst @@ -3,5 +3,6 @@ dbus.connection module .. automodule:: dbus.connection :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.decorators.rst b/doc/dbus.decorators.rst index 3f6625c..6e10c64 100644 --- a/doc/dbus.decorators.rst +++ b/doc/dbus.decorators.rst @@ -3,5 +3,6 @@ dbus.decorators module .. automodule:: dbus.decorators :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.exceptions.rst b/doc/dbus.exceptions.rst index fea743c..a609fdd 100644 --- a/doc/dbus.exceptions.rst +++ b/doc/dbus.exceptions.rst @@ -3,5 +3,6 @@ dbus.exceptions module .. automodule:: dbus.exceptions :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.gi_service.rst b/doc/dbus.gi_service.rst index 945d5a0..68eb11e 100644 --- a/doc/dbus.gi_service.rst +++ b/doc/dbus.gi_service.rst @@ -3,5 +3,6 @@ dbus.gi\_service module .. automodule:: dbus.gi_service :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.glib.rst b/doc/dbus.glib.rst index 20958be..2fac689 100644 --- a/doc/dbus.glib.rst +++ b/doc/dbus.glib.rst @@ -3,5 +3,6 @@ dbus.glib module .. automodule:: dbus.glib :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.lowlevel.rst b/doc/dbus.lowlevel.rst index 74e5f47..f8060db 100644 --- a/doc/dbus.lowlevel.rst +++ b/doc/dbus.lowlevel.rst @@ -3,5 +3,6 @@ dbus.lowlevel module .. automodule:: dbus.lowlevel :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.mainloop.rst b/doc/dbus.mainloop.rst index 14bbf14..6c3805c 100644 --- a/doc/dbus.mainloop.rst +++ b/doc/dbus.mainloop.rst @@ -6,6 +6,7 @@ Module contents .. automodule:: dbus.mainloop :members: + :inherited-members: :undoc-members: :show-inheritance: @@ -14,5 +15,6 @@ dbus.mainloop.glib module .. automodule:: dbus.mainloop.glib :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.proxies.rst b/doc/dbus.proxies.rst index 8e4e8e3..73df177 100644 --- a/doc/dbus.proxies.rst +++ b/doc/dbus.proxies.rst @@ -3,5 +3,6 @@ dbus.proxies module .. automodule:: dbus.proxies :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.server.rst b/doc/dbus.server.rst index c0d94c6..ddcaaf8 100644 --- a/doc/dbus.server.rst +++ b/doc/dbus.server.rst @@ -3,5 +3,6 @@ dbus.server module .. automodule:: dbus.server :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.service.rst b/doc/dbus.service.rst index 61958d6..ac4c223 100644 --- a/doc/dbus.service.rst +++ b/doc/dbus.service.rst @@ -3,5 +3,6 @@ dbus.service module .. automodule:: dbus.service :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/dbus.types.rst b/doc/dbus.types.rst index c02c788..58c1d5c 100644 --- a/doc/dbus.types.rst +++ b/doc/dbus.types.rst @@ -3,5 +3,6 @@ dbus.types module .. automodule:: dbus.types :members: + :inherited-members: :undoc-members: :show-inheritance: diff --git a/doc/index.rst b/doc/index.rst index ca754b5..19f6b66 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -42,9 +42,15 @@ Documentation dbus PY3PORT news - HACKING API_CHANGES +Contributing to dbus-python +=========================== + +Please see `the Gitlab project`_. + +.. _the Gitlab project: https://gitlab.freedesktop.org/dbus/dbus-python/blob/master/CONTRIBUTING.md + Indices and tables ================== diff --git a/doc/redirects b/doc/redirects index 659373d..d343ea9 100644 --- a/doc/redirects +++ b/doc/redirects @@ -1,7 +1,7 @@ doc/API_CHANGES.html ../API_CHANGES.html doc/API_CHANGES.txt "See ../API_CHANGES.html" -doc/HACKING.html ../HACKING.html -doc/HACKING.txt "See ../HACKING.html" +doc/HACKING.html https://gitlab.freedesktop.org/dbus/dbus-python/blob/master/CONTRIBUTING.md +doc/HACKING.txt "See https://gitlab.freedesktop.org/dbus/dbus-python/blob/master/CONTRIBUTING.md" doc/PY3PORT.html ../PY3PORT.html doc/PY3PORT.txt "See ../PY3PORT.html" doc/tutorial.html ../tutorial.html @@ -136,3 +136,5 @@ api/toc-dbus.types-module.html ../dbus.types.html api/toc-dbus._version-module.html ../dbus.html api/toc-everything.html ../dbus.html api/toc.html ../dbus.html +HACKING.html https://gitlab.freedesktop.org/dbus/dbus-python/blob/master/CONTRIBUTING.md +HACKING.txt "See https://gitlab.freedesktop.org/dbus/dbus-python/blob/master/CONTRIBUTING.md" diff --git a/doc/redirects.py b/doc/redirects.py index 5cee516..7104103 100644 --- a/doc/redirects.py +++ b/doc/redirects.py @@ -1,5 +1,7 @@ #!/usr/bin/python +# SPDX-License-Identifier: MIT + import os SRCDIR = os.environ.get('DBUS_TOP_SRCDIR', '.') |