aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/doc (follow)
Commit message (Collapse)AuthorAgeFilesLines
* python: fix minor typo in howtoBernhard Reiter2020-03-031-1/+1
|
* python: Also detect python 3.9.Werner Koch2020-02-141-2/+2
| | | | | | -- Signed-off-by: Werner Koch <[email protected]>
* python: Fix how to generate documentation.NIIBE Yutaka2019-11-061-46/+35
| | | | | | | | * lang/python/doc/Makefile.am: Explicitly write rules to generate rst and texinfo files. Fixes-commit: 36428d8cf153a33faac6a951752cdc76e23f9737 Signed-off-by: NIIBE Yutaka <[email protected]>
* python: doc: Remove generated files, put rules in Makefile.NIIBE Yutaka2019-07-1213-8017/+39
| | | | | | | | | | | * lang/python/doc/Makefile.am (EXTRA_DIST): Remove files not distributed like files under meta. * Add rules to generate .rst and .texi files. * lang/python/doc/rst: Remove .rst files to be generated. * lang/python/doc/texinfo: Remove .texi files to be generated. GnuPG-bug-id: 4275 Signed-off-by: NIIBE Yutaka <[email protected]>
* python: doc: Add suffix for org files.NIIBE Yutaka2019-07-126-0/+0
| | | | Signed-off-by: NIIBE Yutaka <[email protected]>
* python: Make EXTRA_DIST files explicitAndre Heinecke2019-05-061-0/+48
| | | | | | | | | | | | | | | * configure.ac: Configure new Makefiles. * lang/python/Makefile.am: Remove dirs from extra dist and use subdirs. * lang/python/examples/Makefile.am, lang/python/src/Makefile.am, lang/python/doc/Makefile.am: New. Files that list EXTRA_DIST files. -- This is similar to what lang/js does by explicitly listing the files. This ensures that we have clean distribution tarballs without accidentall additions that just lay in the directory. GnuPG-Bug-Id: T4481
* Release GPGME 1.13.0gpgme-1.13.0Werner Koch2019-03-261-1/+1
| | | | | | | | | * configure.ac: Bump LT versions. For C to C33/A22/R0. For C++ to C15/A9/R0. For Qt to C10/A3/R3. Signed-off-by: Werner Koch <[email protected]>
* python: docsBen McGinnes2019-01-303-6/+6
| | | | | | | * Version bump in preparation for whenever GPGME 1.13.0 happens. * Ran the post_installer.py for docs preparation again. Signed-off-by: Ben McGinnes <[email protected]>
* python: post installer docs fix scriptBen McGinnes2019-01-279-15/+53
| | | | | | | | | | | * 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 <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: docs processingBen McGinnes2018-12-241-6/+17
| | | | | | | | | | | | | | | * Added some EPUB specific config options to the Sphinx config file which might help reduce some of Sphinx's more stupid default errors with EPUB validation. * Added lang/python/post_installer.py script for automating the generation of .texi and .rst "source" files from the real source files written in Org mode. Includes recreating the Sphinx Makefile which is excluded due to the m4 toolchain in parent directories, it also handles the rewriting of the reST index file properly and rewrites the .texi files so they don't impale themselves on Unicode. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: docsBen McGinnes2018-12-218-51/+193
| | | | | | | | | | | | | * Found a bug in org-mode's export to texinfo function which will require either manual modification of each file or a customs sed run over the generated files for all updates. * Manually updated the current files for now, but will need to add some post-install processing scripts for future use (I already have some of these for my specific setup, they just need to be made a little more generic and platform independent for here). Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: groups exampleBen McGinnes2018-12-211-5/+5
| | | | | | * Tightened code a little more. Signed-off-by: Ben McGinnes <[email protected]>
* python docs: house keepingBen McGinnes2018-12-171-14/+27
| | | | | | | * Dropped the ASCII copyright line, since even MS have conceded their battle against Unicode enough to load UTF-8. * Fixed the drafts section since there will be less need of multiple output format testing from next year.
* python: howto and examplesBen McGinnes2018-12-163-45/+51
| | | | | | | * Tightening up both the documentation and some of the example code. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: what's new summaryBen McGinnes2018-12-123-0/+29
| | | | * Added a little more detail to the what's new section.
* python: HKP search and import updatesBen McGinnes2018-12-103-36/+165
| | | | | | | * Tweaked the code again so that it can also handle the cases where someone has included a hexadecimal string in their user ID. * Updated the HOWTO to match. * Exported to .rst and .texi.
* python: docs updatesBen McGinnes2018-12-106-9/+172
| | | | | | | | | * Multiple updates, expanding on the Windows installation issues. * Also adding to the new maintenance mode reference document. * Includes content relating to the resolution of T4271 and T4191. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: windows c and cythonBen McGinnes2018-12-043-0/+22
| | | | | | * added warning that he Windows C runtime issues will also affect use with Cython and that relying on binary installers would remove that possible use case.
* python: sphinx modificationBen McGinnes2018-12-041-35/+0
| | | | | | | | | | | | * The make.bat file incorrectly triggers the trailing whitespace check in the git repo (it doesn't actually have any trailing whitespace, but triggers the error on every line). * Will need to add a script to handle future org-mode conversions of the index page anyway, so will get that script to deal with this problem too by generating the make.bat file if the platform is detected as Windows. Signed-off-by: Ben McGinnes <[email protected]>
* python: Sphinx supportBen McGinnes2018-12-046-1/+227
| | | | | | | | | | * Added framework from sphinx-quickstart to lang/python/doc/rst/ so that Python developers already using Sphinx can use the generated reST files with existing documentation systems. * Note that when generating source files from Org-mode, the index page will require manual intervention to match the Sphinx requirements. Signed-off-by: Ben McGinnes <[email protected]>
* python: docs updateBen McGinnes2018-12-0415-144/+358
| | | | | | | | | | | | | * Expanded the section on issues with Windows installations, with greater detail of which versions of Visual Studio are needed depending on which version of CPython is to be used. * Included a recommendation which is a bit harsh without being totally prickish. * Updated all files to not link to author's key or related data in order to make them all consistent with the changes in commit 649b19688132dd315e361c0f5b63ba6d8f45996d. Signed-off-by: Ben McGinnes <[email protected]>
* python: documentation fixesBen McGinnes2018-11-304-3/+9
| | | | | | | * Typographic and whitespace error correction pertaining to the previous update. Signed-off-by: Ben McGinnes <[email protected]>
* python: documentationBen McGinnes2018-11-3018-81/+477
| | | | | | | | | | | * Added long description to setup.py.in. * Added maintenance mode details with clarification for what type of things would be a bug as far as MM is concerned and what wouldn't be. ** Includes a not too subtle hint directed towards the donations page. * Miscellaneous tightening of documentation. Signed-off-by: Ben McGinnes <[email protected]>
* python docs: checking key signaturesBen McGinnes2018-11-263-25/+260
| | | | | | | | | | * Added instructions for checking key certifications or key signatures (depending on preferred terminology). * Added pendulum module to recommended installations, but not to requirements. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: docs updateBen McGinnes2018-11-226-24/+287
| | | | | | * Added documentation for the new methods added to gpgme.version. * Removed the Flask based advanced use case from the what-is-new section as that type of code will not be added here.
* python: import constantBen McGinnes2018-11-191-6/+4
| | | | | | | * lang/python/src/constants/__init__.py: dropped use of Import capitalisation and renamed lang/python/src/constants/import.py to lang/python/src/constants/import_type.py to address bug T4242. * lang/python/doc/src/gpgme-python-howto: minor docs updates.
* spelling: fix misspellingsDaniel Kahn Gillmor2018-11-084-18/+18
| | | | Signed-off-by: Daniel Kahn Gillmor <[email protected]>
* docs: python bindingsBen McGinnes2018-11-0614-215/+504
| | | | | | | | * 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).
* docs: typoBen McGinnes2018-11-031-1/+1
| | | | * lang/python/doc/src/gpgme-python-howto: s/Revokinging/Revoking/g
* docs: python docs restructureBen McGinnes2018-10-304-71/+168
| | | | | * Moved the what's new section out of the HOWTO (mostly), in anticipation of expanding the docs to be more than merely a HOWTO.
* docs: pythonBen McGinnes2018-10-303-1/+14
| | | | | * dropped the ".org" extension and added a mode line for each file as this will make scripting format conversions a lot easier.
* docs: python howtoBen McGinnes2018-10-231-5/+5
| | | | * Fixed a few spelling and grammatical errors.
* Python: docs tweaksBen McGinnes2018-10-211-1/+1
| | | | | | | * Fixed a minor error in how the reST version of the HOWTO is generated. * Updated the help() in __init__.py with a little more detail as to why not to use the lower level functions.
* doc: convert more http:// links to https://Daniel Kahn Gillmor2018-10-183-7/+7
| | | | | | -- Signed-off-by: Daniel Kahn Gillmor <[email protected]>
* docs: whitespace bugBen McGinnes2018-10-042-15/+15
| | | | * Same as before, but exported.
* docs: org to texinfo whitspace bugBen McGinnes2018-10-041-2/+2
| | | | | * replaced "." in headings with "ยท" to prevent whitspace being appended by texinfo and breaking git.
* docs: pythonBen McGinnes2018-10-047-35/+90
| | | | | * Fixed an error in the new index page and then exported to the other two "source" formats.
* docs: pythonBen McGinnes2018-10-042-0/+58
| | | | | | | | | | | | | * lang/python/doc/meta/TODO.org: Added the two major documentation build system tasks to the TODO list. * Added an index page in preparation for sorting out the second of those TODO lists (Docutils is a lot easier to handle than Texinfo). * Meanwhile, have confirmed that it all builds just fine under GNU/Linux, OS X and FreeBSD while retaining the documentation, so that's a nice improvement from 1.11.1. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>
* python: makefilesBen McGinnes2018-10-0410-0/+21410
* doc/Makefile.am: Removed a bit I forgot about. * Renamed lang/python/docs to lang/python/doc bvecause apparently automake cares about that too. * Decided to be extra explicit in the manifest because if I don't then all sorts of things get deleted ... like lang/python * Tested on an external linux system just in case my osx workstation introduces too much weirdness. Tested-by: Ben McGinnes <[email protected]> Signed-off-by: Ben McGinnes <[email protected]>