Merge lp:~izidor/gtg/documentation into lp:~gtg/gtg/old-trunk

[Izidor Matušov]

Introduce developer documentation using Sphinx. It is replacement for Pydoctor. Because readthedocs.org expects documentation to be in docs/ folder, I had to move doc to docs. By that occasion I fixed setup.py:

 - it generates lists of files and packages instead of listing them (no more dead files there)
 - I looked into upgrading to setuptools but it does not support installation in /usr/share :(
 - generate man files from sphinx documentation (RST is much friendlier format)
 - allow installation of GTG on case insensitive file systems

I also removed special handling for liblarch. Everybody should have installed it already. For development we should use virtualenv or virtualenvwrapper :)

[Izidor Matušov (izidor)]

This branch is based on test clean-up, which originally removed pydoctor support. That branch is not merged at the moment.

[lp:~izidor/gtg/documentation]

1383. By Izidor Matušov on 2014-03-14

Merge trunk

=== renamed file 'gtcli' => 'GTG/gtcli'
=== renamed file 'GTG/gtg.py' => 'GTG/gtg' (properties changed: -x to +x)
--- GTG/gtg.py	2013-11-25 02:37:46 +0000
+++ GTG/gtg	2014-03-14 20:44:47 +0000
@@ -50,9 +50,13 @@
 import logging
 import dbus
 
+from optparse import OptionParser
+from gi.repository.Gdk import Screen
+
 # our own imports
+from GTG import _
+from GTG import info
 from GTG.backends import BackendFactory
-from GTG import _
 from GTG.core import CoreConfig
 from GTG.core.datastore import DataStore
 from GTG.gtk.manager import Manager
@@ -111,13 +115,58 @@
         # Ignore missing PID file
         pass
 
+
+def x_is_running():
+    """ Return True if GTG could be displayed on the current XServer """
+    try:
+        if Screen().get_default().get_display():
+            return True
+    except RuntimeError as exc:
+        print(exc)
+    return False
+
 #=== MAIN CLASS ===============================================================
 
 
-def main(options=None, args=None):
-    '''
-    Calling this starts the full GTG experience  ( :-D )
-    '''
+def parse_args():
+    """ Parse arguments """
+    parser = OptionParser()
+    parser.add_option('-b', '--boot-test', action='store_true',
+                      dest='boot_test',
+                      help="Exit after completing boot-up actions",
+                      default=False)
+    parser.add_option('-c', '--no-crash-handler', action='store_true',
+                      dest='no_crash_handler',
+                      help="Disable the automatic crash handler",
+                      default=False)
+    parser.add_option('-d', '--debug', action='store_true', dest='debug',
+                      help="Enable debug output", default=False)
+    parser.add_option('-t', '--title', action='store',
+                      help="Use special title for windows' title")
+    parser.add_option('-v', '--version', action='store_true',
+                      dest='print_version', help="Print GTG's version number",
+                      default=False)
+    return parser.parse_args()
+
+
+def main():
+    '''
+    Calling this starts the full GTG experience
+    '''
+    options, args = parse_args()
+    if options.print_version:
+        print("GTG (Getting Things GNOME!)", info.VERSION)
+        print()
+        print("For more information:", info.URL)
+        sys.exit(0)
+
+    elif not x_is_running():
+        print("Could not open X display")
+        sys.exit(1)
+
+    if options.title is not None:
+        info.NAME = options.title
+
     ds, req = core_main_init(options, args)
     # Launch task browser
     manager = Manager(req)
@@ -180,4 +229,7 @@
 #=== EXECUTION ================================================================
 
 if __name__ == "__main__":
-    main()
+    try:
+        main()
+    except KeyboardInterrupt:
+        sys.exit(1)

=== renamed file 'gtg_new_task' => 'GTG/gtg_new_task'
=== removed file 'GTG/tools/import_liblarch.py'
--- GTG/tools/import_liblarch.py	2013-11-25 02:37:46 +0000
+++ GTG/tools/import_liblarch.py	1970-01-01 00:00:00 +0000
@@ -1,106 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding:utf-8 -*-
-# -----------------------------------------------------------------------------
-# Getting Things GNOME! - A personal organizer for the GNOME desktop
-# Copyright (c) 2008-2013 Lionel Dricot & Bertrand Rousseau
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program.  If not, see <http://www.gnu.org/licenses/>.
-# -----------------------------------------------------------------------------
-
-""" Check if liblarch is installed """
-
-import sys
-
-REQUIRED_LIBLARCH_API = "2.1"
-GIT_CMD = "git clone https://github.com/liblarch/liblarch ../liblarch"
-
-
-def import_liblarch(use_local=False):
-    """ Check if liblarch is installed and is compatible
-
-    If not, provide information how to obtain the newest version.
-    If use_local, prioritize local (development) liblarch in ../liblarch"""
-
-    def check_liblarch():
-        """
-        Import liblarch and find out which one is missing
-        """
-        has_libraries = True
-        missing = []
-        try:
-            import liblarch
-            assert liblarch
-        except ImportError:
-            has_libraries = False
-            missing.append("liblarch")
-
-        try:
-            import liblarch_gtk
-            assert liblarch_gtk
-        except ImportError:
-            has_libraries = False
-            missing.append("liblarch_gtk")
-
-        return has_libraries, " and ".join(missing)
-
-    if use_local:
-        sys.path.insert(0, "../liblarch")
-
-    has_libraries, missing = check_liblarch()
-
-    if not use_local and not has_libraries:
-        sys.path.append("../liblarch/")
-        has_libraries, missing = check_liblarch()
-
-    if not has_libraries:
-        print("""GTG can't find %s. To install missing libraries,
-run the following command in the current folder:
-
-%s
-
-More information about liblarch: https://live.gnome.org/liblarch/""" % (
-            missing, GIT_CMD))
-        return False
-
-    import liblarch
-    try:
-        is_liblarch_compatible = liblarch.is_compatible(REQUIRED_LIBLARCH_API)
-    except:
-        print("""I could not recognize your liblarch module. Make sure that
-you don't have stale copies of liblarch in your import path
-""")
-        is_liblarch_compatible = False
-    if not is_liblarch_compatible:
-        try:
-            liblarch_version = liblarch.API
-        except AttributeError:
-            # Liblarch 1.0 has lowercased API variable
-            liblarch_version = liblarch.api
-
-        print("""Your liblarch copy has its API at version %s
-but your GTG copy need liblarch API version %s
-You may fix that by downloading the last version of liblarch with
-
-%s """ % (liblarch_version, REQUIRED_LIBLARCH_API, GIT_CMD))
-        return False
-
-    return True
-
-if __name__ == "__main__":
-    use_local = "-l" in sys.argv[1:] or "--local-liblarch" in sys.argv[1:]
-
-    if import_liblarch(use_local):
-        sys.exit(0)
-    else:
-        sys.exit(1)

=== modified file 'MANIFEST.in'
--- MANIFEST.in	2012-05-23 08:55:31 +0000
+++ MANIFEST.in	2014-03-14 20:44:47 +0000
@@ -1,16 +1,15 @@
-recursive-include GTG *.glade
 recursive-include GTG *.ui
 recursive-include GTG *.gtg-plugin
 recursive-include GTG *.png
 recursive-include GTG *.svg
-include gtg.desktop
+recursive-include GTG/plugins/export *
 include CHANGELOG
 include README
 include LICENSE
 include AUTHORS
