summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-28 19:53:42 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-28 20:05:12 -0500
commit37d3ab1b7e114f0fb6dfb2e7273569b42794b76a (patch)
treeb69f73466e4719b6f02d4b30fcaa42ec43f1c40d /README
parent54c31a79f72ff57ac8eba089acacc4ab482b745d (diff)
parent7f41820b07ccb8a6da5552c466818fcce3d085bf (diff)
Merge branch 'python-systemd-reader'
* python-systemd-reader: python-systemd: rename Journal to Reader build-sys: upload python documentation to freedesktop.org systemd-python: add Journal class for reading journal python: build html docs using sphinx journalct: also print Python code in --new-id python: utilize uuid.UUID in logging python: add systemd.id128 module ... and 34 other commits In short: python module systemd.id128 is added, and existing systemd.journal gains a new class systemd.journal.Reader, which can be used to iterate over journal entries. Documentation is provided, and accessible under e.g. pydoc3 systemd.journal.Reader or firefox http://www.freedesktop.org/software/systemd/man/python-systemd/
Diffstat (limited to 'README')
-rw-r--r--README7
1 files changed, 7 insertions, 0 deletions
diff --git a/README b/README
index 297d8f79e7..1aa044be75 100644
--- a/README
+++ b/README
@@ -81,6 +81,7 @@ REQUIREMENTS:
gperf
gtkdocize (optional)
python (optional)
+ sphinx (optional)
When systemd-hostnamed is used it is strongly recommended to
install nss-myhostname to ensure that in a world of
@@ -93,6 +94,12 @@ REQUIREMENTS:
please build D-Bus without systemd first, then build systemd,
then rebuild D-Bus with systemd support.
+ To build HTML documentation for python-systemd using sphinx,
+ please first install systemd (using 'make install'), and then
+ invoke sphinx-build with 'make sphinx-<target>', with <target>
+ being 'html' or 'latexpdf'. If using DESTDIR for installation,
+ pass the same DESTDIR to 'make sphinx-html' invocation.
+
WARNINGS:
systemd will warn you during boot if /etc/mtab is not a
symlink to /proc/mounts. Please ensure that /etc/mtab is a