python: post installer docs fix script
authorBen McGinnes <ben@adversary.org>
Sun, 27 Jan 2019 03:57:53 +0000 (14:57 +1100)
committerBen McGinnes <ben@adversary.org>
Sun, 27 Jan 2019 03:57:53 +0000 (14:57 +1100)
* 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 <ben@adversary.org>
Signed-off-by: Ben McGinnes <ben@adversary.org>
lang/python/doc/rst/gpgme-python-howto.rst
lang/python/doc/rst/index.rst
lang/python/doc/src/gpgme-python-howto
lang/python/doc/texinfo/gpgme-python-howto.texi
lang/python/doc/texinfo/index.texi
lang/python/doc/texinfo/maintenance-mode.texi
lang/python/doc/texinfo/short-history.texi
lang/python/doc/texinfo/what-is-new.texi
lang/python/doc/texinfo/what-was-new.texi
lang/python/examples/howto/post_installer.py [moved from lang/python/post_installer.py with 100% similarity]

index 4146e37..5f8bcd5 100644 (file)
@@ -683,6 +683,21 @@ on the system and version of Python in use. Another option is to run the
 command ``python3 -m virtualenv /path/to/install/virtual/thingy``
 instead.
 
+.. _snafu-docs:
+
+Post installation
+~~~~~~~~~~~~~~~~~
+
+Following installation it is recommended to move the
+``post_installer.py`` script from the ``lang/python/examples/howto/``
+directory to the ``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\").
+
 .. _howto-fund-a-mental:
 
 Fundamentals
index 9c4f0f7..3ff34fc 100644 (file)
@@ -7,7 +7,7 @@ GPGME Python Bindings
 =====================
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
    :caption: Contents:
 
 Contents
@@ -20,11 +20,3 @@ Contents
 
 -  `What Was New <what-was-new>`__
 -  `GPGME Python Bindings HOWTO <gpgme-python-howto>`__
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
index 6569806..c63191b 100644 (file)
@@ -705,6 +705,22 @@ the command =python3 -m virtualenv /path/to/install/virtual/thingy=
 instead.
 
 
+*** Post installation
+    :PROPERTIES:
+    :CUSTOM_ID: snafu-docs
+    :END:
+
+Following installation it is recommended to move the
+=post_installer.py= script from the =lang/python/examples/howto/=
+directory to the =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").
+
+
 * Fundamentals
   :PROPERTIES:
   :CUSTOM_ID: howto-fund-a-mental
index fac0056..9f53aa5 100644 (file)
@@ -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
index 0f4863c..95c27c2 100644 (file)
@@ -57,4 +57,4 @@ GPGME Python Bindings
 @uref{gpgme-python-howto, GPGME Python Bindings HOWTO}
 @end itemize
 
-@bye
+@bye
\ No newline at end of file
index d38875b..9245719 100644 (file)
@@ -166,4 +166,4 @@ already be done when converting Org to reStructuredText or Org to
 Texinfo.  As a certain amount of work would be required to get it
 done, there would need to be clear demand for that work to be done.
 
-@bye
+@bye
\ No newline at end of file
index cbb13f3..d27f68d 100644 (file)
@@ -221,4 +221,4 @@ For those using Python 2, there is essentially no harm in using
 this module, but it may lack a number of more recent features
 added to GPGME.
 
-@bye
+@bye
\ No newline at end of file
index 5abc87a..406ab2f 100644 (file)
@@ -91,4 +91,4 @@ repetition if a key includes a user ID matching the hexadecimal
 value of a key ID.
 @end itemize
 
-@bye
+@bye
\ No newline at end of file
index 29ea847..3f0ad9d 100644 (file)
@@ -157,4 +157,4 @@ the time).
 Cleaned up a lot of things under the hood.
 @end itemize
 
-@bye
+@bye
\ No newline at end of file