summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-09 15:37:35 -0500
committerZbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>2013-02-22 16:57:43 +0100
commit9015fa646e04fc3cb180bea24c33d34edbb48ed7 (patch)
tree11d994d2046f2cb6043add66bc58d57603497836 /README
parentd489071fb348cd180bc4f70e732b0e76d9804448 (diff)
python: build html docs using sphinx
Build instructions: make make DESTIDIR=/tmp/... install make DESTIDIR=/tmp/... sphinx-html sphinx-man sphinx-epub ...
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