summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBen McGinnes <ben@adversary.org>2018-02-15 21:28:07 +1100
committerBen McGinnes <ben@adversary.org>2018-02-15 21:28:07 +1100
commit40da5022922172ed898172956a8ccf5622e5638d (patch)
treee5c987d68a1234e932e188c666f16dd793c1288e
parent3c3b149996036e7ff4cc4c77ef2d97062d880409 (diff)
downloadgpgme-40da5022922172ed898172956a8ccf5622e5638d.tar.gz
TODO
* Beginning to turn the first part of this into something kind of like an actual TODO list as Org Mode uses it (maybe).
-rw-r--r--lang/python/docs/TODO.org41
1 files changed, 34 insertions, 7 deletions
diff --git a/lang/python/docs/TODO.org b/lang/python/docs/TODO.org
index 74b478dc..c0ec5562 100644
--- a/lang/python/docs/TODO.org
+++ b/lang/python/docs/TODO.org
@@ -1,6 +1,33 @@
#+TITLE: Stuff To Do
-* TODO
+* Project Task List
+
+** TODO Documentation default format
+ :PROPERTIES:
+ :CUSTOM_ID: todo-docs-default
+ :END:
+
+ Decide on a default file format for documentation. The two main
+ contenders being Org Mode, the default for the GnuPG Project and
+ reStructuredText, the default for Python projects. A third option
+ of DITA XML was considered due to a number of beneficial features
+ it provides.
+
+ The decision was made to use Org Mode in order to fully integrate
+ with the rest of the GPGME and GnuPG documentation. It is possible
+ to produce reST versions via Pandoc and DITA XML can be reached
+ through converting to either Markdown or XHTML first.
+
+** TODO GUI examples
+ :PROPERTIES:
+ :CUSTOM_ID: todo-gui-examples
+ :END:
+
+ Create some examples of using Python bindings in a GUI application
+ to either match or be similar to the old GTK2 examples available
+ with PyME.
+
+* Project Task Details
** Working examples
:PROPERTIES:
@@ -27,12 +54,12 @@
bindings has been removed.
Current and future documentation will adhere to the GnuPG standard
- of using Org Mode and not use the reST more commonly associated
- with Python documentation. The reasons for this are that this
- project is best served as shipping with the rest of GPGME and the
- documentation ought to match that. Furthermore, there are aspects
- of Org Mode's publishing features which are superior to the
- defaults of reST, including the capacity to generate fully
+ of using Org Mode and not use the reStructuredText (reST) format
+ more commonly associated with Python documentation. The reasons
+ for this are that this project is best served as shipping with the
+ rest of GPGME and the documentation ought to match that. There are
+ also aspects of Org Mode's publishing features which are superior
+ to the defaults of reST, including the capacity to generate fully
validating strict XHTML output.
If reST files are required at a later point for future inclusion