docs: python

* 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 <ben@adversary.org>
Signed-off-by: Ben McGinnes <ben@adversary.org>
This commit is contained in:
Ben McGinnes 2018-10-05 01:47:56 +10:00
parent f3fc737382
commit 4825887972
2 changed files with 58 additions and 0 deletions

View File

@ -29,6 +29,38 @@
through converting to either Markdown or XHTML first.
** TODO Documentation build systems
:PROPERTIES:
:CUSTOM_ID: todo-docs-build-systems
:END:
Though Org Mode is being used for the default documentation format, it
still needs to end up as usable by end users. So the Org Mode files
are used to produce the "source" files used by the two main contenders
for documenting the bindings: Texinfo and ReStructuredText/Docutils.
*** TODO Texinfo documentation
:PROPERTIES:
:CUSTOM_ID: todo-docs-build-texinfo
:END:
Need to add all of Texinfo's ... special systems to make it do its
things.
*** TODO ReStructuredText documentation
:PROPERTIES:
:CUSTOM_ID: todo-docs-build-docutils
:END:
Need to run Sphinx's quick start, add it to the requirements and tweak
the index page for the rst files to point to the HOWTO and other files.
It might just be easier to do all that in Org Mode and convert the
lot, then the Sphinx bits can be automated.
** STARTED Documentation HOWTO
:PROPERTIES:
:CUSTOM_ID: todo-docs-howto

View File

@ -0,0 +1,26 @@
#+TITLE: GNU Privacy Guard (GnuPG) Made Easy Python Bindings
#+AUTHOR: Ben McGinnes
#+LATEX_COMPILER: xelatex
#+LATEX_CLASS: article
#+LATEX_CLASS_OPTIONS: [12pt]
#+LATEX_HEADER: \usepackage{xltxtra}
#+LATEX_HEADER: \usepackage[margin=1in]{geometry}
#+LATEX_HEADER: \setmainfont[Ligatures={Common}]{Times New Roman}
#+LATEX_HEADER: \author{Ben McGinnes <ben@gnupg.org>}
* GPGME Python Bindings
:PROPERTIES:
:CUSTOM_ID: index
:END:
** Contents
:PROPERTIES:
:CUSTOM_ID: index-contents
:END:
- [[short-history][A short history of the project]]
- [[gpgme-python-howto][GPGME Python Bindings HOWTO]]