summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
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