aboutsummaryrefslogtreecommitdiffstats
path: root/lang/python/doc (follow)
Commit message (Collapse)AuthorAgeFilesLines
* 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]>