1GPGME Python Bindings Documentation 2=================================== 3 4As the GPGME Python bindings exist in two worlds within the FOSS 5universe, it's always had a little issue with regards to its 6documentation and specifically to the format of it. The GnuPG 7Project, like much of the rest of the GNU Project, uses Texinfo to 8build its documentation. While the actual format used to write and 9edit that documentation is Org mode. Largely because most, if not 10all, of the GnuPG developers use GNU Emacs for much of their work. 11 12The Python world, however, utilises reStructuredText almost 13universally. This in turn is used by Sphinx or Docutils directly to 14build the documentation. 15 16Each has various advantages for their own ecisystems, but this part of 17the GnuPG effort is aimed at both sides. So, long story short, this 18documentation is provided as both Texinfo and reStructuredText files. 19 20This docs directory contains four main subdirectories: 21 22 1. meta 23 2. src 24 3. rst 25 4. texinfo 26 27The Meta directory is for docs that are not intended for distribution 28or are about the docs themselves. The sole exception being this 29README file. 30 31The Src directory is where the original edited files are, from which 32the following two formats are generated initially. Most, if not all, 33of these are written in Org Mode. 34 35The ReST directory contains reStructuredText files which have been 36converted to that format from the Org Mode files via Pandoc. 37 38The Texinfo directory contains Texinfo files which have been exported 39to that format from the Org Mode files by Org Mode itself within GNU 40Emacs. 41 42Those latter two directories should then be used by their respective 43build systems to produce the various output file formats they normally 44do. They should not spill out into this parent directory. 45Particularly since it is quite possible, perhaps even likely, that 46alternatives to both of them may be added to this parent documentation 47directory at some future point. 48