docs: python
authorBen McGinnes <ben@adversary.org>
Thu, 4 Oct 2018 16:30:20 +0000 (02:30 +1000)
committerBen McGinnes <ben@adversary.org>
Thu, 4 Oct 2018 16:30:20 +0000 (02:30 +1000)
* Fixed an error in the new index page and then exported to the other
  two "source" formats.

lang/python/doc/rst/gpgme-python-howto.rst
lang/python/doc/rst/index.rst [new file with mode: 0644]
lang/python/doc/src/gpgme-python-howto.org
lang/python/doc/src/index.org
lang/python/doc/texinfo/gpgme-python-howto.texi
lang/python/doc/texinfo/index.texi [new file with mode: 0644]
lang/python/doc/texinfo/short-history.texi

index f29727e..9181491 100644 (file)
@@ -248,8 +248,8 @@ The PyME package maintained by Martin Albrecht
 
 This package is the origin of these bindings, though they are somewhat
 different now. For details of when and how the PyME package was folded
-back into GPGME itself see the *Short History* document [1]_ in the
-Python bindings ``docs`` directory. [2]_
+back into GPGME itself see the `Short History <short-history.org>`__
+document. [1]_
 
 The PyME package was first released in 2002 and was also the first
 attempt to implement a low level binding to GPGME. In doing so it
@@ -354,7 +354,7 @@ For Python 2 it checks for these executables in this order: ``python``,
 ``python2`` and ``python2.7``.
 
 For Python 3 it checks for these executables in this order: ``python3``,
-``python3.7``, ``python3.6``, ``python3.5`` and ``python3.4``. [3]_
+``python3.7``, ``python3.6``, ``python3.5`` and ``python3.4``. [2]_
 
 On systems where ``python`` is actually ``python3`` and not ``python2``
 it may be possible that ``python2`` may be overlooked, but there have
@@ -411,7 +411,7 @@ directory missing a lot of expected files. Even when this occurs, the
 solution is actually quite simple and will always work.
 
 That solution is simply to run the following commands as either the
-**root** user or prepended with ``sudo -H``\  [4]_ in the
+**root** user or prepended with ``sudo -H``\  [3]_ in the
 ``lang/python/`` directory:
 
 .. code:: shell
@@ -1880,7 +1880,7 @@ Encrypting to multiple keys essentially just expands upon the key
 selection process and the recipients from the previous examples.
 
 The following example encrypts a message (``text``) to everyone with an
-email address on the ``gnupg.org`` domain, [5]_ but does *not* encrypt
+email address on the ``gnupg.org`` domain, [4]_ but does *not* encrypt
 to a default key or other key which is configured to normally encrypt
 to.
 
@@ -2838,7 +2838,7 @@ module instead. It has since been modified to provide support for Python
 
 Since it rewrites the ``hkp`` protocol prefix as ``http`` and ``hkps``
 as ``https``, the module is able to be used even with servers which do
-not support the full scope of keyserver functions. [6]_ It also works
+not support the full scope of keyserver functions. [5]_ It also works
 quite readily when incorporated into a `Cython <#cython>`__ generated
 and compiled version of any code.
 
@@ -2968,9 +2968,6 @@ Footnotes
    ``short-history.org`` and/or ``short-history.html``.
 
 .. [2]
-   The ``lang/python/docs/`` directory in the GPGME source.
-
-.. [3]
    With no issues reported specific to Python 3.7, the release of Python
    3.7.1 at around the same time as GPGME 1.12.0 and the testing with
    Python 3.7.1rc1, there is no reason to delay moving 3.7 ahead of 3.6
@@ -2978,7 +2975,7 @@ Footnotes
    always enforce their own policies anyway and installation to each
    supported minor release is quite possible too.
 
-.. [4]
+.. [3]
    Yes, even if you use virtualenv with everything you do in Python. If
    you want to install this module as just your user account then you
    will need to manually configure, compile and install the *entire*
@@ -2987,13 +2984,13 @@ Footnotes
    circumstances under which it is worthwhile, but generally only on
    POSIX systems which utilise single user mode (some even require it).
 
-.. [5]
+.. [4]
    You probably don\'t really want to do this. Searching the keyservers
    for \"gnupg.org\" produces over 400 results, the majority of which
    aren\'t actually at the gnupg.org domain, but just included a comment
    regarding the project in their key somewhere.
 
-.. [6]
+.. [5]
    Such as with ProtonMail servers. This also means that restricted
    servers which only advertise either HTTP or HTTPS end points and not
    HKP or HKPS end points must still be identified as as HKP or HKPS
