[kupfer] doc: Write Manual.rst as a portal page for documentation



commit 42a03630745d377b3b37c0f4e47ec273f314b6e1
Author: Ulrik Sverdrup <ulrik sverdrup gmail com>
Date:   Sun Mar 20 15:24:45 2011 +0100

    doc: Write Manual.rst as a portal page for documentation

 Documentation/Manual.rst    |   40 ++++++++++++++++++++++++++++++++++++++++
 Documentation/PluginAPI.rst |    1 -
 2 files changed, 40 insertions(+), 1 deletions(-)
---
diff --git a/Documentation/Manual.rst b/Documentation/Manual.rst
new file mode 100644
index 0000000..0ac9b64
--- /dev/null
+++ b/Documentation/Manual.rst
@@ -0,0 +1,40 @@
+
+==============================
+Kupfer Technical Documentation
+==============================
+
+.. topic:: `Kupfer Plugin API <PluginAPI.html>`_
+
+    ..
+
+.. topic:: `Contributing <Contributing.html>`_
+
+    ..
+
+.. topic:: `Localization <Localization.html>`_
+
+    ..
+
+.. topic:: `Man Page <Manpage.html>`_
+
+    ..
+
+
+There is also `User Documentation`__
+
+__ http://kaizer.se/wiki/kupfer/help/
+
+
+..  How to Generate HTML or PDF from this documentation.
+    
+    This is a RestructuredText_ document and it can be rendered
+    by installing ``python-docutils`` (``docutils`` module).
+    This package should also provide the utilities ``rst2html`` and
+    ``rst2pdf`` as well as ``rst2man``.
+
+    .. _RestructuredText: http://docutils.sourceforge.net/rst.html
+
+
+
+.. vim: ft=rst tw=72 et sts=4 sw=4
+.. this document best viewed with rst2html
diff --git a/Documentation/PluginAPI.rst b/Documentation/PluginAPI.rst
index 26f893c..0e24fa5 100644
--- a/Documentation/PluginAPI.rst
+++ b/Documentation/PluginAPI.rst
@@ -2,7 +2,6 @@
 Kupfer Plugin API
 =================
 
-:Date: 2011
 :Homepage: http://kaizer.se/wiki/kupfer
 
 .. contents:: :depth: 2



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]