diff options
Diffstat (limited to '')
-rw-r--r-- | lang/python/doc/texinfo/gpgme-python-howto.texi | 16 | ||||
-rw-r--r-- | lang/python/doc/texinfo/maintenance-mode.texi | 44 |
2 files changed, 57 insertions, 3 deletions
diff --git a/lang/python/doc/texinfo/gpgme-python-howto.texi b/lang/python/doc/texinfo/gpgme-python-howto.texi index bfc42f3c..420ea7df 100644 --- a/lang/python/doc/texinfo/gpgme-python-howto.texi +++ b/lang/python/doc/texinfo/gpgme-python-howto.texi @@ -2255,6 +2255,10 @@ content as a byte object, the recipient key IDs and algorithms in @samp{result} and the results of verifying any signatures of the data in @samp{verify_result}. +If @samp{gpg.Context().decrypt(cfile, verify=False)} is called instead, +then @samp{verify_result} will be returned as @samp{None} and the rest remains +as described here. + @node Signing text and files @section Signing text and files @@ -3301,11 +3305,11 @@ from the author at any of the following URLs: @item @uref{https://files.au.adversary.org/crypto/gpgme-python-howto.html, GPGME Python Bindings HOWTO draft (XHTML single file, AWS S3 SSL)} @item -@uref{http://files.au.adversary.org/crypto/gpgme-python-howto.html, GPGME Python Bindings HOWTO draft (XHTML single file, AWS S3 no SS)} +@uref{http://files.au.adversary.org/crypto/gpgme-python-howto.html, GPGME Python Bindings HOWTO draft (XHTML single file, AWS S3 no SSL)} @item @uref{https://files.au.adversary.org/crypto/gpgme-python-howto-split/index.html, GPGME Python Bindings HOWTO draft (XHTML multiple files, AWS S3 SSL)} @item -@uref{http://files.au.adversary.org/crypto/gpgme-python-howto-split/index.html, GPGME Python Bindings HOWTO draft (XHTML multiple files, AWS S3 no SSL)} +@uref{http://files.au.adversary.org/crypto/gpgme-python-howto/index.html, GPGME Python Bindings HOWTO draft (XHTML multiple files, AWS S3 no SSL)} @end itemize All of these draft versions except for one have been generated from @@ -3335,10 +3339,16 @@ pandoc -f org -t rst+smart -o gpgme-python-howto.rst gpgme-python-howto @end example In addition to these there is a significantly less frequently updated -version as a HTML @uref{https://files.au.adversary.org/crypto/gpgme-python-howto/webhelp/index.html, WebHelp site} (AWS S3 SSL); generated from DITA XML +version as a HTML @uref{https://files.au.adversary.org/crypto/gpgme-python/dita/webhelp/index.html, WebHelp site} (AWS S3 SSL); generated from DITA XML source files, which can be found in @uref{https://dev.gnupg.org/source/gpgme/browse/ben%252Fhowto-dita/, an alternative branch} of the GPGME git repository. +Various generated output formats may occasionally be found in +subdirectories of the @uref{https://s3.amazonaws.com/files.au.adversary.org/crypto/gpgme-python, gpgme-python} directory. In particular within +the @uref{https://s3.amazonaws.com/files.au.adversary.org/crypto/gpgme-python/dita, DITA}, @uref{https://s3.amazonaws.com/files.au.adversary.org/crypto/gpgme-python/rst, reStructuredText} and @uref{https://s3.amazonaws.com/files.au.adversary.org/crypto/gpgme-python/texinfo, Texinfo} subdirectories. The @samp{rst} +directory contains output files generated with Sphix and may include a +considerable number of its possible output formats. + These draft editions are not official documents and the version of documentation in the master branch or which ships with released versions is the only official documentation. Nevertheless, these diff --git a/lang/python/doc/texinfo/maintenance-mode.texi b/lang/python/doc/texinfo/maintenance-mode.texi index cf47f6f3..9377bbb2 100644 --- a/lang/python/doc/texinfo/maintenance-mode.texi +++ b/lang/python/doc/texinfo/maintenance-mode.texi @@ -29,6 +29,11 @@ Maintenance Mode from 2019 * Maintainer from 2019 onward:: * Using the Python Bindings from 2019 and beyond:: +* Documentation formats:: + +Documentation formats + +* Cautionary Notes regarding Sphinx and EPUB:: @end detailmenu @end menu @@ -66,6 +71,7 @@ the bindings. @menu * Maintainer from 2019 onward:: * Using the Python Bindings from 2019 and beyond:: +* Documentation formats:: @end menu @node Maintainer from 2019 onward @@ -122,4 +128,42 @@ Those with a commercial interest in expediting such a feature request already know how to @uref{https://gnupg.org/cgi-bin/procdonate.cgi?mode=preset, expedite it} (use the message field to state what feature is being requested). +@node Documentation formats +@section Documentation formats + +The documentation has been written in Org mode for GNU Emacs, with +both Texinfo and reStructuredText formats generated from that. The +Texinfo files are intended for use with the rest of the GnuPG +documentation; while the reStructuredText files are intended for use +with Docutils and Sphinx, as with other Python projects. + +@menu +* Cautionary Notes regarding Sphinx and EPUB:: +@end menu + +@node Cautionary Notes regarding Sphinx and EPUB +@subsection Cautionary Notes regarding Sphinx and EPUB + +Though Python's Docutils in conjunction with Sphinx is capable of +generating some very useful HTML sites, as proven by @uref{https://readthedocs.org/, Read the Docs} and +the @uref{https://docs.python.org/, Python documentation}, there are a number of output formats it does +not handle well. At the top of the list of things it manages to break +so atrociously as to be embarassing is the @uref{http://idpf.org/epub, EPUB 3} format. + +The automatically generated EPUB of the CPython documentation always +contains hundreds of validation errors and even the modest amount of +documentation here @uref{https://files.au.adversary.org.s3.amazonaws.com/crypto/gpgme-python/rst/epub/GPGMEPythonBindings.epub, produced a file} with approximately thirty +validation errors. As the volume of documentation content increases, +so does the induced errors. Whereas Texinfo doesn't produce EPUB +output at all, nor does Org-mode. + +Should there ever be genuine demand for this format, lodge a @uref{https://dev.gnupg.org/maniphest/task/edit/form/4/, feature +request} case marked for @uref{https://dev.gnupg.org/p/BenM/, my} attention. The means of generating such +files flawlessly is already available, but is not yet part of the +GnuPG build system. Nor is it integrated with a means of converting +Org mode input files to the relevant base format automatically, as can +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
\ No newline at end of file |