diff --git a/lang/python/doc/rst/index.rst b/lang/python/doc/rst/index.rst
new file mode 100644 (file)
index 0000000..31dc146
--- /dev/null
@@ -0,0 +1,12 @@
+.. _index:
+
+GPGME Python Bindings
+=====================
+
+.. _index-contents:
+
+Contents
+--------
+
+-  `A short history of the project <short-history.org>`__
+-  `GPGME Python Bindings HOWTO <gpgme-python-howto.org>`__
index 6eba29e..caa8e2f 100644 (file)
@@ -7,7 +7,6 @@
 #+LATEX_HEADER: \usepackage[margin=1in]{geometry}
 #+LATEX_HEADER: \setmainfont[Ligatures={Common}]{Times New Roman}
 #+LATEX_HEADER: \author{Ben McGinnes <ben@gnupg.org>}
-#+HTML_HEAD_EXTRA: <link type="application/rss+xml" href="https://git.gnupg.org/cgi-bin/gitweb.cgi?p=gpgme.git;a=rss;f=lang/python/docs/GPGMEpythonHOWTOen.org"/>
 
 
 * Introduction
@@ -254,8 +253,7 @@ version 3.0 (or any later version).
 
 This package is the origin of these bindings, though they are somewhat
 different now.  For details of when and how the PyME package was
-folded back into GPGME itself see the /Short History/ document[fn:1]
-in the Python bindings =docs= directory.[fn:2]
+folded back into GPGME itself see the [[file:short-history.org][Short History]] document.[fn:1]
 
 The PyME package was first released in 2002 and was also the first
 attempt to implement a low level binding to GPGME.  In doing so it
@@ -365,7 +363,7 @@ For Python 2 it checks for these executables in this order: =python=,
 =python2= and =python2.7=.
 
 For Python 3 it checks for these executables in this order: =python3=,
- =python3.7=, =python3.6=, =python3.5= and =python3.4=.[fn:3]
+ =python3.7=, =python3.6=, =python3.5= and =python3.4=.[fn:2]
 
 On systems where =python= is actually =python3= and not =python2= it
 may be possible that =python2= may be overlooked, but there have been
@@ -425,7 +423,7 @@ build directory missing a lot of expected files.  Even when this
 occurs, the solution is actually quite simple and will always work.
 
 That solution is simply to run the following commands as either the
-*root* user or prepended with =sudo -H=[fn:4] in the =lang/python/=
+*root* user or prepended with =sudo -H=[fn:3] in the =lang/python/=
 directory:
 
 #+BEGIN_SRC shell
@@ -1928,7 +1926,7 @@ Encrypting to multiple keys essentially just expands upon the key
 selection process and the recipients from the previous examples.
 
 The following example encrypts a message (=text=) to everyone with an
-email address on the =gnupg.org= domain,[fn:5] but does /not/ encrypt
+email address on the =gnupg.org= domain,[fn:4] but does /not/ encrypt
 to a default key or other key which is configured to normally encrypt
 to.
 
@@ -2899,7 +2897,7 @@ support for Python 2.7 as well and is available via PyPI.
 
 Since it rewrites the =hkp= protocol prefix as =http= and =hkps= as
 =https=, the module is able to be used even with servers which do not