-include org.gnome.GTG.service
-recursive-include data/icons *.png
-recursive-include data/icons *.svg
-include doc/*.1
-recursive-include GTG/plugins/export *
+include requirements.txt
+recursive-include data *
 recursive-include po *.po
+include docs/Makefile
+recursive-include docs/source *
+recursive-include docs/userdoc *

=== renamed file 'gtcli_bash_completion' => 'data/gtcli_bash_completion' (properties changed: +x to -x)
=== renamed file 'gtg.appdata.xml' => 'data/gtg.appdata.xml'
=== renamed file 'gtg.desktop' => 'data/gtg.desktop'
=== renamed file 'org.gnome.GTG.service' => 'data/org.gnome.GTG.service'
=== removed file 'doc/gtcli.1'
--- doc/gtcli.1	2013-12-12 12:43:00 +0000
+++ doc/gtcli.1	1970-01-01 00:00:00 +0000
@@ -1,58 +0,0 @@
-.TH gtgcli 1 2012-08-16 "gtgcli"
-.SH NAME
-gtcli \-  Command-line interface for Getting Things GNOME!
-.SH SYNOPSIS
-.B gtgcli [options] COMMAND [command options]
-.SH DESCRIPTION
-gtgcli provides a handy command-line interface to GTG. It allows one to list
-and modify your task directly from the command line. It also allows one to
-interact with GTG using shell scripts.
-.SH OPTIONS
-.TP
-\fB\-h, \-\-help\fB
-Prints some information about gtg's usage and options.
-.SH COMMAND OPTIONS
-.TP
-\fBnew\fB
-Creates a new task.
-.TP
-\fBshow <tid>\fB
-Display task with <tid> task ID.
-.TP
-\fBedit <tid>\fB
-Opens the GUI editor for the task with <tid> task ID.
-.TP
-\fBdelete <tid>\fB
-Removes task with <tid> task ID.
-.TP
-\fBlist [all|today|<filter>|<tag>]\fB
-List tasks corresponding to the given attributes.
-.TP
-\fBsearch <expression>\fB
-Search tasks corresponding to <expression>. Read the documentation from GTG's
-help to know more about the search query syntax.
-.TP
-\fBcount [all|today|<filter>|<tag>]\fB
-Outputs the task count for all the task corresponding to the given attributes.
-.TP
-\fBsummary [all|today|<filter>|<tag]\fB
-Report how many tasks starting/due each day.
-.TP
-\fBpostpone <tid> <date>\fB
-Updates the start date of the task with <tid> task id to <date>.
-.TP
-\fBclose <tid>\fB
-Sets state of task identified by <tid> to done.
-.TP
-\fBbrowser [hide|show]\fB
-Hides or shows the task browser window.
-.SH "SEE ALSO"
-gtg (1)
-.SH BUGS
-Please report any bug you may experience to the \fBGTG\fP Developers, that can
-be reached at \fRhttps://edge.launchpad.net/gtg\fP
-.SH COPYRIGHT
-This manual page is Copyright 2012 Bertrand Rousseau
-<[e-mail]>. Permission is granted to copy, distribute
-and/or modify this document under the terms of the GNU General Public License,
-Version 3 or any later version published by the Free Software Foundation.

=== removed file 'doc/gtg.1'
--- doc/gtg.1	2013-12-12 12:43:00 +0000
+++ doc/gtg.1	1970-01-01 00:00:00 +0000
@@ -1,52 +0,0 @@
-.TH gtg 1 2012-08-16 "gtg"
-.SH NAME
-gtg \-  Getting Things GNOME!, a personal tasks and TODO-list items organizer
-for the GNOME desktop environment
-.SH SYNOPSIS
-.B gtg [options]
-.SH DESCRIPTION
-Getting Things GNOME! is a personal tasks and TODO-list items organizer for the
-GNOME desktop environment inspired by the Getting Things Done (GTD)
-methodology. GTG is designed with flexibility, adaptability, and ease of use
-in mind so it can be used as more than just GTD software.
-.PP
-GTG is intended to help you track everything you need to do and need to know,
-from small tasks to large projects.
-.PP
-GTG uses a very handy system for creating and editing tasks. The task editor
-can automatically recognize metadata such as tags and subtasks through the use
-of a very simple syntax.
-.SH OPTIONS
-.TP
-\fB\-b, \-\-boot\-test\fB
-Boot-up only.  Causes gtg to exit immediately after completing the first
-iteration of the main loop.  Useful for boot performance testing work.
-.TP
-\fB\-c, \-\-no-crash\-handler\fB
-Disable crash handler.  Causes the Apport automatic crash reporting
-utility to not be invoked when gtg crashes; instead it will print out a
-normal python backtrace.  This can be useful for debugging crash bugs,
-or if the crash handler is misbehaving.
-.TP
-\fB\-d, \-\-debug\fB
-Debug mode.  Prints extra information to the console which may be useful
-for understanding and reporting bugs.
-.TP
-\fB\-h, \-\-help\fB
-Prints some information about gtg's usage and options.
-.TP
-\fB\-l, \-\-local-liblarch\fB
-Use local liblarch. Look for the liblarch python library in ../liblarch.
-This is mainly useful for testing purpose.
-.TP
-\fB\-t TITLE, \-\-title=TITLE\fB
-Set the window's title to TITLE.
-.TP
-\fB\-v, \-\-version\fB
-Prints version and exits.
-.SH COPYRIGHT
-This manual page is Copyright 2009, 2012 Luca Falavigna <[e-mail]>
-and Bertrand Rousseau <[e-mail]>. Permission is granted
-to copy, distribute and/or modify this document under the terms of the GNU
-General Public License, Version 3 or any later version published by the Free
-Software Foundation.

=== removed file 'doc/gtg_new_task.1'
--- doc/gtg_new_task.1	2012-05-23 08:55:31 +0000
+++ doc/gtg_new_task.1	1970-01-01 00:00:00 +0000
@@ -1,29 +0,0 @@
-.TH GTG_NEW_TASK 1 "4 December 2009"
-.SH NAME
-gtg_new_task \- Adds a task to the \fBGetting Things GNOME!\fP organizer
-.SH SYNOPSIS
-\fBgtg_new_task\fP [\-h | \-\-help] [\-i | \-\-interactive]
-.SH DESCRIPTION
-\fBgtg_new_task\fP creates a new task in the Getting Things GNOME! organizer
-for the GNOME desktop via the DBUS message bus.  Getting Things GNOME! must be
-running for the command to work.
-.SS Options
-.TP
-\fB[\-h | \-\-help]\fP
-Shows a brief usage help.
-.TP
-\fB[\-i | \-\-interactive]\fP
-Accepts a task description via stdin.
-.SH FILES
-None
-.SH "SEE ALSO"
-gtg (1)
-.SH BUGS
-Please report any bug you may experience to the \fBGTG\fP Developers, that can
-be reached at \fRhttps://edge.launchpad.net/gtg\fP
-.SH COPYRIGHT
-This manual page is Copyright2009 Luca Invernizzi <[e-mail]>.
-Permission is granted to copy, distribute and/or modify this document under the
-terms of the GNU General Public License, Version 3 or any later version
-published by the Free Software Foundation.
-

=== renamed directory 'doc' => 'docs'
=== added file 'docs/Makefile'
--- docs/Makefile	1970-01-01 00:00:00 +0000
+++ docs/Makefile	2014-03-14 20:44:47 +0000
@@ -0,0 +1,74 @@
+# Makefile for Sphinx documentation
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         = a4
+BUILDDIR      = build
+
+# User-friendly check for sphinx-build
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
+$(error The '$(SPHINXBUILD)' command was not found. Install Sphinx.)
+endif
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean userhtml html singlehtml latex latexpdf man linkcheck
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  userhtml   to make HTML files from user level documentation"
+	@echo "  html       to make standalone HTML files"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  man        to make manual pages"
+	@echo "  linkcheck  to check all external links for integrity"
+
+clean:
+	rm -rf $(BUILDDIR)/*
+	rm -f *.1
+
+userhtml:
+	mkdir -p $(BUILDDIR)/userhtml
+	yelp-build html -o $(BUILDDIR)/userhtml userdoc/C/*.page
+	@echo
+	@echo "Build finished. User HTML pages are in $(BUILDDIR)/userhtml."
+
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) .
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."

=== added directory 'docs/source'
=== added directory 'docs/source/_static'
=== added directory 'docs/source/_templates'
=== added file 'docs/source/conf.py'
--- docs/source/conf.py	1970-01-01 00:00:00 +0000
+++ docs/source/conf.py	2014-03-14 20:44:47 +0000
@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+# -*- coding: utf-8 -*-
+
+import os
+import sys
+
+# Use local version of GTG
+sys.path.insert(0, '../..')
+
+from GTG import info
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+    'sphinx.ext.viewcode',
+]
+
+project = 'Getting Things GNOME!'
+copyright = 'The GTG Team'
+
+short_version = '.'.join(info.VERSION.split('.')[:2])
+version = short_version
+release = info.VERSION
+
+master_doc = 'index'
+source_suffix = '.rst'
+
+exclude_patterns = []
+pygments_style = 'sphinx'
+
+# -- Options for HTML output ----------------------------------------------
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+if on_rtd:
+    html_theme = 'default'
+else:
+    html_theme = 'nature'
+
+html_show_sphinx = False
+
+# -- Options for LaTeX output ---------------------------------------------
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [(
+    'index',
+    'gtg.tex',
+    'Getting Things GNOME! Documentation',
+    'The GTG Team',
+    'manual',
+)]
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (
+        'man/gtcli', 'gtcli',
+        'Command-line interface for Getting Things GNOME!',
+        [], 1,
+    ),
+    (
+        'man/gtg', 'gtg',
+        'Getting Things GNOME!, a personal tasks and TODO-list items '
+        'organizer for the GNOME desktop environment',
+        [], 1,
+    ),
+    (
+        'man/gtg_new_task', 'gtg_new_task',
+        'Adds a task to the Getting Things GNOME! organizer',
+        [], 1,
+    ),
+]

=== added file 'docs/source/contributing.rst'
--- docs/source/contributing.rst	1970-01-01 00:00:00 +0000
+++ docs/source/contributing.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,140 @@
+===================
+Contributing to GTG
+===================
+
+GTG uses Bazaar_ for versioning. It might be useful to read `Bazaar's tutorial`_ first.
+
+.. _Bazaar: http://bazaar.canonical.com/
+.. _`Bazaar's tutorial`: http://doc.bazaar.canonical.com/latest/en/mini-tutorial/
+
+Dependencies
+============
+
+You need to have python-configobj installed
+
+Getting the code
+================
+
+Get the latest version of the code on Launchpad_::
+
+    $ bzr branch lp:gtg trunk
+
+Although if you're thinking of contributing more than one patch, you might want to do::
+
+    $ bzr init-repo gtg
+    $ cd gtg
+    $ bzr branch lp:gtg trunk
+
+This will share revision data between branches, reducing storage costs & network time.
+
+
+Launch gtg with debugging data (so it doesn't mess with your data)::
+
+    $ cd trunk
+    $ ./scripts/debug.sh
+
+.. _Launchpad: https://launchpad.net
+
+Choosing a feature to work on
+=============================
+
+If you are a happy user of GTG and nothing bothers you but you would like to contribute you can:
+
+* choose a `LOVE bug`_ which are easier to solve
+* ask people on IRC channel #gtg on irc://irc.gimp.org/#gtg
+* ask on our `mailing list`_
+
+.. _`LOVE bug`: https://bugs.launchpad.net/gtg/+bugs?field.status%3Alist=NEW&field.status%3Alist=CONFIRMED&field.status%3Alist=TRIAGED&field.status%3Alist=INPROGRESS&assignee_option=none&field.tag=love
+.. _`mailing list`: https://launchpad.net/~gtg-user
+
+
+Working on the feature in a branch
+==================================
+
+You have your local copy of the code (see "Getting the code"). Now, create a
+local branch of your local branch (yes, it is)::
+
+    $ cd ..
+    $ bzr branch trunk cool-new-feature
+
+(your *trunk* folder is branched in a new *cool-new-feature* folder)
+
+When working with Bazaar, it's a good idea to keep your local *trunk* branch as
+a pristine copy of trunk on Launchpad.
+
+Hack and commit your changes::
+
+    bzr commit -m "description of my change"
+
+Repeat as much as you want. Don't hesitate to abuse the local commits. Think of
+*commit* like *quick save* in a video game :)
+
+Run the units tests to see if all is fine::
+
+    $ make check=python3
+    ./run-tests
+    ...........
+    ----------------------------------------------------------------------
+    Ran 11 tests in 0.063s
+
+    OK
+
+Modify CHANGELOG to reflect your changes. If it's your first contribution, add
+yourself in the AUTHORS file with your email address.
+
+If the trunk has been updated while you were hacking, you should update your
+local trunk branch, and merge modification in **your** branch::
+
+    $ cd ../trunk
+    $ bzr pull trunk
+    $ cd ../cool-new-feature
+    $ bzr merge ../trunk
+
+If you have conflicts, you must solve them. Refer to `conflicts guide`_.
+
+.. _`conflicts guide`: http://doc.bazaar.canonical.com/bzr.0.92/en/user-guide/conflicts.html
+
+Once you don't have any conflict anymore, you must commit the changes related
+to the merge. Use a clear commit message, like::
+
+    Updating branch by merging the last trunk version.
+
+Pushing your work to your own branch on Launchpad (where *ploum* is your
+Launchpad username)::
+
+    $ bzr push lp:~ploum/gtg/cool-new-feature
+
+Alternatively, if you want other gtg users to be able to write to your branch,
+push it in the gtg-user group (you have to be part of it)::
+
+    $ bzr push lp:~gtg-user/gtg/ploum_branch
+
+Ask for a merge request and comment on the corresponding bug. (Open one if
+there is none). Add the tag *toreview* to the bug in Launchpad. This is very
+important and ensures we are not letting a patch rotting.
+
+You can file a bug at https://bugs.launchpad.net/gtg/+filebug.
+
+To ask for a merge request, run::
+
+$ cd cool-new-feature
+$ bzr lp-open
+
+This will open the branch's web page on Launchpad. From there, click *Propose for merging*.
+
+If your branch is solving specific reported bugs, please also register your
+branch to these bugs (there is an link for that in each bug report page). It
+allows to link together all related resources (which in turn is useful to dig
+out precious information from all the discussions that happened around those
+bugs).
+
+For more detailed information, see the `HACKING`_ guide included in the GTG code.
+
+.. _`HACKING`: http://bazaar.launchpad.net/~gtg/gtg/trunk/annotate/head%3A/HACKING
+
+Troubleshooting
+===============
+
+If you have a problem with SSH keys while uploading to Launchpad, look at this `SuperUser question`_.
+
+.. _`SuperUser question`: http://superuser.com/questions/161337/big-ssh-problem

=== added file 'docs/source/index.rst'
--- docs/source/index.rst	1970-01-01 00:00:00 +0000
+++ docs/source/index.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,53 @@
+=====================
+Getting Things GNOME!
+=====================
+
+Getting Things GNOME! (GTG) is a personal tasks and TODO-list items organizer
+for the GNOME desktop environment inspired by the Getting Things Done (GTD)
+methodology. GTG is designed with flexibility, adaptability, and ease of use in
+mind so it can be used as more than just GTD software.
+
+GTG is intended to help you track everything you need to do and need to know,
+from small tasks to large projects.
+
+Contents
+========
+
+* `User level documentation <http://www.gtgnome.net/html/userdoc/index.html>`_
+
+
+Documentation for developers:
+
+.. toctree::
+   :maxdepth: 1
+
+   contributing
+
+Man pages
+=========
+
+.. toctree::
+   :maxdepth: 1
+
+   man/gtg
+   man/gtg_new_task
+   man/gtcli
+
+Release notes
+=============
+
+.. toctree::
+   :maxdepth: 1
+
+   releases/v0.3.1
+   releases/v0.2.2
+   releases/v0.1.9
+   releases/v0.1
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

=== added directory 'docs/source/man'
=== added file 'docs/source/man/gtcli.rst'
--- docs/source/man/gtcli.rst	1970-01-01 00:00:00 +0000
+++ docs/source/man/gtcli.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,78 @@
+gtcli(1)
+========
+
+SYNOPSIS
+--------
+
+**gtgcli [options] COMMAND [command options]**
+
+DESCRIPTION
+-----------
+gtgcli provides a handy command-line interface to GTG. It allows one to list
+and modify your task directly from the command line. It also allows one to
+interact with GTG using shell scripts.
+
+OPTIONS
+-------
+
+**-h, --help**
+    Prints some information about gtg's usage and options.
+
+COMMAND OPTIONS
+---------------
+
+**new**
+    Creates a new task.
+
+
+**show <tid>**
+    Display task with <tid> task ID.
+
+
+**edit <tid>**
+    Opens the GUI editor for the task with <tid> task ID.
+    
+
+**delete <tid>**
+    Removes task with <tid> task ID.
+
+**list [all|today|<filter>|<tag>]**
+    List tasks corresponding to the given attributes.
+
+**search <expression>**
+    Search tasks corresponding to <expression>. Read the documentation from GTG's
+    help to know more about the search query syntax.
+
+**count [all|today|<filter>|<tag>]**
+    Outputs the task count for all the task corresponding to the given attributes.
+
+**summary [all|today|<filter>|<tag]**
+    Report how many tasks starting/due each day.
+
+**postpone <tid> <date>**
+    Updates the start date of the task with <tid> task id to <date>.
+
+**close <tid>**
+    Sets state of task identified by <tid> to done.
+
+**browser [hide|show]**
+    Hides or shows the task browser window.
+
+SEE ALSO
+--------
+
+gtg (1)
+
+BUGS
+----
+
+Please report any bug you may experience to the **GTG** Developers, that can
+be reached at https://launchpad.net/gtg
+
+COPYRIGHT
+---------
+
+This manual page is Copyright 2012 Bertrand Rousseau
+<[e-mail]>. Permission is granted to copy, distribute
+and/or modify this document under the terms of the GNU General Public License,
+Version 3 or any later version published by the Free Software Foundation.

=== added file 'docs/source/man/gtg.rst'
--- docs/source/man/gtg.rst	1970-01-01 00:00:00 +0000
+++ docs/source/man/gtg.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,62 @@
+gtg(1)
+======
+
+SYNOPSIS
+--------
+
+**gtg [options]**
+
+DESCRIPTION
+-----------
+
+Getting Things GNOME! is a personal tasks and TODO-list items organizer for the
+GNOME desktop environment inspired by the Getting Things Done (GTD)
+methodology. GTG is designed with flexibility, adaptability, and ease of use in
+mind so it can be used as more than just GTD software.
+
+
+GTG is intended to help you track everything you need to do and need to know,
+from small tasks to large projects.
+
+GTG uses a very handy system for creating and editing tasks. The task editor
+can automatically recognize metadata such as tags and subtasks through the use
+of a very simple syntax.
+
+OPTIONS
+-------
+
+**-b, --boot-test**
+    Boot-up only. Causes gtg to exit immediately after completing the first
+    iteration of the main loop. Useful for boot performance testing work.
+
+**-c, --no-crash-handler**
+    Disable crash handler. Causes the Apport automatic crash reporting utility
+    to not be invoked when gtg crashes; instead it will print out a normal
+    python backtrace. This can be useful for debugging crash bugs, or if the
+    crash handler is misbehaving.
+
+**-d, --debug**
+    Debug mode. Prints extra information to the console which may be useful for
+    understanding and reporting bugs.
+
+**-h, --help**
+    Prints some information about gtg's usage and options.
+
+**-l, --local-liblarch**
+    Use local liblarch. Look for the liblarch python library in ../liblarch.
+    This is mainly useful for testing purpose.
+
+**-t TITLE, --title=TITLE**
+    Set the window's title to TITLE.
+
+**-v, --version**
+    Prints version and exits.
+
+COPYRIGHT
+---------
+
+This manual page is Copyright 2009, 2012 Luca Falavigna <[e-mail]>
+and Bertrand Rousseau <[e-mail]>. Permission is granted
+to copy, distribute and/or modify this document under the terms of the GNU
+General Public License, Version 3 or any later version published by the Free
+Software Foundation.

=== added file 'docs/source/man/gtg_new_task.rst'
--- docs/source/man/gtg_new_task.rst	1970-01-01 00:00:00 +0000
+++ docs/source/man/gtg_new_task.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,42 @@
+gtg_new_task(1)
+===============
+
+SYNOPSIS
+--------
+
+**gtg_new_task** [-h | --help] [-i | --interactive]
+
+DESCRIPTION
+-----------
+
+**gtg_new_task** creates a new task in the Getting Things GNOME! organizer for
+the GNOME desktop via the DBUS message bus. Getting Things GNOME! must be
+running for the command to work.
+
+Options
+~~~~~~~
+
+**[-h | --help]**
+    Shows a brief usage help.
+
+**[-i | --interactive]**
+    Accepts a task description via stdin.
+
+SEE ALSO
+--------
+
+gtg (1)
+
+BUGS
+----
+
+Please report any bug you may experience to the **GTG** Developers, that can be
+reached at https://launchpad.net/gtg
+
+COPYRIGHT
+---------
+
+This manual page is Copyright2009 Luca Invernizzi <[e-mail]>.
+Permission is granted to copy, distribute and/or modify this document under the
+terms of the GNU General Public License, Version 3 or any later version
+published by the Free Software Foundation.

=== renamed directory 'doc/release_notes' => 'docs/source/releases'
=== added file 'docs/source/releases/v0.1.9.rst'
--- docs/source/releases/v0.1.9.rst	1970-01-01 00:00:00 +0000
+++ docs/source/releases/v0.1.9.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,49 @@
+v0.1.9: "Five curtain calls"
+============================
+
+The whole GTG development team is pleased to announce that after months of hard
+work, we've just released a new version of Getting Things GNOME!, codenamed
+"Five curtain calls". Don't even hesitate, rush on our Launchpad project page
+and download the archive or, if you prefer, download the packaged version for
+Debian and Ubuntu from our PPA!
+
+The GTG 0.1.9 release is a beta release for the upcoming 0.2, which is due very
+soon. It packs a *huge amount* of new features, among them:
+
+* support for plugins, thanks to Paulo Cabido's Google Summer of Code
+* already 6 plugins available:
+
+  - Remember the milk synchronization
+  - hamster integration
+  - bugzilla
+  - geolocation
+  - tomboy
+  - notification area
+
+* improved performances
+* support for tag groups
+* improved editor UI
+* fuzzy due dates
+
+The 0.2 release will also fixes not less than 99 bugs! Thanks to our new GTG
+developers (Paulo Cabido, Luca Invernizzi and Kevin Mehall), a terrific work
+has been achieved for 0.1.9!
+
+As this is a beta release, we kindly ask every adventurous testers to help us
+make the soon-to-come 0.2 a great release by reporting any unnoticed bug to our
+project page.
+
+Unfortunately, this release also comes with 2 unresolved bugs that worth mentioning:
+
+* A bug with intel GPU drivers in Ubuntu 9.10 distributions may prevent tag
+  color squares from appearing. It seems that upgrading to a newest version of
+  those drivers fixes that. More info on the bug page.
+* A GTK bug causes some errors to show on standard output if you run GTG from a
+  terminal, this bug has been reported upstream.
+
+Those 2 bugs are caused by upstream bugs and will only be corrected once the
+related apps will be fixed, which should happen anytime.
+
+Anyway, we'll soon come back with a new, shiny, a full-featured 0.2 release
+that will sure rock. Until then, we hope you'll like GTG 0.1.9 as much as we
+do!

=== added file 'docs/source/releases/v0.1.rst'
--- docs/source/releases/v0.1.rst	1970-01-01 00:00:00 +0000
+++ docs/source/releases/v0.1.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,37 @@
+v0.1: "Just 5 minutes more"
+===========================
+
+Hi, everyone!
+
+The first official release of Getting Things Gnome!, GTG "Just 5
+minutes more" 0.1, is out!
+
+GTG is a personal organizer for the GNOME desktop environment, it
+focuses on ease of use and flexibility, while keeping things simple.
+
+This release is our first. So far GTG supports:
+
+ - task edition using a text editor, almost no form fields!
+ - fast consecutive tasks creation
+ - tags to sort tasks
+ - color for tags, to easily differenciate tagged tasks
+
+There are very few differences with the release candidate we published
+last week.
+
+The software is still a bit in a proof-of-concept state, since in the
+future we want to test a lot of different functionalities. We'd really
+like to know what you like and dislike in GTG, so we can organize
+future work and do what's the most important: provide a program that
+people love to use because it makes their life better ;-)
+
+Tarballs with the source code are available on our launchpad project
+page: https://launchpad.net/gtg/+download
+Packages for Ubuntu are also available on our PPA:
+https://launchpad.net/~gtg/+archive/ppa
+
+Now, grab it and tell us what you think! Don't hesitate to discuss
+with us on our mailing-lists, on IRC (#gtg on GimpNET), or to post
+bugs on launchpad!
+
+Enjoy!

=== added file 'docs/source/releases/v0.2.2.rst'
--- docs/source/releases/v0.2.2.rst	1970-01-01 00:00:00 +0000
+++ docs/source/releases/v0.2.2.rst	2014-03-14 20:44:47 +0000
@@ -0,0 +1,16 @@
+v0.2.2: Protector
+=================
+
+After just one month since the last release, the GTG development team is
+pleased to announce the release of Getting things GNOME! 0.2.2, codename
+"Protector". This one is the last of the 0.2.X serie: we have already started
+breaking everything to make GTG faster and better.
+
+Aside from the tons of bug fixes that ship with every release, this one
+features a brand new preference dialog and integration with Docky.
+
+On the new plug-ins side, you'll get one to send tasks via email, another that
+can import tasks from JSON, and the last one that can delete old closed tasks
+automatically (which makes GTG faster if you have a huge amount of tasks).  The
+RememberTheMilk plugin is now stable and features tags synchronization.
+Finally, we support the libindicator library, making GTG "Ubuntu Lucid" ready.

=== renamed file 'doc/release_notes/0.3.1.txt' => 'docs/source/releases/v0.3.1.rst'
--- doc/release_notes/0.3.1.txt	2013-11-24 14:48:09 +0000
+++ docs/source/releases/v0.3.1.rst	2014-03-14 20:44:47 +0000
@@ -1,72 +1,108 @@
-Getting Things GNOME! 0.3.1 - Release Note - 24/11/2013
-=====================================================
+v0.3.1
+======
+
+Released: 24/11/2013
 
 After about 12 months of very active development, the GTG team is proud to
 announce the release of Getting Things GNOME! 0.3.1!
 
 This version is packed with an amazing amount of bug fixes and many novelties!
-The goal with 0.3.1 was to refactor several of it’s existing functionalities and improve the codebase. A lot of time was spent on improving the plugins. In the process we have fixed lots of bugs and have made a few feature enhancements!
+The goal with 0.3.1 was to refactor several of it’s existing functionalities
+and improve the codebase. A lot of time was spent on improving the plugins. In
+the process we have fixed lots of bugs and have made a few feature
+enhancements!
 
 What's new in 0.3.1?
-------------------
-
-Here's an (incomplete) list of changes:
-
-  - Fixed Hamster Plugin: The Hamster plugin which was used to start a GTG Task as a Hamster activity was not working for some time. It has been fixed. Now tasks can be started in Hamster and they can also be stopped from GTG itself. When a task is closed or deleted, it’s corresponding hamster activity will be stopped.
-  - GTGOnline!: Parin Porecha started developing a web application for GTG (currently it is named GTGOnline!) as a part of his Google Summer of Code 2013 project [2]. It is up and running [3]. It not only supports the current features of GTG, but also Task Sharing! You can now add users to groups and share your tasks with them ! He has also written a synchronization backend to sync tasks and tags with GTGOnline!
-  - Port to python3 and gtk3: Xuan Hu ported GTG to python3 and gtk3 as a part of his Google Summer of Code 2013 project [4]. His branch [5] is almost stable and is currently being tested
-  - PEP8ification of the codebase: There were more than 10,000 PEP8 errors in the codebase which have now been removed.
-  - New task keyboard shortcut: Working on another application and need to create a task ?
-Now it is possible via a keyboard shortcut. Configure it in the settings, and on pressing the shortcut, new task editor will open up !
-  - Translations: all translations were updated
-  - Stability: we've fixed many bugs causing crashes during this release.
-  - Various other fixes:
-      - Updated and improved plugins: notification area icon, urgency color,
-        export, ...
-      - 7 new feature enhancements
-
-You can see the complete list of changes in our CHANGELOG:
-https://bazaar.launchpad.net/~gtg/gtg/trunk/view/1332/CHANGELOG
+--------------------
+
+Here's an (incomplete) list of changes.
+You can see the complete list of changes in our CHANGELOG_.
+
+.. _CHANGELOG: https://bazaar.launchpad.net/~gtg/gtg/trunk/view/1332/CHANGELOG
+
+Fixed Hamster Plugin
+~~~~~~~~~~~~~~~~~~~~
+
+The Hamster plugin which was used to start a GTG Task as a Hamster activity was
+not working for some time. It has been fixed. Now tasks can be started in
+Hamster and they can also be stopped from GTG itself. When a task is closed or
+deleted, it’s corresponding hamster activity will be stopped.
+
+GTGOnline!
+~~~~~~~~~~
+
+Parin Porecha started developing a web application for GTG (currently it is
+named GTGOnline!) as a part of `his Google Summer of Code 2013 project`_. It
+is `up and running`_. It not only supports the current features of GTG, but
+also Task Sharing! You can now add users to groups and share your tasks with
+them! He has also written a synchronization backend to sync tasks and tags
+with GTGOnline!
+
+.. _`his Google Summer of Code 2013 project`: https://wiki.gnome.org/Outreach/SummerOfCode/2013/Projects/ParinPorecha_GTGOnline
+.. _`up and running`: http://gtgonline-parinporecha.rhcloud.com/
+
+Port to python3 and gtk3
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Xuan Hu `ported GTG to python3 and gtk3`_ as a part of his Google Summer of
+Code 2013 project. `Xuan's branch`_ is almost stable and is currently being tested
+
+.. _`ported GTG to python3 and gtk3`: https://wiki.gnome.org/Outreach/SummerOfCode/2013/Projects/XuanHu_PortingGTG
+.. _`Xuan's branch`: https://code.launchpad.net/~huxuan/gtg/port-to-gtk3-py3/
+
+PEP8ification of the codebase
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+There were more than 10,000 PEP8 errors in the codebase which have now been removed.
+
+New task keyboard shortcut
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Working on another application and need to create a task?
+
+Now it is possible via a keyboard shortcut. Configure it in the settings, and
+on pressing the shortcut, new task editor will open up!
+
+Translations
+~~~~~~~~~~~~
+
+All translations were updated.
+
+Stability
+~~~~~~~~~
+
+We've fixed many bugs causing crashes during this release.
+
+Various other fixes
+~~~~~~~~~~~~~~~~~~~
+
+* Updated and improved plugins: notification area icon, urgency color, export, ...
+* 7 new feature enhancements
+
+
+Thank You
+---------
 
 The GTG developer team would like to thank and congratulate all the great people
 which contributed to this version. You did an amazing work! Thanks also to our
 many new contributors which joined us during this development cycle!
 
+
 What's next?
 ------------
 
-Xuan Hu ported GTG to python3 and GTK3 as a part of his GSoC project. He has done a great job, and his branch is almost stable.
-During the next months, we plan to test his branch and fix the remaining bugs so that it can be merged for release 0.3.2
-Porting to GTK3 has also paved the way for upcoming redesign of GTG [6]!
+Xuan Hu ported GTG to python3 and GTK3 as a part of his GSoC project. He has
+done a great job, and his branch is almost stable.  During the next months, we
+plan to test his branch and fix the remaining bugs so that it can be merged for
+release 0.3.2 Porting to GTK3 has also paved the way for upcoming
+`redesign of GTG`_!
 
 We also have many other projects in the pipeline, most notably:
 
- - collaborative task management, a project which has been started by
-   Izidor Matusov during Google Summer of Code 2012 [10].
- - Testing and merging GTGOnline! synchronization backend [3] with the trunk.
-
-
-About Getting Things GNOME!
----------------------------
-
-GTG is a personal task organizer for the GNOME desktop inspired by the Getting
-Things Done (GTD) methodology. GTG is designed with flexibility, adaptability,
-and ease of use in mind so it can be used as more than just GTD software.
-
-GTG is intended to help you track everything you need to do and need to know,
-from small tasks to large projects.
-
-Links:
-------
-
- [1] Screenshots: http://gtgnome.net/screenshots
- [2] Parin Porecha’s GSoC (web application for Getting Things Gnome!): https://wiki.gnome.org/SummerOfCode2013/Projects/ParinPorecha_GTGOnline
- [3] Parin Porecha’s GTGOnline! sync backend branch: https://code.launchpad.net/~parinporecha/gtg/backend_gtgonline
- [3] Link to GTG’s web application (GTGOnline!): http://gtgonline-parinporecha.rhcloud.com/
- [4] Xuan Hu’s GSoC (Porting GTG and Liblarch to Gtk3 and Python3): https://wiki.gnome.org/SummerOfCode2013/Projects/XuanHu_PortingGTG
- [5] Xuan Hu’s python3 and gtk3 port branch: https://code.launchpad.net/~huxuan/gtg/port-to-gtk3-py3/
- [6] GTG design page: https://live.gnome.org/gtg/Design
- [7] The project's blog: http://gtgnome.net/
- [8] The project's page on launchpad: https://launchpad.net/gtg
- [9] The project's page on the GNOME wiki: https://live.gnome.org/gtg/
- [10] Izidor Matusov's GSoC (collaborative GTG): https://live.gnome.org/SummerOfCode2012/Projects/IzidorMatusov_CollaborativeGTG
+* `collaborative task management`_, a project which has been started by
+  Izidor Matusov during Google Summer of Code 2012.
+* Testing and merging GTGOnline! `synchronization backend`_ with the trunk.
+
+.. _`redesign of GTG`: https://wiki.gnome.org/Apps/gtg/Design/
+.. _`collaborative task management`: https://wiki.gnome.org/Outreach/SummerOfCode/2012/Projects/IzidorMatusov_CollaborativeGTG
+.. _`synchronization backend`: https://code.launchpad.net/~parinporecha/gtg/backend_gtgonline

=== removed file 'gtg'
--- gtg	2013-11-25 02:37:46 +0000
+++ gtg	1970-01-01 00:00:00 +0000
@@ -1,92 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding:utf-8 -*-
-# -----------------------------------------------------------------------------
-# Getting Things GNOME! - A personal organizer for the GNOME desktop
-# Copyright (c) 2008-2013 Lionel Dricot & Bertrand Rousseau
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program.  If not, see <http://www.gnu.org/licenses/>.
-# -----------------------------------------------------------------------------
-
-""" Main script which parse arguments and launch GTG """
-
-import sys
-
-from optparse import OptionParser
-from gi.repository.Gdk import Screen
-
-from GTG import info
-from GTG.tools.import_liblarch import import_liblarch
-
-
-def x_is_running():
-    """ Return True if GTG could be displayed on the current XServer """
-    try:
-        if Screen().get_default().get_display():
-            return True
-    except RuntimeError as exc:
-        print(exc)
-    return False
-
-
-def main():
-    """ Parse arguments and run GTG
-
-    Importing GTG.gtg must be done after importing and setting up paths
-    for Liblarch """
-
-    parser = OptionParser()
-    parser.add_option('-b', '--boot-test', action='store_true',
-                      dest='boot_test', help="Exit after completing \
-                                                    boot-up actions",
-                      default=False)
-    parser.add_option('-c', '--no-crash-handler', action='store_true',
-                      dest='no_crash_handler', help="Disable the automatic \
-                                                             crash handler",
-                      default=False)
-    parser.add_option('-d', '--debug', action='store_true', dest='debug',
-                      help="Enable debug output", default=False)
-    parser.add_option('-l', '--local-liblarch', action='store_true',
-                      dest='local_liblarch', default=False,
-                      help="Use local liblarch located in ../liblarch if it is\
-                                                                      posible")
-    parser.add_option('-t', '--title', action='store',
-                      help="Use special title for windows' title")
-    parser.add_option('-v', '--version', action='store_true',
-                      dest='print_version', help="Print GTG's version number",
-                      default=False)
-    (options, args) = parser.parse_args()
-
-    if options.title is not None:
-        info.NAME = options.title
-
-    if options.print_version:
-        print("GTG (Getting Things GNOME!)", info.VERSION)
-        print()
-        print("For more information:", info.URL)
-        sys.exit(0)
-
-    elif not x_is_running():
-        print("Could not open X display")
-        sys.exit(1)
-
-    elif import_liblarch(options.local_liblarch):
-        from GTG import gtg
-        sys.exit(gtg.main(options, args))
-
-
-if __name__ == "__main__":
-    try:
-        main()
-    except KeyboardInterrupt:
-        sys.exit(1)

=== removed file 'profile.py'
--- profile.py	2013-11-25 02:37:46 +0000
+++ profile.py	1970-01-01 00:00:00 +0000
@@ -1,36 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# -----------------------------------------------------------------------------
-# Getting Things GNOME! - a personal organizer for the GNOME desktop
-# Copyright (c) 2008-2013 - Lionel Dricot & Bertrand Rousseau
-#
-# This program is free software: you can redistribute it and/or modify it under
-# the terms of the GNU General Public License as published by the Free Software
-# Foundation, either version 3 of the License, or (at your option) any later
-# version.
-#
-# This program is distributed in the hope that it will be useful, but WITHOUT
-# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
-# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
-# details.
-#
-# You should have received a copy of the GNU General Public License along with
-# this program.  If not, see <http://www.gnu.org/licenses/>.
-# -----------------------------------------------------------------------------
-
-import GTG.gtg
-import cProfile
-import pstats
-from optparse import OptionParser
-
-parser = OptionParser()
-parser.add_option("-d", "--debug",
-               action="store_true", dest="debug", help="enable debug output")
-(options, args) = parser.parse_args()
-
-cProfile.run("GTG.gtg.main(options, args)", filename="gtg.profile")
-
-p = pstats.Stats('gtg.profile')
-p.sort_stats('cumulative').print_stats(15)
-p.sort_stats('time').print_stats(15)
-p.sort_stats('calls').print_stats(15)

=== removed file 'scripts/build_integrity.py'
--- scripts/build_integrity.py	2013-08-28 20:13:59 +0000
+++ scripts/build_integrity.py	1970-01-01 00:00:00 +0000
@@ -1,69 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: UTF-8 -*-
-# Copyright © 2012 Izidor Matušov <[e-mail]
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-import os
-import sys
-import re
-
-exclude_list = ['data/.*', 'po/.*', 'doc/.*', 'AUTHORS', 'CHANGELOG',
-                'LICENSE', 'README', 'gtcli_bash_completion', 'gtg.desktop',
-                'org.gnome.GTG.service', 'setup.py',
-                ]
-
-# Build MANIFEST and also run build action
-if os.system("python setup.py sdist > /dev/null") != 0:
-    print("sdist operation failed")
-    sys.exit(1)
-
-if os.system("python setup.py build > /dev/null") != 0:
-    print("build operation failed")
-    sys.exit(1)
-
-manifest_files = []
-
-for f in open('MANIFEST', 'r'):
-    f = f.strip()
-    if f == "" or f.startswith('#'):
-        continue
-    f = os.path.normpath(f)
-
-    exclude = False
-    for ex in exclude_list:
-        if re.match(ex, f):
-            exclude = True
-            break
-    if exclude:
-        continue
-
-    manifest_files.append(f)
-
-build_files = []
-for root, dirs, files in os.walk('build/'):
-    for f in files:
-        filename = os.path.join(root, f)
-        filename = filename.split('/', 1)[1]
-        if filename.startswith('lib.') or filename.startswith('scripts-'):
-            filename = filename.split('/', 1)[1]
-
-        build_files.append(filename)
-
-missing_files = list(set(manifest_files) - set(build_files))
-if len(missing_files) > 0:
-    missing_files.sort()
-    print("Missing build files:")
-    print("\n".join("\t%s" % f for f in missing_files))
-    sys.exit(1)

=== modified file 'scripts/debug.sh'
--- scripts/debug.sh	2014-03-09 14:48:26 +0000
+++ scripts/debug.sh	2014-03-14 20:44:47 +0000
@@ -9,26 +9,20 @@
 args="--no-crash-handler"
 dataset="default"
 norun=0
-profile=0
 title=""
 
 # Create execution-time data directory if needed
 mkdir -p tmp
 
 # Interpret arguments
-while getopts bdlnps: o
+while getopts bdns: o
 do  case "$o" in
     b)   args="$args --boot-test";;
     d)   args="$args -d";;
-    # Request usage local liblarch if it is possible
-    l)   args="$args -l"
-         liblarchArgs="$liblarchArgs -l"
-        ;;
     n)   norun=1;;
-    p)   profile=1;;
     s)   dataset="$OPTARG";;
     t)   title="$OPTARG";;
-    [?]) echo >&2 "Usage: $0 [-s dataset] [-t title] [-b] [-d] [-l] [-n] [-p]"
+    [?]) echo >&2 "Usage: $0 [-s dataset] [-t title] [-b] [-d] [-l] [-n]"
          exit 1;;
     esac
 done
@@ -57,22 +51,5 @@
 fi
 
 if [ $norun -eq 0 ]; then
-    # Check for liblarch
-    if ! ./GTG/tools/import_liblarch.py $liblarchArgs; then
-        echo
-        echo -n "Download latest liblarch? [y/N] "
-        read answer
-        if [ "$answer" = "y" -o "$answer" = "Y" -o "$answer" = "yes" ]; then
-            git clone https://github.com/liblarch/liblarch ../liblarch
-        else
-            exit 1
-        fi
-    fi
-
-    if [ $profile -eq 1 ]; then
-        python -m cProfile -o gtg.prof ./gtg $args -t "$title"
-        python ./scripts/profile_interpret.sh
-    else
-    ./gtg $args -t "$title"
-    fi
+    ./GTG/gtg $args -t "$title"
 fi

=== removed file 'scripts/man_page_viewer'
--- scripts/man_page_viewer	2010-01-05 09:34:49 +0000
+++ scripts/man_page_viewer	1970-01-01 00:00:00 +0000
@@ -1,12 +0,0 @@
-#!/bin/bash
-
-if [ ! $# -eq 1 ]; then 
-    echo "usage: $0 <man_file_path>"
-    exit 1
-fi
-if [ ! -x "`which groff`" ]; then
-    echo "please install groff"
-    exit 2
-fi
-
-groff -Tascii -man $1 | more

=== removed file 'scripts/profile_interpret.sh'
--- scripts/profile_interpret.sh	2013-08-28 20:13:59 +0000
+++ scripts/profile_interpret.sh	1970-01-01 00:00:00 +0000
@@ -1,4 +0,0 @@
-#!/usr/bin/env python3
-import pstats
-p = pstats.Stats('gtg.prof')
-p.strip_dirs().sort_stats("cumulative").print_stats(20)

=== modified file 'setup.py'
--- setup.py	2014-02-01 07:53:21 +0000
+++ setup.py	2014-03-14 20:44:47 +0000
@@ -18,222 +18,174 @@
 # this program.  If not, see <http://www.gnu.org/licenses/>.
 # -----------------------------------------------------------------------------
 
-from distutils.core     import setup
-from distutils.command.install_data import install_data
+from distutils.core import setup
+from glob import glob
 from subprocess import call
-
-import glob
 import os
+import sys
 
 from GTG import info
 
-### CONSTANTS ################################################################
-
-HELP_DIR = "share/help"
-GLOBAL_ICON_DIR = "share/icons"
-
-### TOOLS ####################################################################
-
-def create_icon_list():
-    fileList = []
-    rootdir = "data/icons"
-    for root, subFolders, files in os.walk(rootdir):
-        dirList = []
-        for file in files:
-            if file.endswith(".png") or file.endswith(".svg"):
-                dirList.append(os.path.join(root, file))
-        if len(dirList)!=0:
-            newroot = root.replace(rootdir + "/", "")
-            fileList.append((os.path.join(GLOBAL_ICON_DIR, newroot), dirList))
-    return fileList
-
-
-def create_userdoc_list():
-    fileList = []
-    rootdir = "doc/userdoc"
-    for root, subFolders, files in os.walk(rootdir):
-        dirList = []
-        for file in files:
-            dirList.append(os.path.join(root, file))
-        if len(dirList)!=0:
-            comps = root.split(os.sep)
-            prefix = os.path.join(comps[0], comps[1], comps[2])+os.sep
-            if root != prefix[:-1]:
-                newroot = root.replace(prefix, "")
+
+def find_packages():
+    """ Generate list of all packages """
+    packages = []
+    for package, __, files in os.walk('GTG'):
+        # Package has to have init file
+        if '__init__.py' not in files:
+            continue
+        # Convert filepath to package name
+        package = package.replace(os.path.sep, '.')
+        packages.append(package)
+    return packages
+
+
+def find_package_data():
+    """ Generate list of data files within a package """
+    packages = {
+        package.replace('.', os.path.sep) for package in find_packages()}
+    package_data = {}
+
+    for folder, __, files in os.walk('GTG'):
+        # Find package
+        closest_package = folder
+        while closest_package and closest_package not in packages:
+            # Try one level up
+            closest_package = os.path.dirname(closest_package)
+
+        if not closest_package:
+            continue
+
+        allowed_extensions = [
+            '', '.gtg-plugin', '.png', '.svg', '.ui', '.html', '.tex', '.txt']
+        is_this_package = folder == closest_package
+        if not is_this_package:
+            allowed_extensions.append('.py')
+
+        for filename in files:
+            ext = os.path.splitext(filename)[-1]
+            if ext not in allowed_extensions:
+                continue
+
+            # Find path relative to package
+            filename = os.path.join(folder, filename)
+            assert filename.startswith(closest_package)
+            filename = filename[len(closest_package + os.path.sep):]
+
+            # Assign data file to package name
+            package_name = closest_package.replace(os.path.sep, '.')
+            if package_name in package_data:
+                package_data[package_name].append(filename)
             else:
-                newroot = ""
-            newroot = os.path.join(HELP_DIR, comps[2], "gtg", newroot)
-            fileList.append((newroot, dirList))
-    fileList.append('doc/release_notes/0.3.1.txt')
-    return fileList
-
-
-def create_data_files():
+                package_data[package_name] = [filename]
+
+    return package_data
+
+
+def compile_mo_files():
+    """ Compile all .po files into .mo files """
+    mo_files = []
+    mo_dir = os.path.join('build', 'po')
+    for po_file in glob('po/*.po'):
+        lang = os.path.splitext(os.path.basename(po_file))[0]
+        mo_file = os.path.join(mo_dir, lang, 'gtg.mo')
+        target_dir = os.path.dirname(mo_file)
+        if not os.path.isdir(target_dir):
+            os.makedirs(target_dir)
+
+        try:
+            return_code = call(['msgfmt', '-o', mo_file, po_file])
+        except OSError:
+            sys.stderr.write(
+                'Translation not available, please install gettext\n')
+            break
+
+        if return_code:
+            raise Warning('Error when building locales')
+            continue
+
+        install_folder = os.path.join('share', 'locale', lang, 'LC_MESSAGES')
+        mo_files.append((install_folder, [mo_file]))
+
+    return mo_files
+
+
+def find_icons(src_folder, dest_folder, allowed_extensions):
+    """ Find all icons in the folder """
+    data_list = []
+
+    for folder, __, files in os.walk(src_folder):
+        assert folder.startswith(src_folder)
+        install_folder = dest_folder + folder[len(src_folder):]
+        file_list = []
+        for filename in files:
+            ext = os.path.splitext(filename)[-1]
+            if ext in allowed_extensions:
+                filename = os.path.join(folder, filename)
+                file_list.append(filename)
+
+        if file_list:
+            data_list.append((install_folder, file_list))
+
+    return data_list
+
+
+def find_user_help():
+    """ Find all files for user help """
+    help_files = []
+
+    for folder, __, files in os.walk('docs/userdoc'):
+        folders = folder.split(os.path.sep)[2:]
+        if not folders:
+            continue
+        folders.insert(1, 'gtg')
+        install_folder = os.path.join('share', 'help', *folders)
+
+        help_files.append((
+            install_folder,
+            [os.path.join(folder, filename) for filename in files],
+        ))
+
+    return help_files
+
+
+def find_data_files():
+    """ Generate list of data files for installing in share folder """
     data_files = []
-    # icons
-    icons = create_icon_list()
-    data_files.extend(icons)
-    # gtg .desktop icon
-    data_files.append(('share/icons/hicolor/16x16/apps',
-                       ['data/icons/hicolor/16x16/apps/gtg.png']))
-    data_files.append(('share/icons/hicolor/22x22/apps',
-                       ['data/icons/hicolor/22x22/apps/gtg.png']))
-    data_files.append(('share/icons/hicolor/24x24/apps',
-                       ['data/icons/hicolor/24x24/apps/gtg.png']))
-    data_files.append(('share/icons/hicolor/32x32/apps',
-                       ['data/icons/hicolor/32x32/apps/gtg.png']))
-    data_files.append(('share/icons/hicolor/scalable/apps',
-                       ['data/icons/hicolor/scalable/apps/gtg.svg']))
-    # documentation
-    helpfiles = create_userdoc_list()
-    data_files.extend(helpfiles)
-    # misc
-    data_files.append(('share/applications', ['gtg.desktop']))
-    data_files.append(('share/dbus-1/services', ['org.gnome.GTG.service']))
-    data_files.append(('share/man/man1',
-                       ['doc/gtg.1', 'doc/gtcli.1', 'doc/gtg_new_task.1']))
-
-    # bash completion
-    data_files.append(('share/gtg/', ['gtcli_bash_completion']))
-
-    # appdata file
-    data_files.append(('share/appdata/', ['gtg.appdata.xml']))
+
+    # .mo files
+    data_files.extend(compile_mo_files())
+
+    # Icons
+    data_files.extend(
+        find_icons('data/icons', 'share/icons', ['.png', '.svg']))
+
+    # User docs
+    data_files.extend(find_user_help())
+
+    # Generate man files and include them
+    os.system('sphinx-build -b man docs/source build/docs')
+    data_files.append(('share/man/man1', glob('build/docs/*.1')))
+
+    # Misc files
+    data_files.extend([
+        ('share/applications', ['data/gtg.desktop']),
+        ('share/appdata/', ['data/gtg.appdata.xml']),
+        ('share/dbus-1/services', ['data/org.gnome.GTG.service']),
+        ('share/gtg/', ['data/gtcli_bash_completion']),
+    ])
+
     return data_files
 
 
-#### TRANSLATIONS(from pyroom setup.py) ######################################
-
-PO_DIR = 'po'
-MO_DIR = os.path.join('build', 'po')
-
-for po in glob.glob(os.path.join(PO_DIR, '*.po')):
-    lang = os.path.basename(po[:-3])
-    mo = os.path.join(MO_DIR, lang, 'gtg.mo')
-    target_dir = os.path.dirname(mo)
-    if not os.path.isdir(target_dir):
-        os.makedirs(target_dir)
-    try:
-        return_code = call(['msgfmt', '-o', mo, po])
-    except OSError:
-        print('Translation not available, please install gettext')
-        break
-    if return_code:
-        raise Warning('Error when building locales')
-
-
-class InstallData(install_data):
-
-    def run(self):
-        self.data_files.extend(self.find_mo_files())
-        install_data.run(self)
-
-    def find_mo_files(self):
-        data_files = []
-        for mo in glob.glob(os.path.join(MO_DIR, '*', 'gtg.mo')):
-            lang = os.path.basename(os.path.dirname(mo))
-            dest = os.path.join('share', 'locale', lang, 'LC_MESSAGES')
-            data_files.append((dest, [mo]))
-        return data_files
-
-### SETUP SCRIPT ##############################################################
-
-author = 'The GTG Team'
-
 setup(
-  name = 'gtg',
-  version = info.VERSION,
-  url = info.URL,
-  author = author,
-  author_email = info.EMAIL,
-  description = info.SHORT_DESCRIPTION,
-  packages = [
-    'GTG',
-    'GTG.backends',
-    'GTG.backends.rtm',
-    'GTG.core',
-    'GTG.core.plugins',
-    'GTG.gtk',
-    'GTG.gtk.editor',
-    'GTG.gtk.browser',
-    'GTG.gtk.backends_dialog',
-    'GTG.gtk.backends_dialog.parameters_ui',
-    'GTG.tools',
-    'GTG.plugins',
-    'GTG.plugins.bugzilla',
-    'GTG.plugins.export',
-    'GTG.plugins.geolocalized_tasks',
-    'GTG.plugins.hamster',
-    'GTG.plugins.notification_area',
-    'GTG.plugins.task_reaper',
-    'GTG.plugins.send_email',
-    'GTG.plugins.tomboy',
-    'GTG.plugins.urgency_color',
-    'GTG.plugins.untouched_tasks',
-    'GTG.plugins.not_today',
-    ],
-  package_data = {
-    'GTG.core.plugins': ['pluginmanager.ui'],
-    'GTG.gtk': [
-        'preferences.ui',
-        'plugins.ui',
-        'deletion.ui',
-        'backends_dialog.ui',
-        ],
-    'GTG.gtk.browser': ['taskbrowser.ui', 'modifytags_dialog.ui'],
-    'GTG.gtk.editor': ['taskeditor.ui'],
-    'GTG.plugins': [
-        'bugzilla.gtg-plugin',
-        'export.gtg-plugin',
-        'geolocalized-tasks.gtg-plugin',
-        'hamster.gtg-plugin',
-        'notification-area.gtg-plugin',
-        'task-reaper.gtg-plugin',
-        'send-email.gtg-plugin',
-        'tomboy.gtg-plugin',
-        'urgency-color.gtg-plugin',
-        'not-today.gtg-plugin',
-        'untouched-tasks.gtg-plugin',
-        ],
-    'GTG.plugins.export': ['export.ui',
-                          './export_templates/description_pocketmod.py',
-                          './export_templates/description_sexy.py',
-                          './export_templates/description_simple.py',
-                          './export_templates/description_statusrpt.py',
-                          './export_templates/description_textual.py',
-                          './export_templates/graphics_pocketmod.svg',
-                          './export_templates/script_pocketmod',
-                          './export_templates/template_pocketmod.tex',
-                          './export_templates/template_sexy.html',
-                          './export_templates/template_simple.html',
-                          './export_templates/template_statusrpt.txt',
-                          './export_templates/template_textual.txt',
-                          './export_templates/thumbnail_pocketmod.png',
-                          './export_templates/thumbnail_sexy.png',
-                          './export_templates/thumbnail_simple.png',
-                          './export_templates/thumbnail_statusrpt.png',
-                          './export_templates/thumbnail_textual.png',
-                          ],
-    'GTG.plugins.geolocalized_tasks': ['geolocalized.ui',
-                          'icons/hicolor/24x24/geolocalization.png',
-                          'icons/hicolor/16x16/assign-location.png',
-                          'icons/hicolor/svg/assign-location.svg',
-                          'icons/hicolor/svg/geolocalization.svg'],
-    'GTG.plugins.tomboy': ['tomboy.ui'],
-    'GTG.plugins.hamster': ['prefs.ui',
-                            'icons/hicolor/32x32/hamster-activity-start.png',
-                            'icons/hicolor/32x32/hamster-activity-stop.png',
-                            'icons/hicolor/svg/hamster-activity-start.svg',
-                            'icons/hicolor/svg/hamster-activity-stop.svg'],
-    'GTG.plugins.task_reaper': ['reaper.ui'],
-    'GTG.plugins.notification_area': ['notification_area.ui',
-                     './data/icons/hicolor/22x22/apps/gtg_need_attention.png',
-            './data/icons/ubuntu-mono-dark/22x22/apps/gtg_need_attention.svg',
-           './data/icons/ubuntu-mono-light/22x22/apps/gtg_need_attention.svg',
-                            ],
-    'GTG.plugins.urgency_color': ['preferences.ui'],
-    'GTG.plugins.untouched_tasks': ['untouchedTasks.ui'],
-   },
-  data_files = create_data_files(),
-  scripts=['gtg', 'gtcli', 'gtg_new_task'],
-  cmdclass={'install_data': InstallData},
+    name='gtg',
+    version=info.VERSION,
+    url=info.URL,
+    author='The GTG Team',
+    author_email=info.EMAIL,
+    description=info.SHORT_DESCRIPTION,
+    packages=find_packages(),
+    scripts=['GTG/gtg', 'GTG/gtcli', 'GTG/gtg_new_task'],
+    data_files=find_data_files(),
 )