From 9290cc1f7a49edcd121ec961dbbaec873c143af6 Mon Sep 17 00:00:00 2001 From: Calum Lind Date: Thu, 20 Feb 2014 17:24:11 +0000 Subject: [PATCH] Fix building the code documentation with sphinx Updated Sphinx conf and tested with Sphinx 1.2.1 Moved webui gen_gettext script Fixed docstring warning in code Renamed console update-tracker to update_tracker --- deluge/config.py | 2 + deluge/core/core.py | 3 +- deluge/core/torrent.py | 20 +- deluge/core/torrentmanager.py | 4 +- deluge/ui/Win32IconImagePlugin.py | 28 +- .../{update-tracker.py => update_tracker.py} | 4 +- deluge/ui/gtkui/path_combo_chooser.py | 4 +- deluge/ui/gtkui/preferences.py | 3 +- deluge/ui/tracker_icons.py | 3 +- docs/source/conf.py | 54 +++- docs/source/index.rst | 7 +- docs/source/modules/__rpcapi.rst | 9 - docs/source/modules/_libtorrent.rst | 9 - docs/source/modules/bencode.rst | 9 - docs/source/modules/common.rst | 5 - docs/source/modules/component.rst | 9 - docs/source/modules/config.rst | 11 - docs/source/modules/configmanager.rst | 9 - docs/source/modules/core/alertmanager.rst | 9 - docs/source/modules/core/authmanager.rst | 9 - docs/source/modules/core/autoadd.rst | 9 - docs/source/modules/core/core.rst | 9 - docs/source/modules/core/daemon.rst | 9 - docs/source/modules/core/eventmanager.rst | 9 - docs/source/modules/core/filtermanager.rst | 9 - docs/source/modules/core/oldstateupgrader.rst | 9 - docs/source/modules/core/pluginmanager.rst | 9 - .../modules/core/preferencesmanager.rst | 9 - docs/source/modules/core/rpcserver.rst | 9 - docs/source/modules/core/torrent.rst | 9 - docs/source/modules/core/torrentmanager.rst | 9 - docs/source/modules/deluge.core.rst | 102 ++++++ docs/source/modules/deluge.plugins.rst | 30 ++ docs/source/modules/deluge.rst | 159 ++++++++++ .../modules/deluge.ui.console.commands.rst | 166 ++++++++++ .../modules/deluge.ui.console.modes.rst | 134 ++++++++ docs/source/modules/deluge.ui.console.rst | 62 ++++ docs/source/modules/deluge.ui.gtkui.rst | 294 ++++++++++++++++++ docs/source/modules/deluge.ui.rst | 95 ++++++ docs/source/modules/deluge.ui.web.rst | 62 ++++ docs/source/modules/error.rst | 9 - docs/source/modules/event.rst | 9 - docs/source/modules/httpdownloader.rst | 9 - docs/source/modules/log.rst | 9 - docs/source/modules/main.rst | 9 - docs/source/modules/maketorrent.rst | 9 - docs/source/modules/metafile.rst | 9 - docs/source/modules/pluginmanagerbase.rst | 9 - docs/source/modules/plugins/init.rst | 9 - docs/source/modules/plugins/pluginbase.rst | 9 - docs/source/modules/rencode.rst | 9 - docs/source/modules/ui/client.rst | 9 - docs/source/modules/ui/common.rst | 5 - docs/source/modules/ui/console/colors.rst | 9 - .../modules/ui/console/commands/add.rst | 9 - .../modules/ui/console/commands/config.rst | 9 - .../modules/ui/console/commands/connect.rst | 9 - .../modules/ui/console/commands/debug.rst | 9 - .../modules/ui/console/commands/halt.rst | 9 - .../modules/ui/console/commands/help.rst | 9 - .../modules/ui/console/commands/info.rst | 9 - .../modules/ui/console/commands/pause.rst | 9 - .../modules/ui/console/commands/quit.rst | 9 - .../modules/ui/console/commands/recheck.rst | 9 - .../modules/ui/console/commands/resume.rst | 9 - .../source/modules/ui/console/commands/rm.rst | 9 - docs/source/modules/ui/console/eventlog.rst | 9 - docs/source/modules/ui/console/main.rst | 9 - docs/source/modules/ui/console/screen.rst | 9 - docs/source/modules/ui/console/statusbars.rst | 9 - docs/source/modules/ui/coreconfig.rst | 9 - docs/source/modules/ui/countries.rst | 9 - docs/source/modules/ui/gtkui/aboutdialog.rst | 9 - .../modules/ui/gtkui/addtorrentdialog.rst | 9 - docs/source/modules/ui/gtkui/common.rst | 9 - .../modules/ui/gtkui/connectionmanager.rst | 9 - .../modules/ui/gtkui/createtorrentdialog.rst | 9 - docs/source/modules/ui/gtkui/details_tab.rst | 9 - docs/source/modules/ui/gtkui/dialogs.rst | 9 - .../modules/ui/gtkui/edittrackersdialog.rst | 9 - docs/source/modules/ui/gtkui/files_tab.rst | 9 - .../modules/ui/gtkui/filtertreeview.rst | 9 - docs/source/modules/ui/gtkui/ipcinterface.rst | 9 - docs/source/modules/ui/gtkui/listview.rst | 9 - docs/source/modules/ui/gtkui/mainwindow.rst | 9 - docs/source/modules/ui/gtkui/menubar.rst | 9 - .../modules/ui/gtkui/new_release_dialog.rst | 9 - docs/source/modules/ui/gtkui/notification.rst | 9 - docs/source/modules/ui/gtkui/options_tab.rst | 9 - docs/source/modules/ui/gtkui/peers_tab.rst | 9 - .../source/modules/ui/gtkui/pluginmanager.rst | 9 - docs/source/modules/ui/gtkui/preferences.rst | 9 - .../modules/ui/gtkui/queuedtorrents.rst | 9 - .../modules/ui/gtkui/removetorrentdialog.rst | 9 - docs/source/modules/ui/gtkui/sidebar.rst | 9 - docs/source/modules/ui/gtkui/status_tab.rst | 9 - docs/source/modules/ui/gtkui/statusbar.rst | 9 - docs/source/modules/ui/gtkui/systemtray.rst | 9 - docs/source/modules/ui/gtkui/toolbar.rst | 9 - .../modules/ui/gtkui/torrentdetails.rst | 9 - docs/source/modules/ui/gtkui/torrentview.rst | 9 - docs/source/modules/ui/sessionproxy.rst | 9 - docs/source/modules/ui/tracker_icons.rst | 9 - docs/source/modules/ui/ui.rst | 9 - docs/source/modules/ui/web/auth.rst | 5 - docs/source/modules/ui/web/common.rst | 5 - docs/source/modules/ui/web/gen_gettext.rst | 9 - docs/source/modules/ui/web/json_api.rst | 5 - docs/source/modules/ui/web/pluginmanager.rst | 9 - docs/source/modules/ui/web/server.rst | 9 - docs/source/modules/ui/web/web.rst | 9 - .../web/gen_gettext.py => gen_web_gettext.py | 1 - setup.py | 27 +- 113 files changed, 1203 insertions(+), 862 deletions(-) rename deluge/ui/console/commands/{update-tracker.py => update_tracker.py} (96%) delete mode 100644 docs/source/modules/__rpcapi.rst delete mode 100644 docs/source/modules/_libtorrent.rst delete mode 100644 docs/source/modules/bencode.rst delete mode 100644 docs/source/modules/common.rst delete mode 100644 docs/source/modules/component.rst delete mode 100644 docs/source/modules/config.rst delete mode 100644 docs/source/modules/configmanager.rst delete mode 100644 docs/source/modules/core/alertmanager.rst delete mode 100644 docs/source/modules/core/authmanager.rst delete mode 100644 docs/source/modules/core/autoadd.rst delete mode 100644 docs/source/modules/core/core.rst delete mode 100644 docs/source/modules/core/daemon.rst delete mode 100644 docs/source/modules/core/eventmanager.rst delete mode 100644 docs/source/modules/core/filtermanager.rst delete mode 100644 docs/source/modules/core/oldstateupgrader.rst delete mode 100644 docs/source/modules/core/pluginmanager.rst delete mode 100644 docs/source/modules/core/preferencesmanager.rst delete mode 100644 docs/source/modules/core/rpcserver.rst delete mode 100644 docs/source/modules/core/torrent.rst delete mode 100644 docs/source/modules/core/torrentmanager.rst create mode 100644 docs/source/modules/deluge.core.rst create mode 100644 docs/source/modules/deluge.plugins.rst create mode 100644 docs/source/modules/deluge.rst create mode 100644 docs/source/modules/deluge.ui.console.commands.rst create mode 100644 docs/source/modules/deluge.ui.console.modes.rst create mode 100644 docs/source/modules/deluge.ui.console.rst create mode 100644 docs/source/modules/deluge.ui.gtkui.rst create mode 100644 docs/source/modules/deluge.ui.rst create mode 100644 docs/source/modules/deluge.ui.web.rst delete mode 100644 docs/source/modules/error.rst delete mode 100644 docs/source/modules/event.rst delete mode 100644 docs/source/modules/httpdownloader.rst delete mode 100644 docs/source/modules/log.rst delete mode 100644 docs/source/modules/main.rst delete mode 100644 docs/source/modules/maketorrent.rst delete mode 100644 docs/source/modules/metafile.rst delete mode 100644 docs/source/modules/pluginmanagerbase.rst delete mode 100644 docs/source/modules/plugins/init.rst delete mode 100644 docs/source/modules/plugins/pluginbase.rst delete mode 100644 docs/source/modules/rencode.rst delete mode 100644 docs/source/modules/ui/client.rst delete mode 100644 docs/source/modules/ui/common.rst delete mode 100644 docs/source/modules/ui/console/colors.rst delete mode 100644 docs/source/modules/ui/console/commands/add.rst delete mode 100644 docs/source/modules/ui/console/commands/config.rst delete mode 100644 docs/source/modules/ui/console/commands/connect.rst delete mode 100644 docs/source/modules/ui/console/commands/debug.rst delete mode 100644 docs/source/modules/ui/console/commands/halt.rst delete mode 100644 docs/source/modules/ui/console/commands/help.rst delete mode 100644 docs/source/modules/ui/console/commands/info.rst delete mode 100644 docs/source/modules/ui/console/commands/pause.rst delete mode 100644 docs/source/modules/ui/console/commands/quit.rst delete mode 100644 docs/source/modules/ui/console/commands/recheck.rst delete mode 100644 docs/source/modules/ui/console/commands/resume.rst delete mode 100644 docs/source/modules/ui/console/commands/rm.rst delete mode 100644 docs/source/modules/ui/console/eventlog.rst delete mode 100644 docs/source/modules/ui/console/main.rst delete mode 100644 docs/source/modules/ui/console/screen.rst delete mode 100644 docs/source/modules/ui/console/statusbars.rst delete mode 100644 docs/source/modules/ui/coreconfig.rst delete mode 100644 docs/source/modules/ui/countries.rst delete mode 100644 docs/source/modules/ui/gtkui/aboutdialog.rst delete mode 100644 docs/source/modules/ui/gtkui/addtorrentdialog.rst delete mode 100644 docs/source/modules/ui/gtkui/common.rst delete mode 100644 docs/source/modules/ui/gtkui/connectionmanager.rst delete mode 100644 docs/source/modules/ui/gtkui/createtorrentdialog.rst delete mode 100644 docs/source/modules/ui/gtkui/details_tab.rst delete mode 100644 docs/source/modules/ui/gtkui/dialogs.rst delete mode 100644 docs/source/modules/ui/gtkui/edittrackersdialog.rst delete mode 100644 docs/source/modules/ui/gtkui/files_tab.rst delete mode 100644 docs/source/modules/ui/gtkui/filtertreeview.rst delete mode 100644 docs/source/modules/ui/gtkui/ipcinterface.rst delete mode 100644 docs/source/modules/ui/gtkui/listview.rst delete mode 100644 docs/source/modules/ui/gtkui/mainwindow.rst delete mode 100644 docs/source/modules/ui/gtkui/menubar.rst delete mode 100644 docs/source/modules/ui/gtkui/new_release_dialog.rst delete mode 100644 docs/source/modules/ui/gtkui/notification.rst delete mode 100644 docs/source/modules/ui/gtkui/options_tab.rst delete mode 100644 docs/source/modules/ui/gtkui/peers_tab.rst delete mode 100644 docs/source/modules/ui/gtkui/pluginmanager.rst delete mode 100644 docs/source/modules/ui/gtkui/preferences.rst delete mode 100644 docs/source/modules/ui/gtkui/queuedtorrents.rst delete mode 100644 docs/source/modules/ui/gtkui/removetorrentdialog.rst delete mode 100644 docs/source/modules/ui/gtkui/sidebar.rst delete mode 100644 docs/source/modules/ui/gtkui/status_tab.rst delete mode 100644 docs/source/modules/ui/gtkui/statusbar.rst delete mode 100644 docs/source/modules/ui/gtkui/systemtray.rst delete mode 100644 docs/source/modules/ui/gtkui/toolbar.rst delete mode 100644 docs/source/modules/ui/gtkui/torrentdetails.rst delete mode 100644 docs/source/modules/ui/gtkui/torrentview.rst delete mode 100644 docs/source/modules/ui/sessionproxy.rst delete mode 100644 docs/source/modules/ui/tracker_icons.rst delete mode 100644 docs/source/modules/ui/ui.rst delete mode 100644 docs/source/modules/ui/web/auth.rst delete mode 100644 docs/source/modules/ui/web/common.rst delete mode 100644 docs/source/modules/ui/web/gen_gettext.rst delete mode 100644 docs/source/modules/ui/web/json_api.rst delete mode 100644 docs/source/modules/ui/web/pluginmanager.rst delete mode 100644 docs/source/modules/ui/web/server.rst delete mode 100644 docs/source/modules/ui/web/web.rst rename deluge/ui/web/gen_gettext.py => gen_web_gettext.py (99%) diff --git a/deluge/config.py b/deluge/config.py index 2e2484a2c..017d970a6 100644 --- a/deluge/config.py +++ b/deluge/config.py @@ -83,9 +83,11 @@ def prop(func): The decorated function is expected to return a dictionary containing one or more of the following pairs: + fget - function for getting attribute value fset - function for setting attribute value fdel - function for deleting attribute + This can be conveniently constructed by the locals() builtin function; see: http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/205183 diff --git a/deluge/core/core.py b/deluge/core/core.py index eb442e7d7..44218440d 100644 --- a/deluge/core/core.py +++ b/deluge/core/core.py @@ -891,8 +891,7 @@ class Core(component.Component): """ Returns the number of free bytes at path - :param path: the path to check free space at, if None, use the default - download location + :param path: the path to check free space at, if None, use the default download location :type path: string :returns: the number of free bytes at path diff --git a/deluge/core/torrent.py b/deluge/core/torrent.py index c59e68b35..20db764e7 100644 --- a/deluge/core/torrent.py +++ b/deluge/core/torrent.py @@ -647,14 +647,16 @@ class Torrent(object): """Get the files this torrent contains. Returns: - list of dicts: The files. + list of dict: The files. - [{ + The format for the file dict:: + + { "index": int, "path": str, "size": int, - "offset": int, - }] + "offset": int + } """ if not self.has_metadata: return [] @@ -675,17 +677,19 @@ class Torrent(object): A list of peers and various information about them. Returns: - list of dicts: The peers. + list of dict: The peers. - [{ + The format for the peer dict:: + + { "client": str, "country": str, "down_speed": int, "ip": str, "progress": float, "seed": bool, - "up_speed": int, - }] + "up_speed": int + } """ ret = [] peers = self.handle.get_peer_info() diff --git a/deluge/core/torrentmanager.py b/deluge/core/torrentmanager.py index d73f4c84f..6b00a9069 100644 --- a/deluge/core/torrentmanager.py +++ b/deluge/core/torrentmanager.py @@ -122,6 +122,7 @@ class TorrentState: self.owner = owner self.name = name + class TorrentManagerState: def __init__(self): self.torrents = [] @@ -363,7 +364,6 @@ class TorrentManager(component.Component): options["owner"] = state.owner options["name"] = state.name - torrent_info = self.get_torrent_info_from_file( os.path.join(self.state_dir, state.torrent_id + ".torrent")) if torrent_info: @@ -1266,7 +1266,7 @@ class TorrentManager(component.Component): :param keys: the keys to get the status on :type keys: list of str :param diff: if True, will return a diff of the changes since the last - call to get_status based on the session_id + call to get_status based on the session_id :type diff: bool :returns: a status dictionary for the equested torrents. diff --git a/deluge/ui/Win32IconImagePlugin.py b/deluge/ui/Win32IconImagePlugin.py index 17c463caf..5d0820eda 100644 --- a/deluge/ui/Win32IconImagePlugin.py +++ b/deluge/ui/Win32IconImagePlugin.py @@ -5,18 +5,18 @@ # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. -# You may obtain a copy of the License at +# You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT -# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the -# License for the specific language governing permissions and limitations +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations # under the License. # # $Id$ """Alternate PIL plugin for dealing with Microsoft .ico files. Handles XOR -transparency masks, XP style 8bit alpha channels and Vista style PNG image +transparency masks, XP style 8bit alpha channels and Vista style PNG image parts. >>> import PIL.Image @@ -39,9 +39,9 @@ Icon format references: Example icon to test with `down.ico`_ -.. _Image-SIG http://mail.python.org/pipermail/image-sig/2008-May/004986.html -.. _django snippet http://www.djangosnippets.org/snippets/1287/ -.. _down.ico http://www.axialis.com/tutorials/iw/down.ico +.. _Image-SIG: http://mail.python.org/pipermail/image-sig/2008-May/004986.html +.. _django snippet: http://www.djangosnippets.org/snippets/1287/ +.. _down.ico: http://www.axialis.com/tutorials/iw/down.ico """ import logging @@ -85,7 +85,7 @@ class Win32IcoFile (object): directory[j] = 256 icon_header = dict(zip(dir_fields, directory)) icon_header['color_depth'] = ( - icon_header['bpp'] or + icon_header['bpp'] or (icon_header['nb_color'] == 16 and 4)) icon_header['dim'] = (icon_header['width'], icon_header['height']) self.entry.append(icon_header) @@ -196,7 +196,7 @@ class Win32IcoFile (object): w += 32 - (im.size[0] % 32) # the total mask data is padded row size * height / bits per char total_bytes = long((w * im.size[1]) / 8) - log.debug("tot=%d, off=%d, w=%d, size=%d", + log.debug("tot=%d, off=%d, w=%d, size=%d", len(data), and_mask_offset, w, total_bytes) self.buf.seek(and_mask_offset) @@ -225,7 +225,7 @@ class Win32IcoFile (object): def __repr__ (self): s = 'Microsoft Icon: %d images (max %dx%d %dbpp)' % ( - len(self.entry), self.entry[0]['width'], self.entry[0]['height'], + len(self.entry), self.entry[0]['width'], self.entry[0]['height'], self.entry[0]['bpp']) return s #end __repr__ @@ -236,10 +236,10 @@ class Win32IconImageFile (PIL.ImageFile.ImageFile): """ PIL read-only image support for Microsoft .ico files. - By default the largest resolution image in the file will be loaded. This can + By default the largest resolution image in the file will be loaded. This can be changed by altering the 'size' attribute before calling 'load'. - The info dictionary has a key 'sizes' that is a list of the sizes available + The info dictionary has a key 'sizes' that is a list of the sizes available in the icon file. Handles classic, XP and Vista icon formats. diff --git a/deluge/ui/console/commands/update-tracker.py b/deluge/ui/console/commands/update_tracker.py similarity index 96% rename from deluge/ui/console/commands/update-tracker.py rename to deluge/ui/console/commands/update_tracker.py index a4aa880e1..897ddc31a 100644 --- a/deluge/ui/console/commands/update-tracker.py +++ b/deluge/ui/console/commands/update_tracker.py @@ -43,7 +43,7 @@ from optparse import make_option class Command(BaseCommand): """Update tracker for torrent(s)""" - usage = "Usage: update-tracker [ * | [ ...] ]" + usage = "Usage: update_tracker [ * | [ ...] ]" aliases = ['reannounce'] def handle(self, *args, **options): @@ -53,7 +53,7 @@ class Command(BaseCommand): return if len(args) > 0 and args[0].lower() == '*': args = [""] - + torrent_ids = [] for arg in args: torrent_ids.extend(self.console.match_torrent(arg)) diff --git a/deluge/ui/gtkui/path_combo_chooser.py b/deluge/ui/gtkui/path_combo_chooser.py index 8c2f304f0..c45963413 100755 --- a/deluge/ui/gtkui/path_combo_chooser.py +++ b/deluge/ui/gtkui/path_combo_chooser.py @@ -249,8 +249,8 @@ class ValueList(object): """ Handles changes to the row selection. - :param next: the direction to change selection. None means no change. True means down - and False means up. + :param next: the direction to change selection. True means down and False means up. + None means no change. :type next: boolean/None :param path: the current path. If None, the currently selected path is used. :type path: tuple diff --git a/deluge/ui/gtkui/preferences.py b/deluge/ui/gtkui/preferences.py index accc1e862..13da8ea46 100644 --- a/deluge/ui/gtkui/preferences.py +++ b/deluge/ui/gtkui/preferences.py @@ -535,8 +535,7 @@ class Preferences(component.Component): """ Sets all altered config values in the core. - :param hide: bool, if True, will not re-show the dialog and will hide - it instead + :param hide: bool, if True, will not re-show the dialog and will hide it instead """ try: from hashlib import sha1 as sha_hash diff --git a/deluge/ui/tracker_icons.py b/deluge/ui/tracker_icons.py index 0c0f71dac..adb8db315 100644 --- a/deluge/ui/tracker_icons.py +++ b/deluge/ui/tracker_icons.py @@ -555,7 +555,7 @@ def url_to_host(url): :param url: the URL in question :type url: string :returns: the host of the given URL - :rtype:string + :rtype: string """ return urlparse(url).hostname @@ -569,6 +569,7 @@ def host_to_icon_name(host, mimetype): :type mimetype: string :returns: the icon's filename :rtype: string + """ return host+'.'+mimetype_to_extension(mimetype) diff --git a/docs/source/conf.py b/docs/source/conf.py index 392cee1a5..9af04754e 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,7 +1,6 @@ # -*- coding: utf-8 -*- # -# deluge documentation build configuration file, created by -# sphinx-quickstart on Tue Nov 4 18:24:06 2008. +# Deluge documentation build configuration file # # This file is execfile()d with the current directory set to its containing dir. # @@ -13,18 +12,49 @@ import sys, os import deluge.common +from version import get_version +from datetime import date # If your extensions are in another directory, add it here. If the directory # is relative to the documentation root, use os.path.abspath to make it # absolute, like shown here. -sys.path.append(os.path.abspath(os.path.dirname(__file__ + "../../"))) +sys.path.append(os.path.abspath(os.path.dirname(__file__ + '../../'))) + +class Mock(object): + + __all__ = [] + + def __init__(self, *args, **kwargs): + pass + + def __call__(self, *args, **kwargs): + return Mock() + + @classmethod + def __getattr__(cls, name): + if name in ('__file__', '__path__'): + return '/dev/null' + elif name[0] == name[0].upper(): + mockType = type(name, (), {}) + mockType.__module__ = __name__ + return mockType + else: + return Mock() + +MOCK_MODULES = ['deluge.ui.languages', 'deluge.ui.countries', 'deluge.ui.gtkui.gtkui', + 'deluge.libtorrent', 'psyco', 'rencode', 'win32file', 'win32event', + 'win32gui', 'win32api', 'win32con', '_winreg'] + +for mod_name in MOCK_MODULES: + sys.modules[mod_name] = Mock() + # General configuration # --------------------- # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest'] +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinxcontrib.napoleon'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -37,20 +67,17 @@ master_doc = 'index' # General substitutions. project = 'Deluge' -copyright = '2008-2010, Deluge Team' +current_year = date.today().year +copyright = '2008-%s, Deluge Team' % current_year # The default replacements for |version| and |release|, also used in various # other places throughout the built documents. # -def find_version(): - f = open("../../setup.py", "r") - for line in f: - if " version = " in line: - return line.strip().replace("\"", "").replace(" ", "").replace(",", "").split("=")[1] - # The short X.Y version. -version = find_version() +version = get_version(prefix='deluge-', suffix='.dev0') +# remove the created file by get_version +os.remove('RELEASE-VERSION') # The full version, including alpha/beta/rc tags. release = version @@ -66,6 +93,7 @@ today_fmt = '%B %d, %Y' # List of directories, relative to source directories, that shouldn't be searched # for source files. #exclude_dirs = [] +exclude_pattern = ['deluge/_libtorrent.py', 'deluge/__rpcapi.py'] # The reST default role (used for this markup: `text`) to use for all documents. #default_role = None @@ -112,7 +140,7 @@ html_style = 'default.css' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +# html_static_path = ['_static'] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. diff --git a/docs/source/index.rst b/docs/source/index.rst index 03ac3e1d1..76f46180d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -2,14 +2,14 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Deluge's documentation! +Welcome to Deluge's Documentation! ================================== Contents: .. toctree:: :maxdepth: 2 - + Core Interfaces @@ -28,6 +28,3 @@ Modules :glob: modules/* - modules/*/* - modules/*/*/* - modules/*/*/*/* diff --git a/docs/source/modules/__rpcapi.rst b/docs/source/modules/__rpcapi.rst deleted file mode 100644 index e89a4ca9d..000000000 --- a/docs/source/modules/__rpcapi.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.__rpcapi` -============================================================================== - -.. automodule:: deluge.__rpcapi - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/_libtorrent.rst b/docs/source/modules/_libtorrent.rst deleted file mode 100644 index a80ca5b2a..000000000 --- a/docs/source/modules/_libtorrent.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge._libtorrent` -============================================================================== - -.. automodule:: deluge._libtorrent - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/bencode.rst b/docs/source/modules/bencode.rst deleted file mode 100644 index afb07f3c2..000000000 --- a/docs/source/modules/bencode.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.bencode` -============================================================================== - -.. automodule:: deluge.bencode - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/common.rst b/docs/source/modules/common.rst deleted file mode 100644 index a93f58eb1..000000000 --- a/docs/source/modules/common.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`deluge.common` -==================== - -.. automodule:: deluge.common - :members: diff --git a/docs/source/modules/component.rst b/docs/source/modules/component.rst deleted file mode 100644 index 1aa6391e7..000000000 --- a/docs/source/modules/component.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.component` -============================================================================== - -.. automodule:: deluge.component - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/config.rst b/docs/source/modules/config.rst deleted file mode 100644 index 8c97ef200..000000000 --- a/docs/source/modules/config.rst +++ /dev/null @@ -1,11 +0,0 @@ -:mod:`deluge.config` -==================== - -.. automodule:: deluge.config -.. autoclass:: Config - :show-inheritance: - :members: - :undoc-members: - - .. automethod:: __setitem__ - .. automethod:: __getitem__ diff --git a/docs/source/modules/configmanager.rst b/docs/source/modules/configmanager.rst deleted file mode 100644 index 9b21c66a5..000000000 --- a/docs/source/modules/configmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.configmanager` -============================================================================== - -.. automodule:: deluge.configmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/alertmanager.rst b/docs/source/modules/core/alertmanager.rst deleted file mode 100644 index 074304aab..000000000 --- a/docs/source/modules/core/alertmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.alertmanager` -============================================================================== - -.. automodule:: deluge.core.alertmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/authmanager.rst b/docs/source/modules/core/authmanager.rst deleted file mode 100644 index afe26390f..000000000 --- a/docs/source/modules/core/authmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.authmanager` -============================================================================== - -.. automodule:: deluge.core.authmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/autoadd.rst b/docs/source/modules/core/autoadd.rst deleted file mode 100644 index 777da55e1..000000000 --- a/docs/source/modules/core/autoadd.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.autoadd` -============================================================================== - -.. automodule:: deluge.core.autoadd - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/core.rst b/docs/source/modules/core/core.rst deleted file mode 100644 index cb87feac1..000000000 --- a/docs/source/modules/core/core.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.core` -============================================================================== - -.. automodule:: deluge.core.core - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/daemon.rst b/docs/source/modules/core/daemon.rst deleted file mode 100644 index 9c91e19d3..000000000 --- a/docs/source/modules/core/daemon.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.daemon` -============================================================================== - -.. automodule:: deluge.core.daemon - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/eventmanager.rst b/docs/source/modules/core/eventmanager.rst deleted file mode 100644 index c50698d71..000000000 --- a/docs/source/modules/core/eventmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.eventmanager` -============================================================================== - -.. automodule:: deluge.core.eventmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/filtermanager.rst b/docs/source/modules/core/filtermanager.rst deleted file mode 100644 index a24f764b4..000000000 --- a/docs/source/modules/core/filtermanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.filtermanager` -============================================================================== - -.. automodule:: deluge.core.filtermanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/oldstateupgrader.rst b/docs/source/modules/core/oldstateupgrader.rst deleted file mode 100644 index cf789c611..000000000 --- a/docs/source/modules/core/oldstateupgrader.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.oldstateupgrader` -============================================================================== - -.. automodule:: deluge.core.oldstateupgrader - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/pluginmanager.rst b/docs/source/modules/core/pluginmanager.rst deleted file mode 100644 index 33471eb8d..000000000 --- a/docs/source/modules/core/pluginmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.pluginmanager` -============================================================================== - -.. automodule:: deluge.core.pluginmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/preferencesmanager.rst b/docs/source/modules/core/preferencesmanager.rst deleted file mode 100644 index e6a4728c7..000000000 --- a/docs/source/modules/core/preferencesmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.preferencesmanager` -============================================================================== - -.. automodule:: deluge.core.preferencesmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/rpcserver.rst b/docs/source/modules/core/rpcserver.rst deleted file mode 100644 index eb6f17997..000000000 --- a/docs/source/modules/core/rpcserver.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.rpcserver` -============================================================================== - -.. automodule:: deluge.core.rpcserver - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/torrent.rst b/docs/source/modules/core/torrent.rst deleted file mode 100644 index 0a9c46a11..000000000 --- a/docs/source/modules/core/torrent.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.torrent` -============================================================================== - -.. automodule:: deluge.core.torrent - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/core/torrentmanager.rst b/docs/source/modules/core/torrentmanager.rst deleted file mode 100644 index d098e3d85..000000000 --- a/docs/source/modules/core/torrentmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.core.torrentmanager` -============================================================================== - -.. automodule:: deluge.core.torrentmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/deluge.core.rst b/docs/source/modules/deluge.core.rst new file mode 100644 index 000000000..adff52213 --- /dev/null +++ b/docs/source/modules/deluge.core.rst @@ -0,0 +1,102 @@ +deluge.core package +=================== + +Submodules +---------- + +deluge.core.alertmanager module +------------------------------- + +.. automodule:: deluge.core.alertmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.authmanager module +------------------------------ + +.. automodule:: deluge.core.authmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.core module +----------------------- + +.. automodule:: deluge.core.core + :members: + :undoc-members: + :show-inheritance: + +deluge.core.daemon module +------------------------- + +.. automodule:: deluge.core.daemon + :members: + :undoc-members: + :show-inheritance: + +deluge.core.eventmanager module +------------------------------- + +.. automodule:: deluge.core.eventmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.filtermanager module +-------------------------------- + +.. automodule:: deluge.core.filtermanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.pluginmanager module +-------------------------------- + +.. automodule:: deluge.core.pluginmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.preferencesmanager module +------------------------------------- + +.. automodule:: deluge.core.preferencesmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.core.rpcserver module +---------------------------- + +.. automodule:: deluge.core.rpcserver + :members: + :undoc-members: + :show-inheritance: + +deluge.core.torrent module +-------------------------- + +.. automodule:: deluge.core.torrent + :members: + :undoc-members: + :show-inheritance: + +deluge.core.torrentmanager module +--------------------------------- + +.. automodule:: deluge.core.torrentmanager + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.plugins.rst b/docs/source/modules/deluge.plugins.rst new file mode 100644 index 000000000..2b8f27b5b --- /dev/null +++ b/docs/source/modules/deluge.plugins.rst @@ -0,0 +1,30 @@ +deluge.plugins package +====================== + +Submodules +---------- + +deluge.plugins.init module +-------------------------- + +.. automodule:: deluge.plugins.init + :members: + :undoc-members: + :show-inheritance: + +deluge.plugins.pluginbase module +-------------------------------- + +.. automodule:: deluge.plugins.pluginbase + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.plugins + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.rst b/docs/source/modules/deluge.rst new file mode 100644 index 000000000..43918a5c3 --- /dev/null +++ b/docs/source/modules/deluge.rst @@ -0,0 +1,159 @@ +deluge package +============== + +Subpackages +----------- + +.. toctree:: + + deluge.core + deluge.plugins + deluge.ui + +Submodules +---------- + +deluge.bencode module +--------------------- + +.. automodule:: deluge.bencode + :members: + :undoc-members: + :show-inheritance: + +deluge.common module +-------------------- + +.. automodule:: deluge.common + :members: + :undoc-members: + :show-inheritance: + +deluge.component module +----------------------- + +.. automodule:: deluge.component + :members: + :undoc-members: + :show-inheritance: + +deluge.config module +-------------------- + +.. automodule:: deluge.config + :members: + :undoc-members: + :show-inheritance: + +deluge.configmanager module +--------------------------- + +.. automodule:: deluge.configmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.decorators module +------------------------ + +.. automodule:: deluge.decorators + :members: + :undoc-members: + :show-inheritance: + +deluge.error module +------------------- + +.. automodule:: deluge.error + :members: + :undoc-members: + :show-inheritance: + +deluge.event module +------------------- + +.. automodule:: deluge.event + :members: + :undoc-members: + :show-inheritance: + +deluge.httpdownloader module +---------------------------- + +.. automodule:: deluge.httpdownloader + :members: + :undoc-members: + :show-inheritance: + +deluge.log module +----------------- + +.. automodule:: deluge.log + :members: + :undoc-members: + :show-inheritance: + +deluge.main module +------------------ + +.. automodule:: deluge.main + :members: + :undoc-members: + :show-inheritance: + +deluge.maketorrent module +------------------------- + +.. automodule:: deluge.maketorrent + :members: + :undoc-members: + :show-inheritance: + +deluge.metafile module +---------------------- + +.. automodule:: deluge.metafile + :members: + :undoc-members: + :show-inheritance: + +deluge.path_chooser_common module +--------------------------------- + +.. automodule:: deluge.path_chooser_common + :members: + :undoc-members: + :show-inheritance: + +deluge.pluginmanagerbase module +------------------------------- + +.. automodule:: deluge.pluginmanagerbase + :members: + :undoc-members: + :show-inheritance: + +deluge.rencode module +--------------------- + +.. automodule:: deluge.rencode + :members: + :undoc-members: + :show-inheritance: + +deluge.transfer module +---------------------- + +.. automodule:: deluge.transfer + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.console.commands.rst b/docs/source/modules/deluge.ui.console.commands.rst new file mode 100644 index 000000000..3bbf3e887 --- /dev/null +++ b/docs/source/modules/deluge.ui.console.commands.rst @@ -0,0 +1,166 @@ +deluge.ui.console.commands package +================================== + +Submodules +---------- + +deluge.ui.console.commands.add module +------------------------------------- + +.. automodule:: deluge.ui.console.commands.add + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.cache module +--------------------------------------- + +.. automodule:: deluge.ui.console.commands.cache + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.config module +---------------------------------------- + +.. automodule:: deluge.ui.console.commands.config + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.connect module +----------------------------------------- + +.. automodule:: deluge.ui.console.commands.connect + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.debug module +--------------------------------------- + +.. automodule:: deluge.ui.console.commands.debug + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.gui module +------------------------------------- + +.. automodule:: deluge.ui.console.commands.gui + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.halt module +-------------------------------------- + +.. automodule:: deluge.ui.console.commands.halt + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.help module +-------------------------------------- + +.. automodule:: deluge.ui.console.commands.help + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.info module +-------------------------------------- + +.. automodule:: deluge.ui.console.commands.info + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.manage module +---------------------------------------- + +.. automodule:: deluge.ui.console.commands.manage + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.move module +-------------------------------------- + +.. automodule:: deluge.ui.console.commands.move + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.pause module +--------------------------------------- + +.. automodule:: deluge.ui.console.commands.pause + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.plugin module +---------------------------------------- + +.. automodule:: deluge.ui.console.commands.plugin + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.quit module +-------------------------------------- + +.. automodule:: deluge.ui.console.commands.quit + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.recheck module +----------------------------------------- + +.. automodule:: deluge.ui.console.commands.recheck + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.resume module +---------------------------------------- + +.. automodule:: deluge.ui.console.commands.resume + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.rm module +------------------------------------ + +.. automodule:: deluge.ui.console.commands.rm + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.status module +---------------------------------------- + +.. automodule:: deluge.ui.console.commands.status + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commands.update-tracker module +------------------------------------------------ + +.. automodule:: deluge.ui.console.commands.update_tracker + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui.console.commands + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.console.modes.rst b/docs/source/modules/deluge.ui.console.modes.rst new file mode 100644 index 000000000..0aaf8d882 --- /dev/null +++ b/docs/source/modules/deluge.ui.console.modes.rst @@ -0,0 +1,134 @@ +deluge.ui.console.modes package +=============================== + +Submodules +---------- + +deluge.ui.console.modes.add_util module +--------------------------------------- + +.. automodule:: deluge.ui.console.modes.add_util + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.addtorrents module +------------------------------------------ + +.. automodule:: deluge.ui.console.modes.addtorrents + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.alltorrents module +------------------------------------------ + +.. automodule:: deluge.ui.console.modes.alltorrents + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.basemode module +--------------------------------------- + +.. automodule:: deluge.ui.console.modes.basemode + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.column module +------------------------------------- + +.. automodule:: deluge.ui.console.modes.column + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.connectionmanager module +------------------------------------------------ + +.. automodule:: deluge.ui.console.modes.connectionmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.eventview module +---------------------------------------- + +.. automodule:: deluge.ui.console.modes.eventview + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.format_utils module +------------------------------------------- + +.. automodule:: deluge.ui.console.modes.format_utils + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.input_popup module +------------------------------------------ + +.. automodule:: deluge.ui.console.modes.input_popup + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.legacy module +------------------------------------- + +.. automodule:: deluge.ui.console.modes.legacy + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.popup module +------------------------------------ + +.. automodule:: deluge.ui.console.modes.popup + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.preference_panes module +----------------------------------------------- + +.. automodule:: deluge.ui.console.modes.preference_panes + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.preferences module +------------------------------------------ + +.. automodule:: deluge.ui.console.modes.preferences + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.torrent_actions module +---------------------------------------------- + +.. automodule:: deluge.ui.console.modes.torrent_actions + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.modes.torrentdetail module +-------------------------------------------- + +.. automodule:: deluge.ui.console.modes.torrentdetail + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui.console.modes + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.console.rst b/docs/source/modules/deluge.ui.console.rst new file mode 100644 index 000000000..fb289768a --- /dev/null +++ b/docs/source/modules/deluge.ui.console.rst @@ -0,0 +1,62 @@ +deluge.ui.console package +========================= + +Subpackages +----------- + +.. toctree:: + + deluge.ui.console.commands + deluge.ui.console.modes + +Submodules +---------- + +deluge.ui.console.colors module +------------------------------- + +.. automodule:: deluge.ui.console.colors + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.commander module +---------------------------------- + +.. automodule:: deluge.ui.console.commander + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.eventlog module +--------------------------------- + +.. automodule:: deluge.ui.console.eventlog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.main module +----------------------------- + +.. automodule:: deluge.ui.console.main + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.console.statusbars module +----------------------------------- + +.. automodule:: deluge.ui.console.statusbars + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui.console + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.gtkui.rst b/docs/source/modules/deluge.ui.gtkui.rst new file mode 100644 index 000000000..eaab3ba3a --- /dev/null +++ b/docs/source/modules/deluge.ui.gtkui.rst @@ -0,0 +1,294 @@ +deluge.ui.gtkui package +======================= + +Submodules +---------- + +deluge.ui.gtkui.aboutdialog module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.aboutdialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.addtorrentdialog module +--------------------------------------- + +.. automodule:: deluge.ui.gtkui.addtorrentdialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.common module +----------------------------- + +.. automodule:: deluge.ui.gtkui.common + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.connectionmanager module +---------------------------------------- + +.. automodule:: deluge.ui.gtkui.connectionmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.createtorrentdialog module +------------------------------------------ + +.. automodule:: deluge.ui.gtkui.createtorrentdialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.details_tab module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.details_tab + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.dialogs module +------------------------------ + +.. automodule:: deluge.ui.gtkui.dialogs + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.edittrackersdialog module +----------------------------------------- + +.. automodule:: deluge.ui.gtkui.edittrackersdialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.files_tab module +-------------------------------- + +.. automodule:: deluge.ui.gtkui.files_tab + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.filtertreeview module +------------------------------------- + +.. automodule:: deluge.ui.gtkui.filtertreeview + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.gtkui module +---------------------------- + +.. automodule:: deluge.ui.gtkui.gtkui + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.ipcinterface module +----------------------------------- + +.. automodule:: deluge.ui.gtkui.ipcinterface + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.listview module +------------------------------- + +.. automodule:: deluge.ui.gtkui.listview + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.mainwindow module +--------------------------------- + +.. automodule:: deluge.ui.gtkui.mainwindow + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.menubar module +------------------------------ + +.. automodule:: deluge.ui.gtkui.menubar + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.menubar_osx module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.menubar_osx + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.new_release_dialog module +----------------------------------------- + +.. automodule:: deluge.ui.gtkui.new_release_dialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.notification module +----------------------------------- + +.. automodule:: deluge.ui.gtkui.notification + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.options_tab module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.options_tab + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.path_chooser module +----------------------------------- + +.. automodule:: deluge.ui.gtkui.path_chooser + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.path_combo_chooser module +----------------------------------------- + +.. automodule:: deluge.ui.gtkui.path_combo_chooser + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.peers_tab module +-------------------------------- + +.. automodule:: deluge.ui.gtkui.peers_tab + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.piecesbar module +-------------------------------- + +.. automodule:: deluge.ui.gtkui.piecesbar + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.pluginmanager module +------------------------------------ + +.. automodule:: deluge.ui.gtkui.pluginmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.preferences module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.preferences + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.queuedtorrents module +------------------------------------- + +.. automodule:: deluge.ui.gtkui.queuedtorrents + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.removetorrentdialog module +------------------------------------------ + +.. automodule:: deluge.ui.gtkui.removetorrentdialog + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.sidebar module +------------------------------ + +.. automodule:: deluge.ui.gtkui.sidebar + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.status_tab module +--------------------------------- + +.. automodule:: deluge.ui.gtkui.status_tab + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.statusbar module +-------------------------------- + +.. automodule:: deluge.ui.gtkui.statusbar + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.systemtray module +--------------------------------- + +.. automodule:: deluge.ui.gtkui.systemtray + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.toolbar module +------------------------------ + +.. automodule:: deluge.ui.gtkui.toolbar + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.torrentdetails module +------------------------------------- + +.. automodule:: deluge.ui.gtkui.torrentdetails + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.torrentview module +---------------------------------- + +.. automodule:: deluge.ui.gtkui.torrentview + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.gtkui.torrentview_data_funcs module +--------------------------------------------- + +.. automodule:: deluge.ui.gtkui.torrentview_data_funcs + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui.gtkui + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.rst b/docs/source/modules/deluge.ui.rst new file mode 100644 index 000000000..26279a7b8 --- /dev/null +++ b/docs/source/modules/deluge.ui.rst @@ -0,0 +1,95 @@ +deluge.ui package +================= + +Subpackages +----------- + +.. toctree:: + + deluge.ui.console + deluge.ui.gtkui + deluge.ui.web + +Submodules +---------- + +deluge.ui.Win32IconImagePlugin module +------------------------------------- + +.. automodule:: deluge.ui.Win32IconImagePlugin + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.client module +----------------------- + +.. automodule:: deluge.ui.client + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.common module +----------------------- + +.. automodule:: deluge.ui.common + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.coreconfig module +--------------------------- + +.. automodule:: deluge.ui.coreconfig + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.countries module +-------------------------- + +.. automodule:: deluge.ui.countries + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.languages module +-------------------------- + +.. automodule:: deluge.ui.languages + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.sessionproxy module +----------------------------- + +.. automodule:: deluge.ui.sessionproxy + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.tracker_icons module +------------------------------ + +.. automodule:: deluge.ui.tracker_icons + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.ui module +------------------- + +.. automodule:: deluge.ui.ui + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/deluge.ui.web.rst b/docs/source/modules/deluge.ui.web.rst new file mode 100644 index 000000000..f7f1ac512 --- /dev/null +++ b/docs/source/modules/deluge.ui.web.rst @@ -0,0 +1,62 @@ +deluge.ui.web package +===================== + +Submodules +---------- + +deluge.ui.web.auth module +------------------------- + +.. automodule:: deluge.ui.web.auth + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.web.common module +--------------------------- + +.. automodule:: deluge.ui.web.common + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.web.json_api module +----------------------------- + +.. automodule:: deluge.ui.web.json_api + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.web.pluginmanager module +---------------------------------- + +.. automodule:: deluge.ui.web.pluginmanager + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.web.server module +--------------------------- + +.. automodule:: deluge.ui.web.server + :members: + :undoc-members: + :show-inheritance: + +deluge.ui.web.web module +------------------------ + +.. automodule:: deluge.ui.web.web + :members: + :undoc-members: + :show-inheritance: + + +Module contents +--------------- + +.. automodule:: deluge.ui.web + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/modules/error.rst b/docs/source/modules/error.rst deleted file mode 100644 index b6419fe5c..000000000 --- a/docs/source/modules/error.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.error` -============================================================================== - -.. automodule:: deluge.error - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/event.rst b/docs/source/modules/event.rst deleted file mode 100644 index aa1ce0253..000000000 --- a/docs/source/modules/event.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.event` -============================================================================== - -.. automodule:: deluge.event - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/httpdownloader.rst b/docs/source/modules/httpdownloader.rst deleted file mode 100644 index 98f0bcfaa..000000000 --- a/docs/source/modules/httpdownloader.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.httpdownloader` -============================================================================== - -.. automodule:: deluge.httpdownloader - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/log.rst b/docs/source/modules/log.rst deleted file mode 100644 index f18aded8c..000000000 --- a/docs/source/modules/log.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.log` -============================================================================== - -.. automodule:: deluge.log - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/main.rst b/docs/source/modules/main.rst deleted file mode 100644 index 5a671ea3a..000000000 --- a/docs/source/modules/main.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.main` -============================================================================== - -.. automodule:: deluge.main - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/maketorrent.rst b/docs/source/modules/maketorrent.rst deleted file mode 100644 index b3cb4ab26..000000000 --- a/docs/source/modules/maketorrent.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.maketorrent` -============================================================================== - -.. automodule:: deluge.maketorrent - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/metafile.rst b/docs/source/modules/metafile.rst deleted file mode 100644 index 616cdc13e..000000000 --- a/docs/source/modules/metafile.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.metafile` -============================================================================== - -.. automodule:: deluge.metafile - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/pluginmanagerbase.rst b/docs/source/modules/pluginmanagerbase.rst deleted file mode 100644 index 5ea2454e5..000000000 --- a/docs/source/modules/pluginmanagerbase.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.pluginmanagerbase` -============================================================================== - -.. automodule:: deluge.pluginmanagerbase - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/plugins/init.rst b/docs/source/modules/plugins/init.rst deleted file mode 100644 index 4a37550c4..000000000 --- a/docs/source/modules/plugins/init.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.plugins.init` -============================================================================== - -.. automodule:: deluge.plugins.init - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/plugins/pluginbase.rst b/docs/source/modules/plugins/pluginbase.rst deleted file mode 100644 index e5ff6929b..000000000 --- a/docs/source/modules/plugins/pluginbase.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.plugins.pluginbase` -============================================================================== - -.. automodule:: deluge.plugins.pluginbase - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/rencode.rst b/docs/source/modules/rencode.rst deleted file mode 100644 index 85c63d7c6..000000000 --- a/docs/source/modules/rencode.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.rencode` -============================================================================== - -.. automodule:: deluge.rencode - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/client.rst b/docs/source/modules/ui/client.rst deleted file mode 100644 index a87d85687..000000000 --- a/docs/source/modules/ui/client.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.client` -============================================================================== - -.. automodule:: deluge.ui.client - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/common.rst b/docs/source/modules/ui/common.rst deleted file mode 100644 index 9d38979ba..000000000 --- a/docs/source/modules/ui/common.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`deluge.ui.common` -======================= - -.. automodule:: deluge.ui.common - :members: diff --git a/docs/source/modules/ui/console/colors.rst b/docs/source/modules/ui/console/colors.rst deleted file mode 100644 index 46ed0c30b..000000000 --- a/docs/source/modules/ui/console/colors.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.colors` -============================================================================== - -.. automodule:: deluge.ui.console.colors - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/add.rst b/docs/source/modules/ui/console/commands/add.rst deleted file mode 100644 index 73869641c..000000000 --- a/docs/source/modules/ui/console/commands/add.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.add` -============================================================================== - -.. automodule:: deluge.ui.console.commands.add - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/config.rst b/docs/source/modules/ui/console/commands/config.rst deleted file mode 100644 index 96381e848..000000000 --- a/docs/source/modules/ui/console/commands/config.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.config` -============================================================================== - -.. automodule:: deluge.ui.console.commands.config - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/connect.rst b/docs/source/modules/ui/console/commands/connect.rst deleted file mode 100644 index 925c7f540..000000000 --- a/docs/source/modules/ui/console/commands/connect.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.connect` -============================================================================== - -.. automodule:: deluge.ui.console.commands.connect - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/debug.rst b/docs/source/modules/ui/console/commands/debug.rst deleted file mode 100644 index 3003afbf7..000000000 --- a/docs/source/modules/ui/console/commands/debug.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.debug` -============================================================================== - -.. automodule:: deluge.ui.console.commands.debug - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/halt.rst b/docs/source/modules/ui/console/commands/halt.rst deleted file mode 100644 index d702d0c67..000000000 --- a/docs/source/modules/ui/console/commands/halt.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.halt` -============================================================================== - -.. automodule:: deluge.ui.console.commands.halt - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/help.rst b/docs/source/modules/ui/console/commands/help.rst deleted file mode 100644 index f2132f412..000000000 --- a/docs/source/modules/ui/console/commands/help.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.help` -============================================================================== - -.. automodule:: deluge.ui.console.commands.help - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/info.rst b/docs/source/modules/ui/console/commands/info.rst deleted file mode 100644 index 2ca7fdea4..000000000 --- a/docs/source/modules/ui/console/commands/info.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.info` -============================================================================== - -.. automodule:: deluge.ui.console.commands.info - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/pause.rst b/docs/source/modules/ui/console/commands/pause.rst deleted file mode 100644 index d292a66ec..000000000 --- a/docs/source/modules/ui/console/commands/pause.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.pause` -============================================================================== - -.. automodule:: deluge.ui.console.commands.pause - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/quit.rst b/docs/source/modules/ui/console/commands/quit.rst deleted file mode 100644 index 597bb5786..000000000 --- a/docs/source/modules/ui/console/commands/quit.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.quit` -============================================================================== - -.. automodule:: deluge.ui.console.commands.quit - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/recheck.rst b/docs/source/modules/ui/console/commands/recheck.rst deleted file mode 100644 index b4231c094..000000000 --- a/docs/source/modules/ui/console/commands/recheck.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.recheck` -============================================================================== - -.. automodule:: deluge.ui.console.commands.recheck - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/resume.rst b/docs/source/modules/ui/console/commands/resume.rst deleted file mode 100644 index 1c3962dd2..000000000 --- a/docs/source/modules/ui/console/commands/resume.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.resume` -============================================================================== - -.. automodule:: deluge.ui.console.commands.resume - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/commands/rm.rst b/docs/source/modules/ui/console/commands/rm.rst deleted file mode 100644 index 15782d3ee..000000000 --- a/docs/source/modules/ui/console/commands/rm.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.commands.rm` -============================================================================== - -.. automodule:: deluge.ui.console.commands.rm - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/eventlog.rst b/docs/source/modules/ui/console/eventlog.rst deleted file mode 100644 index e32cf206f..000000000 --- a/docs/source/modules/ui/console/eventlog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.eventlog` -============================================================================== - -.. automodule:: deluge.ui.console.eventlog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/main.rst b/docs/source/modules/ui/console/main.rst deleted file mode 100644 index 39e091c10..000000000 --- a/docs/source/modules/ui/console/main.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.main` -============================================================================== - -.. automodule:: deluge.ui.console.main - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/screen.rst b/docs/source/modules/ui/console/screen.rst deleted file mode 100644 index 96f673de2..000000000 --- a/docs/source/modules/ui/console/screen.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.screen` -============================================================================== - -.. automodule:: deluge.ui.console.screen - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/console/statusbars.rst b/docs/source/modules/ui/console/statusbars.rst deleted file mode 100644 index da87f0a94..000000000 --- a/docs/source/modules/ui/console/statusbars.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.console.statusbars` -============================================================================== - -.. automodule:: deluge.ui.console.statusbars - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/coreconfig.rst b/docs/source/modules/ui/coreconfig.rst deleted file mode 100644 index c4e717674..000000000 --- a/docs/source/modules/ui/coreconfig.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.coreconfig` -============================================================================== - -.. automodule:: deluge.ui.coreconfig - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/countries.rst b/docs/source/modules/ui/countries.rst deleted file mode 100644 index 5c93a118d..000000000 --- a/docs/source/modules/ui/countries.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.countries` -============================================================================== - -.. automodule:: deluge.ui.countries - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/aboutdialog.rst b/docs/source/modules/ui/gtkui/aboutdialog.rst deleted file mode 100644 index f44e37add..000000000 --- a/docs/source/modules/ui/gtkui/aboutdialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.aboutdialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.aboutdialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/addtorrentdialog.rst b/docs/source/modules/ui/gtkui/addtorrentdialog.rst deleted file mode 100644 index ac412ee67..000000000 --- a/docs/source/modules/ui/gtkui/addtorrentdialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.addtorrentdialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.addtorrentdialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/common.rst b/docs/source/modules/ui/gtkui/common.rst deleted file mode 100644 index 7468f1343..000000000 --- a/docs/source/modules/ui/gtkui/common.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.common` -============================================================================== - -.. automodule:: deluge.ui.gtkui.common - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/connectionmanager.rst b/docs/source/modules/ui/gtkui/connectionmanager.rst deleted file mode 100644 index 6813c65be..000000000 --- a/docs/source/modules/ui/gtkui/connectionmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.connectionmanager` -============================================================================== - -.. automodule:: deluge.ui.gtkui.connectionmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/createtorrentdialog.rst b/docs/source/modules/ui/gtkui/createtorrentdialog.rst deleted file mode 100644 index 2fafbde86..000000000 --- a/docs/source/modules/ui/gtkui/createtorrentdialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.createtorrentdialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.createtorrentdialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/details_tab.rst b/docs/source/modules/ui/gtkui/details_tab.rst deleted file mode 100644 index 12839292d..000000000 --- a/docs/source/modules/ui/gtkui/details_tab.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.details_tab` -============================================================================== - -.. automodule:: deluge.ui.gtkui.details_tab - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/dialogs.rst b/docs/source/modules/ui/gtkui/dialogs.rst deleted file mode 100644 index 2333cc9f1..000000000 --- a/docs/source/modules/ui/gtkui/dialogs.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.dialogs` -============================================================================== - -.. automodule:: deluge.ui.gtkui.dialogs - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/edittrackersdialog.rst b/docs/source/modules/ui/gtkui/edittrackersdialog.rst deleted file mode 100644 index 4c6b22c48..000000000 --- a/docs/source/modules/ui/gtkui/edittrackersdialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.edittrackersdialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.edittrackersdialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/files_tab.rst b/docs/source/modules/ui/gtkui/files_tab.rst deleted file mode 100644 index 96525680e..000000000 --- a/docs/source/modules/ui/gtkui/files_tab.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.files_tab` -============================================================================== - -.. automodule:: deluge.ui.gtkui.files_tab - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/filtertreeview.rst b/docs/source/modules/ui/gtkui/filtertreeview.rst deleted file mode 100644 index d59ff2bf2..000000000 --- a/docs/source/modules/ui/gtkui/filtertreeview.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.filtertreeview` -============================================================================== - -.. automodule:: deluge.ui.gtkui.filtertreeview - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/ipcinterface.rst b/docs/source/modules/ui/gtkui/ipcinterface.rst deleted file mode 100644 index e52fc4878..000000000 --- a/docs/source/modules/ui/gtkui/ipcinterface.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.ipcinterface` -============================================================================== - -.. automodule:: deluge.ui.gtkui.ipcinterface - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/listview.rst b/docs/source/modules/ui/gtkui/listview.rst deleted file mode 100644 index 169f08b0c..000000000 --- a/docs/source/modules/ui/gtkui/listview.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.listview` -============================================================================== - -.. automodule:: deluge.ui.gtkui.listview - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/mainwindow.rst b/docs/source/modules/ui/gtkui/mainwindow.rst deleted file mode 100644 index 47132a5a6..000000000 --- a/docs/source/modules/ui/gtkui/mainwindow.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.mainwindow` -============================================================================== - -.. automodule:: deluge.ui.gtkui.mainwindow - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/menubar.rst b/docs/source/modules/ui/gtkui/menubar.rst deleted file mode 100644 index 345b243c2..000000000 --- a/docs/source/modules/ui/gtkui/menubar.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.menubar` -============================================================================== - -.. automodule:: deluge.ui.gtkui.menubar - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/new_release_dialog.rst b/docs/source/modules/ui/gtkui/new_release_dialog.rst deleted file mode 100644 index db8670efa..000000000 --- a/docs/source/modules/ui/gtkui/new_release_dialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.new_release_dialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.new_release_dialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/notification.rst b/docs/source/modules/ui/gtkui/notification.rst deleted file mode 100644 index b5d691bc6..000000000 --- a/docs/source/modules/ui/gtkui/notification.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.notification` -============================================================================== - -.. automodule:: deluge.ui.gtkui.notification - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/options_tab.rst b/docs/source/modules/ui/gtkui/options_tab.rst deleted file mode 100644 index 8729261d5..000000000 --- a/docs/source/modules/ui/gtkui/options_tab.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.options_tab` -============================================================================== - -.. automodule:: deluge.ui.gtkui.options_tab - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/peers_tab.rst b/docs/source/modules/ui/gtkui/peers_tab.rst deleted file mode 100644 index 0f6eadca0..000000000 --- a/docs/source/modules/ui/gtkui/peers_tab.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.peers_tab` -============================================================================== - -.. automodule:: deluge.ui.gtkui.peers_tab - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/pluginmanager.rst b/docs/source/modules/ui/gtkui/pluginmanager.rst deleted file mode 100644 index a541da98c..000000000 --- a/docs/source/modules/ui/gtkui/pluginmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.pluginmanager` -============================================================================== - -.. automodule:: deluge.ui.gtkui.pluginmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/preferences.rst b/docs/source/modules/ui/gtkui/preferences.rst deleted file mode 100644 index 143210eb7..000000000 --- a/docs/source/modules/ui/gtkui/preferences.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.preferences` -============================================================================== - -.. automodule:: deluge.ui.gtkui.preferences - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/queuedtorrents.rst b/docs/source/modules/ui/gtkui/queuedtorrents.rst deleted file mode 100644 index c4d1c2d1d..000000000 --- a/docs/source/modules/ui/gtkui/queuedtorrents.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.queuedtorrents` -============================================================================== - -.. automodule:: deluge.ui.gtkui.queuedtorrents - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/removetorrentdialog.rst b/docs/source/modules/ui/gtkui/removetorrentdialog.rst deleted file mode 100644 index 084851bc9..000000000 --- a/docs/source/modules/ui/gtkui/removetorrentdialog.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.removetorrentdialog` -============================================================================== - -.. automodule:: deluge.ui.gtkui.removetorrentdialog - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/sidebar.rst b/docs/source/modules/ui/gtkui/sidebar.rst deleted file mode 100644 index 91c1d2d15..000000000 --- a/docs/source/modules/ui/gtkui/sidebar.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.sidebar` -============================================================================== - -.. automodule:: deluge.ui.gtkui.sidebar - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/status_tab.rst b/docs/source/modules/ui/gtkui/status_tab.rst deleted file mode 100644 index 064f9cf85..000000000 --- a/docs/source/modules/ui/gtkui/status_tab.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.status_tab` -============================================================================== - -.. automodule:: deluge.ui.gtkui.status_tab - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/statusbar.rst b/docs/source/modules/ui/gtkui/statusbar.rst deleted file mode 100644 index a8b95e57e..000000000 --- a/docs/source/modules/ui/gtkui/statusbar.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.statusbar` -============================================================================== - -.. automodule:: deluge.ui.gtkui.statusbar - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/systemtray.rst b/docs/source/modules/ui/gtkui/systemtray.rst deleted file mode 100644 index a64b4e922..000000000 --- a/docs/source/modules/ui/gtkui/systemtray.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.systemtray` -============================================================================== - -.. automodule:: deluge.ui.gtkui.systemtray - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/toolbar.rst b/docs/source/modules/ui/gtkui/toolbar.rst deleted file mode 100644 index 1e6136b12..000000000 --- a/docs/source/modules/ui/gtkui/toolbar.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.toolbar` -============================================================================== - -.. automodule:: deluge.ui.gtkui.toolbar - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/torrentdetails.rst b/docs/source/modules/ui/gtkui/torrentdetails.rst deleted file mode 100644 index 3569dca2e..000000000 --- a/docs/source/modules/ui/gtkui/torrentdetails.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.torrentdetails` -============================================================================== - -.. automodule:: deluge.ui.gtkui.torrentdetails - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/gtkui/torrentview.rst b/docs/source/modules/ui/gtkui/torrentview.rst deleted file mode 100644 index bcb5809a1..000000000 --- a/docs/source/modules/ui/gtkui/torrentview.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.gtkui.torrentview` -============================================================================== - -.. automodule:: deluge.ui.gtkui.torrentview - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/sessionproxy.rst b/docs/source/modules/ui/sessionproxy.rst deleted file mode 100644 index fc80f441f..000000000 --- a/docs/source/modules/ui/sessionproxy.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.sessionproxy` -============================================================================== - -.. automodule:: deluge.ui.sessionproxy - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/tracker_icons.rst b/docs/source/modules/ui/tracker_icons.rst deleted file mode 100644 index 49ee52478..000000000 --- a/docs/source/modules/ui/tracker_icons.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.tracker_icons` -============================================================================== - -.. automodule:: deluge.ui.tracker_icons - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/ui.rst b/docs/source/modules/ui/ui.rst deleted file mode 100644 index 9e6fa6cf3..000000000 --- a/docs/source/modules/ui/ui.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.ui` -============================================================================== - -.. automodule:: deluge.ui.ui - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/web/auth.rst b/docs/source/modules/ui/web/auth.rst deleted file mode 100644 index a2becfd08..000000000 --- a/docs/source/modules/ui/web/auth.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`deluge.ui.web.auth` -========================= - -.. automodule:: deluge.ui.web.auth - :members: diff --git a/docs/source/modules/ui/web/common.rst b/docs/source/modules/ui/web/common.rst deleted file mode 100644 index 0be05bec9..000000000 --- a/docs/source/modules/ui/web/common.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`deluge.ui.web.common` -=========================== - -.. automodule:: deluge.ui.web.common - :members: diff --git a/docs/source/modules/ui/web/gen_gettext.rst b/docs/source/modules/ui/web/gen_gettext.rst deleted file mode 100644 index 1cdc02099..000000000 --- a/docs/source/modules/ui/web/gen_gettext.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.web.gen_gettext` -============================================================================== - -.. automodule:: deluge.ui.web.gen_gettext - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/web/json_api.rst b/docs/source/modules/ui/web/json_api.rst deleted file mode 100644 index f82808941..000000000 --- a/docs/source/modules/ui/web/json_api.rst +++ /dev/null @@ -1,5 +0,0 @@ -:mod:`deluge.ui.web.json_api` -============================= - -.. automodule:: deluge.ui.web.json_api - :members: diff --git a/docs/source/modules/ui/web/pluginmanager.rst b/docs/source/modules/ui/web/pluginmanager.rst deleted file mode 100644 index 07440f337..000000000 --- a/docs/source/modules/ui/web/pluginmanager.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.web.pluginmanager` -============================================================================== - -.. automodule:: deluge.ui.web.pluginmanager - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/web/server.rst b/docs/source/modules/ui/web/server.rst deleted file mode 100644 index 5fe1115b0..000000000 --- a/docs/source/modules/ui/web/server.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.web.server` -============================================================================== - -.. automodule:: deluge.ui.web.server - :show-inheritance: - :members: - :undoc-members: - diff --git a/docs/source/modules/ui/web/web.rst b/docs/source/modules/ui/web/web.rst deleted file mode 100644 index 369647efb..000000000 --- a/docs/source/modules/ui/web/web.rst +++ /dev/null @@ -1,9 +0,0 @@ - -:mod:`deluge.ui.web.web` -============================================================================== - -.. automodule:: deluge.ui.web.web - :show-inheritance: - :members: - :undoc-members: - diff --git a/deluge/ui/web/gen_gettext.py b/gen_web_gettext.py similarity index 99% rename from deluge/ui/web/gen_gettext.py rename to gen_web_gettext.py index bd24c42f7..49730dba5 100755 --- a/deluge/ui/web/gen_gettext.py +++ b/gen_web_gettext.py @@ -64,4 +64,3 @@ for key in keys: fp.write('// %s\n' % ', '.join(map(lambda x: '%s:%s' % x, strings[key]))) fp.write("GetText.add('%(key)s', '${escape(_(\"%(key)s\"))}')\n\n" % locals()) fp.close() - diff --git a/setup.py b/setup.py index 0f08e554a..75ce5e4b5 100755 --- a/setup.py +++ b/setup.py @@ -168,27 +168,36 @@ class egg_info_plugins(cmd.Command): class build_docs(BuildDoc): def run(self): - class FakeModule(object): - def __init__(self, *args, **kwargs): pass + class Mock(object): + def __init__(self, *args, **kwargs): + pass def __call__(self, *args, **kwargs): - return FakeModule() + return Mock() def __getattr__(self, key): - return FakeModule() + return Mock() def __setattr__(self, key, value): self.__dict__[key] = value + def __len__(self): + return 0 + + def __getitem__(self, ii): + return " " + old_import = __builtins__.__import__ def new_import(name, globals={}, locals={}, fromlist=[], level=-1): try: return old_import(name, globals, locals, fromlist, level) - except ImportError: - return FakeModule() - except Exception, e: - print "Skipping Exception: ", e - return FakeModule() + except ImportError as ex: + #sys.stdout.write("ImportError: %s\n" % ex) + return Mock() + + except Exception as ex: + #sys.stdout.write("Skipping Exception: %s\n" % ex) + return Mock() __builtins__.__import__ = new_import BuildDoc.run(self)