From 94a0f663760c01ca15c0801ef86b9417da3314e8 Mon Sep 17 00:00:00 2001 From: Ben McGinnes Date: Tue, 15 May 2018 21:26:30 +1000 Subject: [PATCH] docs: python bindings howto DITA * Fixed a typo, added a couple of links. --- lang/python/docs/dita/howto/part-4.dita | 2 +- .../docs/dita/howto/part01/docs-source.dita | 16 +++++++++------- 2 files changed, 10 insertions(+), 8 deletions(-) diff --git a/lang/python/docs/dita/howto/part-4.dita b/lang/python/docs/dita/howto/part-4.dita index 3b805e0d..c985995f 100644 --- a/lang/python/docs/dita/howto/part-4.dita +++ b/lang/python/docs/dita/howto/part-4.dita @@ -2,7 +2,7 @@ - The Fun Stuff + Cryptographic Functions

diff --git a/lang/python/docs/dita/howto/part01/docs-source.dita b/lang/python/docs/dita/howto/part01/docs-source.dita index a9924b42..8e97a353 100644 --- a/lang/python/docs/dita/howto/part01/docs-source.dita +++ b/lang/python/docs/dita/howto/part01/docs-source.dita @@ -4,17 +4,19 @@ Documentation Source Files -

Unlike all other documentation in the GnuPG Project, including the initial version of - this HOWTO, this version was not written in Emacs Org-Mode. Nor was it written in - LaTeX, Texinfo or even directly in HTML. Instead it was written using the Darwin Information - Typing Architecture (DITA) XML.

+

Unlike all other documentation in the GnuPG Project, including the initial version of this HOWTO, this + version was not written in Emacs Org-Mode. Nor was it written in LaTeX, Texinfo or + even directly in HTML. Instead it was written using the Darwin Information Typing + Architecture (DITA) XML.

This was done for two main reasons:

    -
  1. A bug in either Org-Mode or Babel prevented the more complex examples included in the - HOWTO from displaying correctly.
    2. +
  2. A bug + in either Org-Mode or Babel prevented the more complex examples included in the HOWTO + from displaying correctly.
  3. To demonstrate some of the advantages of DITA XML over existing documentation - productionsoftware used in the project (particularly Texinfo and LaTeX).
    4. + production software used in the project (particularly Texinfo and LaTeX).

The XML format definitely supports displaying all the more complex Python code correctly,