diff options
| author | Ben McGinnes <[email protected]> | 2018-05-15 11:26:30 +0000 |
|---|---|---|
| committer | Ben McGinnes <[email protected]> | 2018-05-15 11:26:30 +0000 |
| commit | 94a0f663760c01ca15c0801ef86b9417da3314e8 (patch) | |
| tree | b00120f866cf8149e62cff9659bc1d5796f647e0 | |
| parent | meta: .gitignore (diff) | |
| download | gpgme-94a0f663760c01ca15c0801ef86b9417da3314e8.tar.gz gpgme-94a0f663760c01ca15c0801ef86b9417da3314e8.zip | |
docs: python bindings howto DITA
* Fixed a typo, added a couple of links.
| -rw-r--r-- | lang/python/docs/dita/howto/part-4.dita | 2 | ||||
| -rw-r--r-- | lang/python/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 @@ <!DOCTYPE dita PUBLIC "-//OASIS//DTD DITA Composite//EN" "ditabase.dtd"> <dita xml:lang="en-GB"> <topic id="topic_dz3_mpy_5db"> - <title>The Fun Stuff</title> + <title>Cryptographic Functions</title> <body> <p></p> </body> 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 @@ <topic id="topic_nb3_hrx_5db"> <title>Documentation Source Files</title> <body> - <p>Unlike all other documentation in the GnuPG Project, including the initial version of - this HOWTO, this version was <i>not</i> 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.</p> + <p>Unlike all other documentation in the <xref href="https://gnupg.org" format="html" + scope="external">GnuPG Project</xref>, including the initial version of this HOWTO, this + version was <i>not</i> 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.</p> <p>This was done for two main reasons:</p> <p> <ol id="ol_k3b_wrx_5db"> - <li>A bug in either Org-Mode or Babel prevented the more complex examples included in the - HOWTO from displaying correctly.</li> + <li>A <xref href="https://dev.gnupg.org/T3977" format="html" scope="external">bug</xref> + in either Org-Mode or Babel prevented the more complex examples included in the HOWTO + from displaying correctly.</li> <li>To demonstrate some of the advantages of DITA XML over existing documentation - productionsoftware used in the project (particularly Texinfo and LaTeX).</li> + production software used in the project (particularly Texinfo and LaTeX).</li> </ol> </p> <p>The XML format definitely supports displaying all the more complex Python code correctly, |