-support the full scope of keyserver functions.[fn:6]  It also works quite
+support the full scope of keyserver functions.[fn:5]  It also works quite
 readily when incorporated into a [[#cython][Cython]] generated and compiled version
 of any code.
 
@@ -3018,16 +3016,14 @@ PURPOSE.
 
 [fn:1] =short-history.org= and/or =short-history.html=.
 
-[fn:2] The =lang/python/docs/= directory in the GPGME source.
-
-[fn:3] With no issues reported specific to Python 3.7, the release of
+[fn:2] With no issues reported specific to Python 3.7, the release of
 Python 3.7.1 at around the same time as GPGME 1.12.0 and the testing
 with Python 3.7.1rc1, there is no reason to delay moving 3.7 ahead of
 3.6 now.  Production environments with more conservative requirements
 will always enforce their own policies anyway and installation to each
 supported minor release is quite possible too.
 
-[fn:4] Yes, even if you use virtualenv with everything you do in
+[fn:3] Yes, even if you use virtualenv with everything you do in
 Python.  If you want to install this module as just your user account
 then you will need to manually configure, compile and install the
 /entire/ GnuPG stack as that user as well.  This includes libraries
@@ -3035,12 +3031,12 @@ which are not often installed that way.  It can be done and there are
 circumstances under which it is worthwhile, but generally only on
 POSIX systems which utilise single user mode (some even require it).
 
-[fn:5] You probably don't really want to do this.  Searching the
+[fn:4] You probably don't really want to do this.  Searching the
 keyservers for "gnupg.org" produces over 400 results, the majority of
 which aren't actually at the gnupg.org domain, but just included a
 comment regarding the project in their key somewhere.
 
-[fn:6] Such as with ProtonMail servers.  This also means that
+[fn:5] Such as with ProtonMail servers.  This also means that
 restricted servers which only advertise either HTTP or HTTPS end
 points and not HKP or HKPS end points must still be identified as as
 HKP or HKPS within the Python Code.  The =hkp4py= module will rewrite
index 8410c40..701d986 100644 (file)
@@ -21,6 +21,5 @@
    :END:
 
 
-- [[short-history][A short history of the project]]
-- [[gpgme-python-howto][GPGME Python Bindings HOWTO]]
-
+- [[file:short-history.org][A short history of the project]]
+- [[file:gpgme-python-howto.org][GPGME Python Bindings HOWTO]]
index b474242..40beb7a 100644 (file)
@@ -418,8 +418,7 @@ version 3.0 (or any later version).
 
 This package is the origin of these bindings, though they are somewhat
 different now.  For details of when and how the PyME package was
-folded back into GPGME itself see the @emph{Short History} document@footnote{@samp{short-history.org} and/or @samp{short-history.html}.}
-in the Python bindings @samp{docs} directory.@footnote{The @samp{lang/python/docs/} directory in the GPGME source.}
+folded back into GPGME itself see the @uref{short-history.org, Short History} document.@footnote{@samp{short-history.org} and/or @samp{short-history.html}.}
 
 The PyME package was first released in 2002 and was also the first
 attempt to implement a low level binding to GPGME.  In doing so it
diff --git a/lang/python/doc/texinfo/index.texi b/lang/python/doc/texinfo/index.texi
new file mode 100644 (file)
index 0000000..4f80423
--- /dev/null
@@ -0,0 +1,52 @@
+\input texinfo    @c -*- texinfo -*-
+@c %**start of header
+@setfilename index.info
+@settitle GNU Privacy Guard (GnuPG) Made Easy Python Bindings
+@documentencoding UTF-8
+@documentlanguage en
+@c %**end of header
+
+@finalout
+@titlepage
+@title GNU Privacy Guard (GnuPG) Made Easy Python Bindings
+@author Ben McGinnes
+@end titlepage
+
+@contents
+
+@ifnottex
+@node Top
+@top GNU Privacy Guard (GnuPG) Made Easy Python Bindings
+@end ifnottex
+
+@menu
+* GPGME Python Bindings::
+
+@detailmenu
+--- The Detailed Node Listing ---
+
+GPGME Python Bindings
+
+* Contents::
+
+@end detailmenu
+@end menu
+
+@node GPGME Python Bindings
+@chapter GPGME Python Bindings
+
+@menu
+* Contents::
+@end menu
+
+@node Contents
+@section Contents
+
+@itemize
+@item
+@uref{short-history.org, A short history of the project}
+@item
+@uref{gpgme-python-howto.org, GPGME Python Bindings HOWTO}
+@end itemize
+
+@bye
\ No newline at end of file
index 2854d91..fd136b5 100644 (file)
@@ -40,8 +40,8 @@ Relics of the past
 
 The Perils of PyPI
 
-* GPG 1.8.0 - Python bindings for GPGME GnuPG cryptography library: GPG 180 - Python bindings for GPGME GnuPG cryptography library.
-* PyME 0.9.0 - Python support for GPGME GnuPG cryptography library: PyME 090 - Python support for GPGME GnuPG cryptography library.
+* GPG 1.8.0 - Python bindings for GPGME GnuPG cryptography library: GPG 180 - Python bindings for GPGME GnuPG cryptography library. 
+* PyME 0.9.0 - Python support for GPGME GnuPG cryptography library: PyME 090 - Python support for GPGME GnuPG cryptography library. 
 
 @end detailmenu
 @end menu
@@ -172,8 +172,8 @@ pyme (0.9.0) - Python support for GPGME GnuPG cryptography library
 @end enumerate
 
 @menu
-* GPG 1.8.0 - Python bindings for GPGME GnuPG cryptography library: GPG 180 - Python bindings for GPGME GnuPG cryptography library.
-* PyME 0.9.0 - Python support for GPGME GnuPG cryptography library: PyME 090 - Python support for GPGME GnuPG cryptography library.
+* GPG 1.8.0 - Python bindings for GPGME GnuPG cryptography library: GPG 180 - Python bindings for GPGME GnuPG cryptography library. 
+* PyME 0.9.0 - Python support for GPGME GnuPG cryptography library: PyME 090 - Python support for GPGME GnuPG cryptography library. 
 @end menu
 
 @node GPG 180 - Python bindings for GPGME GnuPG cryptography library
@@ -206,4 +206,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