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 <ben@adversary.org>
Signed-off-by: Ben McGinnes <ben@adversary.org>
This commit is contained in:
Ben McGinnes 2019-01-27 14:57:53 +11:00
parent ed81892917
commit 1e26572365
10 changed files with 53 additions and 15 deletions

View 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`` command ``python3 -m virtualenv /path/to/install/virtual/thingy``
instead. 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: .. _howto-fund-a-mental:
Fundamentals Fundamentals

View File

@ -7,7 +7,7 @@ GPGME Python Bindings
===================== =====================
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 3
:caption: Contents: :caption: Contents:
Contents Contents
@ -20,11 +20,3 @@ Contents
- `What Was New <what-was-new>`__ - `What Was New <what-was-new>`__
- `GPGME Python Bindings HOWTO <gpgme-python-howto>`__ - `GPGME Python Bindings HOWTO <gpgme-python-howto>`__
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

View File

@ -705,6 +705,22 @@ the command =python3 -m virtualenv /path/to/install/virtual/thingy=
instead. 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 * Fundamentals
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: howto-fund-a-mental :CUSTOM_ID: howto-fund-a-mental

View File

@ -81,6 +81,7 @@ Known Issues
* Won't Work With Windows:: * Won't Work With Windows::
* CFFI is the Best™ and GPGME should use it instead of SWIG:: * CFFI is the Best™ and GPGME should use it instead of SWIG::
* Virtualised Environments:: * Virtualised Environments::
* Post installation::
Fundamentals Fundamentals
@ -511,6 +512,7 @@ they be encountered.
* Won't Work With Windows:: * Won't Work With Windows::
* CFFI is the Best™ and GPGME should use it instead of SWIG:: * CFFI is the Best™ and GPGME should use it instead of SWIG::
* Virtualised Environments:: * Virtualised Environments::
* Post installation::
@end menu @end menu
@node Breaking Builds @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} the command @samp{python3 -m virtualenv /path/to/install/virtual/thingy}
instead. 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 @node Fundamentals
@chapter 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 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. PURPOSE.
@bye @bye

View File

@ -57,4 +57,4 @@ GPGME Python Bindings
@uref{gpgme-python-howto, GPGME Python Bindings HOWTO} @uref{gpgme-python-howto, GPGME Python Bindings HOWTO}
@end itemize @end itemize
@bye @bye

View 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 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. done, there would need to be clear demand for that work to be done.
@bye @bye

View 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 this module, but it may lack a number of more recent features
added to GPGME. added to GPGME.
@bye @bye

View File

@ -91,4 +91,4 @@ repetition if a key includes a user ID matching the hexadecimal
value of a key ID. value of a key ID.
@end itemize @end itemize
@bye @bye

View File

@ -157,4 +157,4 @@ the time).
Cleaned up a lot of things under the hood. Cleaned up a lot of things under the hood.
@end itemize @end itemize
@bye @bye