summaryrefslogtreecommitdiffstats
path: root/docs/source/conf.py
diff options
context:
space:
mode:
authorCalum Lind <calumlind+deluge@gmail.com>2014-09-22 12:43:28 +0100
committerCalum Lind <calumlind+deluge@gmail.com>2014-09-22 12:46:18 +0100
commit83262afda1d6092a62df1fc1f91a999d1d77a544 (patch)
tree8d7678960d97cd2f17999161c59044caca605022 /docs/source/conf.py
parent142e96b2465315fc5ba3b69223c0638a7bad25e1 (diff)
downloaddeluge-83262afda1d6092a62df1fc1f91a999d1d77a544.tar.gz
deluge-83262afda1d6092a62df1fc1f91a999d1d77a544.tar.bz2
deluge-83262afda1d6092a62df1fc1f91a999d1d77a544.zip
Flake8 codebase
Fixes error E265 and E714 that have been added to newest version of pep8
Diffstat (limited to 'docs/source/conf.py')
-rw-r--r--docs/source/conf.py59
1 files changed, 32 insertions, 27 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index bfbae84cd..fb5c9037b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -21,6 +21,8 @@ try:
except ImportError:
get_version = None
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
# 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.
@@ -52,6 +54,9 @@ MOCK_MODULES = ['deluge.ui.languages', 'deluge.ui.countries', 'deluge.ui.gtkui.g
'deluge.libtorrent', 'psyco', 'rencode', 'win32file', 'win32event',
'win32gui', 'win32api', 'win32con', '_winreg']
+if on_rtd:
+ MOCK_MODULES += ['libtorrent', 'pytgtk']
+
for mod_name in MOCK_MODULES:
sys.modules[mod_name] = Mock()
@@ -93,31 +98,31 @@ release = version
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
-#today = ''
+# today = ''
# Else, today_fmt is used as the format for a strftime call.
today_fmt = '%B %d, %Y'
# List of documents that shouldn't be included in the build.
-#unused_docs = []
+# unused_docs = []
# List of directories, relative to source directories, that shouldn't be searched
# for source files.
-#exclude_dirs = []
+# 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
+# default_role = None
# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
-#show_authors = False
+# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
@@ -133,19 +138,19 @@ html_style = 'default.css'
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
-#html_title = None
+# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
# The name of an image file (within the static path) to place at the top of
# the sidebar.
-#html_logo = None
+# html_logo = None
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
-#html_favicon = None
+# html_favicon = None
# 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,
@@ -158,34 +163,34 @@ html_last_updated_fmt = '%b %d, %Y'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
# If false, no module index is generated.
-#html_use_modindex = True
+# html_use_modindex = True
# If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
# If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
# If true, the reST sources are included in the HTML build as _sources/<name>.
-#html_copy_source = True
+# html_copy_source = True
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = ''
+# html_file_suffix = ''
# Output file base name for HTML help builder.
htmlhelp_basename = 'delugedoc'
@@ -195,10 +200,10 @@ htmlhelp_basename = 'delugedoc'
# ------------------------
# The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
# The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, document class [howto/manual]).
@@ -209,17 +214,17 @@ latex_documents = [
# The name of an image file (relative to this directory) to place at the top of
# the title page.
-#latex_logo = None
+# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
# Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
# Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
# If false, no module index is generated.
-#latex_use_modindex = True
+# latex_use_modindex = True