diff --git a/docs/conf.py b/docs/conf.py index 8129adec..e37f5713 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -3,7 +3,8 @@ # Mopidy documentation build configuration file, created by # sphinx-quickstart on Fri Feb 5 22:19:08 2010. # -# This file is execfile()d with the current directory set to its containing dir. +# This file is execfile()d with the current directory set to its containing +# dir. # # Note that not all possible configuration values are present in this # autogenerated file. @@ -12,9 +13,9 @@ # serve to show the default. import os -import re import sys + class Mock(object): def __init__(self, *args, **kwargs): pass @@ -34,6 +35,7 @@ class Mock(object): else: return Mock() + MOCK_MODULES = [ 'dbus', 'dbus.mainloop', @@ -63,12 +65,16 @@ sys.path.insert(0, os.path.abspath(os.path.dirname(__file__) + '/../')) # the string True. on_rtd = os.environ.get('READTHEDOCS', None) == 'True' -# -- General configuration ----------------------------------------------------- +# -- 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.graphviz', - 'sphinx.ext.extlinks', 'sphinx.ext.viewcode'] +# 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.extlinks', + 'sphinx.ext.graphviz', + 'sphinx.ext.viewcode', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -114,7 +120,8 @@ version = '.'.join(release.split('.')[:2]) # for source files. exclude_trees = ['_build'] -# The reST default role (used for this markup: `text`) to use for all documents. +# The reST default role (used for this markup: `text`) to use for all +# documents. #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. @@ -135,7 +142,7 @@ pygments_style = 'sphinx' modindex_common_prefix = ['mopidy.'] -# -- Options for HTML output --------------------------------------------------- +# -- Options for HTML output -------------------------------------------------- # The theme to use for HTML and HTML Help pages. Major themes that come with # Sphinx are currently 'default' and 'sphinxdoc'. @@ -210,7 +217,7 @@ html_static_path = ['_static'] htmlhelp_basename = 'Mopidydoc' -# -- Options for LaTeX output -------------------------------------------------- +# -- Options for LaTeX output ------------------------------------------------- # The paper size ('letter' or 'a4'). #latex_paper_size = 'letter' @@ -218,11 +225,16 @@ htmlhelp_basename = 'Mopidydoc' # The font size ('10pt', '11pt' or '12pt'). #latex_font_size = '10pt' -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass [howto/manual]). +# Grouping the document tree into LaTeX files. List of tuples (source start +# file, target name, title, author, documentclass [howto/manual]). latex_documents = [ - ('index', 'Mopidy.tex', u'Mopidy Documentation', - u'Stein Magnus Jodal', 'manual'), + ( + 'index', + 'Mopidy.tex', + u'Mopidy Documentation', + u'Stein Magnus Jodal', + 'manual' + ), ] # The name of an image file (relative to this directory) to place at the top of