From 1e265723653042bc1010b457537b69a2011b43b7 Mon Sep 17 00:00:00 2001 From: Ben McGinnes Date: Sun, 27 Jan 2019 14:57:53 +1100 Subject: python: post installer docs fix script * Moved post_installer.py into the examples/howto/ directory. * Added instructions for its use to the Python Bindings HOWTO. * Ran it as intended from the lang/python/ directory in order to both prove it works and quickly and easily get the updated howto replicated. Also to fix all those .texi files. Tested-by: Ben McGinnes Signed-off-by: Ben McGinnes --- lang/python/doc/texinfo/gpgme-python-howto.texi | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) (limited to 'lang/python/doc/texinfo/gpgme-python-howto.texi') diff --git a/lang/python/doc/texinfo/gpgme-python-howto.texi b/lang/python/doc/texinfo/gpgme-python-howto.texi index fac0056f..9f53aa5a 100644 --- a/lang/python/doc/texinfo/gpgme-python-howto.texi +++ b/lang/python/doc/texinfo/gpgme-python-howto.texi @@ -81,6 +81,7 @@ Known Issues * Won't Work With Windows:: * CFFI is the Best™ and GPGME should use it instead of SWIG:: * Virtualised Environments:: +* Post installation:: Fundamentals @@ -511,6 +512,7 @@ they be encountered. * Won't Work With Windows:: * CFFI is the Best™ and GPGME should use it instead of SWIG:: * Virtualised Environments:: +* Post installation:: @end menu @node Breaking Builds @@ -883,6 +885,19 @@ on the system and version of Python in use. Another option is to run the command @samp{python3 -m virtualenv /path/to/install/virtual/thingy} instead. +@node Post installation +@subsection Post installation + +Following installation it is recommended to move the +@samp{post_installer.py} script from the @samp{lang/python/examples/howto/} +directory to the @samp{lang/python/} directory and run it. This will fix +or restore files needed by Sphinx which may be removed during a +distribution build for release. It will also generate reST files from +Org mode files with Pandoc and generate Texinfo files from Org mode +files with GNU Emacs and Org mode (in batch mode). Additionally it +will fix the UTF-8 declaration line in the Texinfo files (Emacs +expects "UTF-8" to be "utf-8"). + @node Fundamentals @chapter Fundamentals @@ -3465,4 +3480,4 @@ WITHOUT ANY WARRANTY, to the extent permitted by law; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. -@bye +@bye \ No newline at end of file -- cgit v1.2.3