From a2e7c863c821ca035f1e3f8077bdae3b0f81f5eb Mon Sep 17 00:00:00 2001 From: Ben McGinnes Date: Wed, 2 Jan 2019 11:06:14 +1100 Subject: [PATCH] python: post installer doc fix script * Got rid of the bash bit in the comments. * Made the final printed instructions far more obvious. Signed-off-by: Ben McGinnes --- lang/python/post_installer.py | 29 +++++++++-------------------- 1 file changed, 9 insertions(+), 20 deletions(-) diff --git a/lang/python/post_installer.py b/lang/python/post_installer.py index f711589d..b9fd36f2 100755 --- a/lang/python/post_installer.py +++ b/lang/python/post_installer.py @@ -122,11 +122,6 @@ help: @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) """) -print(""" -You may now generate your preferred documentation format with either Sphinx -or Texinfo. -""") - info_path = os.path.realpath(sysconfig._PREFIX + "/share/info") info_paths = os.environ["INFOPATH"].split(":") @@ -141,18 +136,12 @@ for ipath in info_paths: else: pass -# This will very likely require root or sudo access, so running this script -# with the same access as used to install the bindings in the first place is -# highly recommended. -# -# bash variant (run in lang/python/doc/texinfo/): -# -# for x in *.texi: -# makeinfo -v --no-split $x -# done ; -# -# Or to generate HTML: -# -# for x in *.texi: -# makeinfo -v --no-split --html $x -# done ; +print(""" +You may now build your preferred documentation format using either: + + 1. Sphinx in the doc/rst/ directory; and/or + 2. Texinfo or Makeinfo in the doc/texinfo/ directory. + +Alternatively the original Org mode source files can be found in the doc/src/ +directory. +""")