python/docs: use the same links on top as in man pages

[elogind.git] / src / python-systemd / docs / journal.rst

diff --git a/src/python-systemd/docs/journal.rst b/src/python-systemd/docs/journal.rst
index 89728a2ecb54500d9fb812489a947493e99f509e..9dc495ffdb685ff5b331f822598b82e2a6183366 100644 (file)
--- a/src/python-systemd/docs/journal.rst
+++ b/src/python-systemd/docs/journal.rst
@@ -13,12 +13,48 @@
 Accessing the Journal
 ---------------------
 
-.. autoclass:: _Journal
+.. autoclass:: _Reader
    :undoc-members:
    :inherited-members:
 
-.. autoclass:: Journal
+.. autoclass:: Reader
    :undoc-members:
    :inherited-members:
 
    .. automethod:: __init__
+
+.. autoclass:: Monotonic
+
+.. autoattribute:: systemd.journal.DEFAULT_CONVERTERS
+
+Example: polling for journal events
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This example shows that journal events can be waited for (using
+e.g. `poll`). This makes it easy to integrate Reader in an external
+event loop:
+
+  >>> import select
+  >>> from systemd import journal
+  >>> j = journal.Reader()
+  >>> j.seek_tail()
+  >>> p = select.poll()
+  >>> p.register(j, select.POLLIN)
+  >>> p.poll()
+  [(3, 1)]
+  >>> j.get_next()
+
+
+Journal access types
+~~~~~~~~~~~~~~~~~~~~
+
+.. autoattribute:: systemd.journal.LOCAL_ONLY
+.. autoattribute:: systemd.journal.RUNTIME_ONLY
+.. autoattribute:: systemd.journal.SYSTEM_ONLY
+
+Journal event types
+~~~~~~~~~~~~~~~~~~~
+
+.. autoattribute:: systemd.journal.NOP
+.. autoattribute:: systemd.journal.APPEND
+.. autoattribute:: systemd.journal.INVALIDATE