docs: python
* More restructuring. Also the painstaking task of deciphering some of the more eclectic aspects of Texinfo and make.
This commit is contained in:
parent
a982f91315
commit
2151b9828a
@ -1,4 +1,9 @@
|
||||
recursive-include examples *.py
|
||||
recursive-include docs *.org *.texi *.info *.rst
|
||||
recursive-include docs src *.org
|
||||
recursive-include docs rst *.rst
|
||||
recursive-include docs texinfo *.texi *.infok
|
||||
recursive-include examples *.py *.pyx
|
||||
include README README.org
|
||||
include gpgme.i
|
||||
include helpers.c helpers.h private.h
|
||||
include version.py
|
||||
|
@ -22,8 +22,13 @@ EXTRA_DIST = \
|
||||
gpgme.i \
|
||||
helpers.c helpers.h private.h \
|
||||
examples \
|
||||
docs \
|
||||
src
|
||||
|
||||
dist-hook:
|
||||
cp -pr "$(srcdir)/docs" "$(DESTDIR)/docs"
|
||||
rm -rf `find "$(srcdir)/docs" -name meta`
|
||||
|
||||
SUBDIRS = . tests
|
||||
|
||||
.PHONY: prepare
|
||||
|
47
lang/python/docs/README
Normal file
47
lang/python/docs/README
Normal file
@ -0,0 +1,47 @@
|
||||
GPGME Python Bindings Documentation
|
||||
===================================
|
||||
|
||||
As the GPGME Python bindings exist in two worlds within the FOSS
|
||||
universe, it's always had a little issue with regards to its
|
||||
documentation and specifically to the format of it. The GnuPG
|
||||
Project, like much of the rest of the GNU Project, uses Texinfo to
|
||||
build its documentation. While the actual format used to write and
|
||||
edit that documentation is Org mode. Largely because most, if not
|
||||
all, of the GnuPG developers use GNU Emacs for much of their work.
|
||||
|
||||
The Python world, however, utilises reStructuredText almost
|
||||
universally. This in turn is used by Sphinx or Docutils directly to
|
||||
build the documentation.
|
||||
|
||||
Each has various advantages for their own ecisystems, but this part of
|
||||
the GnuPG effort is aimed at both sides. So, long story short, this
|
||||
documentation is provided as both Texinfo and reStructuredText files.
|
||||
|
||||
This docs directory contains four main subdirectories:
|
||||
|
||||
1. meta
|
||||
2. src
|
||||
3. rst
|
||||
4. texinfo
|
||||
|
||||
The Meta directory is for docs that are not intended for distribution
|
||||
or are about the docs themselves. The sole exception being this RDME
|
||||
file.
|
||||
|
||||
The Src directory is where the original edited files are, from which
|
||||
the following two formats are generated initially. Most, if not all,
|
||||
of these are written in Org Mode.
|
||||
|
||||
The ReST directory contains reStructuredText files ehich have been
|
||||
converted to that format from the Org Mode files via Pandoc.
|
||||
|
||||
The Texinfo directory contains Texinfo files which have been exported
|
||||
to that format from the Org Mode files by Org Mode itself within GNU
|
||||
Emacs.
|
||||
|
||||
Those latter two directories should then be used by their respective
|
||||
build systems to produce the various output file formats they normally
|
||||
do. They should not spill out into this parent directory.
|
||||
Particularly since it is quite possible, perhaps even likely, that
|
||||
alternatives to both of them may be added to this parent documentation
|
||||
directory at some future point.
|
8962
lang/python/docs/texinfo/texinfo.tex
Normal file
8962
lang/python/docs/texinfo/texinfo.tex
Normal file
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user