diff options
Diffstat (limited to 'lang/python/docs/src/gpgme-python-howto.org')
| -rw-r--r-- | lang/python/docs/src/gpgme-python-howto.org | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/lang/python/docs/src/gpgme-python-howto.org b/lang/python/docs/src/gpgme-python-howto.org index c7a1f823..6eba29e0 100644 --- a/lang/python/docs/src/gpgme-python-howto.org +++ b/lang/python/docs/src/gpgme-python-howto.org @@ -131,7 +131,16 @@ The bullet points of new additiions are: - Semi-formalised the location where [[#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 - the file at around the same time. + this file at around the same time. +- The Texinfo documentation build configuration has been replicated + from the parent project in order to make to maintain consistency + with that project (and actually ship with each release). +- a reStructuredText (=.rst=) version is also generated for Python + developers more used to and comfortable with that format as it is + the standard Python documentation format and Python developers may + 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 [[http://cython.org/][Cython]]. @@ -804,7 +813,7 @@ print(""" """.format(secnum, pubnum)) #+END_SRC -*NOTE:* The [[#cython][Cython]] introduction in the [[#advanced-use][Advanced and Experimental]] +NOTE: The [[#cython][Cython]] introduction in the [[#advanced-use][Advanced and Experimental]] section uses this same key counting code with Cython to demonstrate some areas where Cython can improve performance even with the bindings. Users with large public keyrings or keyboxes, for instance, @@ -911,7 +920,7 @@ else: pass #+END_SRC -*NOTE:* When searching for a key ID of any length or a fingerprint +NOTE: When searching for a key ID of any length or a fingerprint (without spaces), the SKS servers require the the leading =0x= indicative of hexadecimal be included. Also note that the old short key IDs (e.g. =0xDEADBEEF=) should no longer be used due to the @@ -2958,13 +2967,23 @@ from the author at any of the following URLs: - [[http://files.au.adversary.org/crypto/gpgme-python-howto.texi][GPGME Python Bindings HOWTO draft (Texinfo file AWS S3 no SSL)]] - [[https://files.au.adversary.org/crypto/gpgme-python-howto.info][GPGME Python Bindings HOWTO draft (Info file AWS S3 SSL)]] - [[http://files.au.adversary.org/crypto/gpgme-python-howto.info][GPGME Python Bindings HOWTO draft (Info file AWS S3 no SSL)]] +- [[https://files.au.adversary.org/crypto/gpgme-python-howto.rst][GPGME Python Bindings HOWTO draft (reST file AWS S3 SSL)]] +- [[http://files.au.adversary.org/crypto/gpgme-python-howto.rst][GPGME Python Bindings HOWTO draft (reST file AWS S3 no SSL)]] - [[https://files.au.adversary.org/crypto/gpgme-python-howto.xml][GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 SSL)]] - [[http://files.au.adversary.org/crypto/gpgme-python-howto.xml][GPGME Python Bindings HOWTO draft (Docbook 4.2 AWS S3 no SSL)]] -All of these draft versions are generated from this document via Emacs -[[https://orgmode.org/][Org mode]] and [[https://www.gnu.org/software/texinfo/][GNU Texinfo]]. Though it is likely that the specific [[https://files.au.adversary.org/crypto/gpgme-python-howto.org][file]] -[[http://files.au.adversary.org/crypto/gpgme-python-howto.org][version]] used will be on the same server with the generated output -formats. +All of these draft versions except for one have been generated from +this document via Emacs [[https://orgmode.org/][Org mode]] and [[https://www.gnu.org/software/texinfo/][GNU Texinfo]]. Though it is likely +that the specific [[https://files.au.adversary.org/crypto/gpgme-python-howto.org][file]] [[http://files.au.adversary.org/crypto/gpgme-python-howto.org][version]] used will be on the same server with +the generated output formats. + +The one exception is the reStructuredText version, which was converted +using the latest version of Pandoc from the Org mode source file using +the following command: + +#+BEGIN_SRC shell + pandoc -f org -t rst+smart -o gpgme-python-howto.rst gpgme-python-howto.org +#+END_SRC In addition to these there is a significantly less frequently updated version as a HTML [[https://files.au.adversary.org/crypto/gpgme-python-howto/webhelp/index.html][WebHelp site]] (AWS S3 SSL); generated from DITA XML @@ -2997,7 +3016,7 @@ PURPOSE. * Footnotes -[fn:1] =Short_History.org= and/or =Short_History.html=. +[fn:1] =short-history.org= and/or =short-history.html=. [fn:2] The =lang/python/docs/= directory in the GPGME source. |