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
This commit is contained in:
Calum Lind 2014-02-20 17:24:11 +00:00
parent c64da3ceb4
commit 9290cc1f7a
113 changed files with 1203 additions and 862 deletions

View File

@ -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

View File

@ -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

View File

@ -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()

View File

@ -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.

View File

@ -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.

View File

@ -43,7 +43,7 @@ from optparse import make_option
class Command(BaseCommand):
"""Update tracker for torrent(s)"""
usage = "Usage: update-tracker [ * | <torrent-id> [<torrent-id> ...] ]"
usage = "Usage: update_tracker [ * | <torrent-id> [<torrent-id> ...] ]"
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))

View File

@ -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

View File

@ -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

View File

@ -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)

View File

@ -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.

View File

@ -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 <core/index.rst>
Interfaces <interfaces/index.rst>
@ -28,6 +28,3 @@ Modules
:glob:
modules/*
modules/*/*
modules/*/*/*
modules/*/*/*/*

View File

@ -1,9 +0,0 @@
:mod:`deluge.__rpcapi`
==============================================================================
.. automodule:: deluge.__rpcapi
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge._libtorrent`
==============================================================================
.. automodule:: deluge._libtorrent
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.bencode`
==============================================================================
.. automodule:: deluge.bencode
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,5 +0,0 @@
:mod:`deluge.common`
====================
.. automodule:: deluge.common
:members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.component`
==============================================================================
.. automodule:: deluge.component
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,11 +0,0 @@
:mod:`deluge.config`
====================
.. automodule:: deluge.config
.. autoclass:: Config
:show-inheritance:
:members:
:undoc-members:
.. automethod:: __setitem__
.. automethod:: __getitem__

View File

@ -1,9 +0,0 @@
:mod:`deluge.configmanager`
==============================================================================
.. automodule:: deluge.configmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.alertmanager`
==============================================================================
.. automodule:: deluge.core.alertmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.authmanager`
==============================================================================
.. automodule:: deluge.core.authmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.autoadd`
==============================================================================
.. automodule:: deluge.core.autoadd
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.core`
==============================================================================
.. automodule:: deluge.core.core
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.daemon`
==============================================================================
.. automodule:: deluge.core.daemon
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.eventmanager`
==============================================================================
.. automodule:: deluge.core.eventmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.filtermanager`
==============================================================================
.. automodule:: deluge.core.filtermanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.oldstateupgrader`
==============================================================================
.. automodule:: deluge.core.oldstateupgrader
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.pluginmanager`
==============================================================================
.. automodule:: deluge.core.pluginmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.preferencesmanager`
==============================================================================
.. automodule:: deluge.core.preferencesmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.rpcserver`
==============================================================================
.. automodule:: deluge.core.rpcserver
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.torrent`
==============================================================================
.. automodule:: deluge.core.torrent
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.core.torrentmanager`
==============================================================================
.. automodule:: deluge.core.torrentmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -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:

View File

@ -1,9 +0,0 @@
:mod:`deluge.error`
==============================================================================
.. automodule:: deluge.error
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.event`
==============================================================================
.. automodule:: deluge.event
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.httpdownloader`
==============================================================================
.. automodule:: deluge.httpdownloader
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.log`
==============================================================================
.. automodule:: deluge.log
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.main`
==============================================================================
.. automodule:: deluge.main
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.maketorrent`
==============================================================================
.. automodule:: deluge.maketorrent
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.metafile`
==============================================================================
.. automodule:: deluge.metafile
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.pluginmanagerbase`
==============================================================================
.. automodule:: deluge.pluginmanagerbase
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.plugins.init`
==============================================================================
.. automodule:: deluge.plugins.init
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.plugins.pluginbase`
==============================================================================
.. automodule:: deluge.plugins.pluginbase
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.rencode`
==============================================================================
.. automodule:: deluge.rencode
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.client`
==============================================================================
.. automodule:: deluge.ui.client
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,5 +0,0 @@
:mod:`deluge.ui.common`
=======================
.. automodule:: deluge.ui.common
:members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.colors`
==============================================================================
.. automodule:: deluge.ui.console.colors
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.add`
==============================================================================
.. automodule:: deluge.ui.console.commands.add
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.config`
==============================================================================
.. automodule:: deluge.ui.console.commands.config
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.connect`
==============================================================================
.. automodule:: deluge.ui.console.commands.connect
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.debug`
==============================================================================
.. automodule:: deluge.ui.console.commands.debug
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.halt`
==============================================================================
.. automodule:: deluge.ui.console.commands.halt
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.help`
==============================================================================
.. automodule:: deluge.ui.console.commands.help
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.info`
==============================================================================
.. automodule:: deluge.ui.console.commands.info
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.pause`
==============================================================================
.. automodule:: deluge.ui.console.commands.pause
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.quit`
==============================================================================
.. automodule:: deluge.ui.console.commands.quit
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.recheck`
==============================================================================
.. automodule:: deluge.ui.console.commands.recheck
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.resume`
==============================================================================
.. automodule:: deluge.ui.console.commands.resume
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.commands.rm`
==============================================================================
.. automodule:: deluge.ui.console.commands.rm
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.eventlog`
==============================================================================
.. automodule:: deluge.ui.console.eventlog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.main`
==============================================================================
.. automodule:: deluge.ui.console.main
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.screen`
==============================================================================
.. automodule:: deluge.ui.console.screen
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.console.statusbars`
==============================================================================
.. automodule:: deluge.ui.console.statusbars
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.coreconfig`
==============================================================================
.. automodule:: deluge.ui.coreconfig
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.countries`
==============================================================================
.. automodule:: deluge.ui.countries
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.aboutdialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.aboutdialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.addtorrentdialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.addtorrentdialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.common`
==============================================================================
.. automodule:: deluge.ui.gtkui.common
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.connectionmanager`
==============================================================================
.. automodule:: deluge.ui.gtkui.connectionmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.createtorrentdialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.createtorrentdialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.details_tab`
==============================================================================
.. automodule:: deluge.ui.gtkui.details_tab
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.dialogs`
==============================================================================
.. automodule:: deluge.ui.gtkui.dialogs
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.edittrackersdialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.edittrackersdialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.files_tab`
==============================================================================
.. automodule:: deluge.ui.gtkui.files_tab
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.filtertreeview`
==============================================================================
.. automodule:: deluge.ui.gtkui.filtertreeview
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.ipcinterface`
==============================================================================
.. automodule:: deluge.ui.gtkui.ipcinterface
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.listview`
==============================================================================
.. automodule:: deluge.ui.gtkui.listview
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.mainwindow`
==============================================================================
.. automodule:: deluge.ui.gtkui.mainwindow
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.menubar`
==============================================================================
.. automodule:: deluge.ui.gtkui.menubar
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.new_release_dialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.new_release_dialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.notification`
==============================================================================
.. automodule:: deluge.ui.gtkui.notification
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.options_tab`
==============================================================================
.. automodule:: deluge.ui.gtkui.options_tab
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.peers_tab`
==============================================================================
.. automodule:: deluge.ui.gtkui.peers_tab
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.pluginmanager`
==============================================================================
.. automodule:: deluge.ui.gtkui.pluginmanager
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.preferences`
==============================================================================
.. automodule:: deluge.ui.gtkui.preferences
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.queuedtorrents`
==============================================================================
.. automodule:: deluge.ui.gtkui.queuedtorrents
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.removetorrentdialog`
==============================================================================
.. automodule:: deluge.ui.gtkui.removetorrentdialog
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.sidebar`
==============================================================================
.. automodule:: deluge.ui.gtkui.sidebar
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.status_tab`
==============================================================================
.. automodule:: deluge.ui.gtkui.status_tab
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.statusbar`
==============================================================================
.. automodule:: deluge.ui.gtkui.statusbar
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.systemtray`
==============================================================================
.. automodule:: deluge.ui.gtkui.systemtray
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.toolbar`
==============================================================================
.. automodule:: deluge.ui.gtkui.toolbar
:show-inheritance:
:members:
:undoc-members:

View File

@ -1,9 +0,0 @@
:mod:`deluge.ui.gtkui.torrentdetails`
==============================================================================
.. automodule:: deluge.ui.gtkui.torrentdetails
:show-inheritance:
:members:
:undoc-members:

Some files were not shown because too many files have changed in this diff Show More