diff options
| author | Ben McGinnes <[email protected]> | 2018-11-06 05:22:50 +0000 | 
|---|---|---|
| committer | Ben McGinnes <[email protected]> | 2018-11-06 05:22:50 +0000 | 
| commit | d0a5caf73c2d6b73dd043f62574c31946e4f347d (patch) | |
| tree | 5b84b8694b5bffb212a38c6473387d5ab5ce0225 /lang/python/doc/src | |
| parent | python examples: another importer (diff) | |
| download | gpgme-d0a5caf73c2d6b73dd043f62574c31946e4f347d.tar.gz gpgme-d0a5caf73c2d6b73dd043f62574c31946e4f347d.zip | |
docs: python bindings
* Continued restructuring as part of moving beyond mere;y the HOWTO
  file.
* Generated the alternative source files for reST and Texinfo.
* Fixed some errors and updated links after moving the what's new
  section to two new files (yes, two).
Diffstat (limited to 'lang/python/doc/src')
| -rw-r--r-- | lang/python/doc/src/index | 6 | ||||
| -rw-r--r-- | lang/python/doc/src/short-history | 2 | ||||
| -rw-r--r-- | lang/python/doc/src/what-was-new | 18 | 
3 files changed, 14 insertions, 12 deletions
| diff --git a/lang/python/doc/src/index b/lang/python/doc/src/index index 18c9386b..ce347ea7 100644 --- a/lang/python/doc/src/index +++ b/lang/python/doc/src/index @@ -12,15 +12,17 @@  * GPGME Python Bindings    :PROPERTIES: -  :CUSTOM_ID: index +  :CUSTOM_ID: top    :END:  ** Contents     :PROPERTIES: -   :CUSTOM_ID: index-contents +   :CUSTOM_ID: contents     :END:  - [[file:short-history][A short history of the project]] +- [[file:what-is-new][What's New]] +- [[file:what-was-new][What Was New]]  - [[file:gpgme-python-howto][GPGME Python Bindings HOWTO]] diff --git a/lang/python/doc/src/short-history b/lang/python/doc/src/short-history index ac5804df..6c5c96ec 100644 --- a/lang/python/doc/src/short-history +++ b/lang/python/doc/src/short-history @@ -166,7 +166,7 @@ SWIG itself, which are worth noting here.  * Footnotes -[fn:1] In all likelihood thos would have been Python 2.2 or possibly +[fn:1] In all likelihood this would have been Python 2.2 or possibly  Python 2.3.  [fn:2] The entire PyME git log and other preceding VCS logs are diff --git a/lang/python/doc/src/what-was-new b/lang/python/doc/src/what-was-new index 666e5ccf..7c851b1e 100644 --- a/lang/python/doc/src/what-was-new +++ b/lang/python/doc/src/what-was-new @@ -48,7 +48,7 @@ and 1.11.1 in April, 2018.  The bullet points of new additiions are: -- an expanded section on [[#installation][installing]] and [[#snafu][troubleshooting]] the Python +- an expanded section on [[file:gpgme-python-howto#installation][installing]] and [[file:gpgme-python-howto#snafu][troubleshooting]] the Python    bindings.  - The release of Python 3.7.0; which appears to be working just fine    with our bindings, in spite of intermittent reports of problems for @@ -56,12 +56,12 @@ The bullet points of new additiions are:  - Python 3.7 has been moved to the head of the specified python    versions list in the build process.  - In order to fix some other issues, there are certain underlying -  functions which are more exposed through the [[#howto-get-context][gpg.Context()]], but +  functions which are more exposed through the [[file:gpgme-python-howto#howto-get-context][gpg.Context()]], but    ongoing documentation ought to clarify that or otherwise provide the    best means of using the bindings.  Some additions to =gpg.core= and    the =Context()=, however, were intended (see below).  - Continuing work in identifying and confirming the cause of -  oft-reported [[#snafu-runtime-not-funtime][problems installing the Python bindings on Windows]]. +  oft-reported [[file:gpgme-python-howto#snafu-runtime-not-funtime][problems installing the Python bindings on Windows]].  - GSOC: Google's Surreptitiously Ordered Conscription ... erm ... oh,    right; Google's Summer of Code.  Though there were two hopeful    candidates this year; only one ended up involved with the GnuPG @@ -71,11 +71,11 @@ The bullet points of new additiions are:    participant Jacob Adams, who added the key_import function; building    on prior work by Tobias Mueller.  - Several new methods functions were added to the gpg.Context(), -  including: [[#howto-import-key][key_import]], [[#howto-export-key][key_export]], [[#howto-export-public-key][key_export_minimal]] and -  [[#howto-export-secret-key][key_export_secret]]. +  including: [[file:gpgme-python-howto#howto-import-key][key_import]], [[file:gpgme-python-howto#howto-export-key][key_export]], [[file:gpgme-python-howto#howto-export-public-key][key_export_minimal]] and +  [[file:gpgme-python-howto#howto-export-secret-key][key_export_secret]].  - Importing and exporting examples include versions integrated with    Marcel Fest's recently released [[https://github.com/Selfnet/hkp4py][HKP for Python]] module.  Some -  [[#hkp4py][additional notes on this module]] are included at the end of the HOWTO. +  [[file:gpgme-python-howto#hkp4py][additional notes on this module]] are included at the end of the HOWTO.  - Instructions for dealing with semi-walled garden implementations    like ProtonMail are also included.  This is intended to make things    a little easier when communicating with users of ProtonMail's @@ -83,7 +83,7 @@ The bullet points of new additiions are:    service.  The GnuPG Project neither favours, nor disfavours    ProtonMail and the majority of this deals with interacting with the    ProtonMail keyserver. -- Semi-formalised the location where [[#draft-editions][draft versions]] of this HOWTO may +- Semi-formalised the location where [[file:gpgme-python-howto#draft-editions][draft versions]] of this HOWTO may    periodically be accessible.  This is both for the reference of    others and testing the publishing of the document itself.  Renamed    this file at around the same time. @@ -96,8 +96,8 @@ The bullet points of new additiions are:    wish to use it with Sphinx.  Please note that there has been no    testing of the reStructuredText version with Sphinx at all.  The    reST file was generated by the simple expedient of using [[https://pandoc.org/][Pandoc]]. -- Added a new section for [[#advanced-use][advanced or experimental use]]. -- Began the advanced use cases with [[#cython][a section]] on using the module with +- Added a new section for [[file:gpgme-python-howto#advanced-use][advanced or experimental use]]. +- Began the advanced use cases with [[file:gpgme-python-howto#cython][a section]] on using the module with    [[https://cython.org/][Cython]].  - Added a number of new scripts to the =example/howto/= directory;    some of which may be in advance of their planned sections of the | 
