summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Totzke <patricktotzke@gmail.com>2019-08-11 14:34:16 +0100
committerPatrick Totzke <patricktotzke@gmail.com>2019-08-11 14:44:32 +0100
commit411b8754aa5b85a1d5480f44d4829b713aa19314 (patch)
tree127f2a2360a162d8164377eb436e85e26da0a5e3 /docs
parent9b43a27894a029f7be31f44e27e03683c5857dd2 (diff)
pep8 fixes
Diffstat (limited to 'docs')
-rw-r--r--docs/source/api/conf.py98
-rwxr-xr-xdocs/source/generate_commands.py11
-rwxr-xr-xdocs/source/generate_configs.py2
-rw-r--r--docs/source/usage/modes/bufferlist.rst2
-rw-r--r--docs/source/usage/modes/envelope.rst2
-rw-r--r--docs/source/usage/modes/global.rst2
-rw-r--r--docs/source/usage/modes/namedqueries.rst2
-rw-r--r--docs/source/usage/modes/search.rst6
-rw-r--r--docs/source/usage/modes/taglist.rst2
-rw-r--r--docs/source/usage/modes/thread.rst4
10 files changed, 67 insertions, 64 deletions
diff --git a/docs/source/api/conf.py b/docs/source/api/conf.py
index 6277eb4e..6c8be3ed 100644
--- a/docs/source/api/conf.py
+++ b/docs/source/api/conf.py
@@ -11,13 +11,15 @@
#
# All configuration values have a default; values that are commented out
# serve to show the default.
-import sys, os
+import sys
+import os
###############################
# readthedocs.org hack,
# needed to use autodocs on their build-servers:
# http://readthedocs.org/docs/read-the-docs/en/latest/faq.html?highlight=autodocs#where-do-i-need-to-put-my-docs-for-rtd-to-find-it
+
class Mock(object):
def __init__(self, *args, **kwargs):
pass
@@ -29,6 +31,7 @@ class Mock(object):
def __getattr__(cls, name):
return Mock() if name not in ('__file__', '__path__') else '/dev/null'
+
MOCK_MODULES = ['notmuch', 'notmuch.globals',
'urwid',
'magic',
@@ -43,12 +46,12 @@ for mod_name in MOCK_MODULES:
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('..'))
-from alot import __version__,__author__
+from alot import __version__, __author__
-# -- General configuration -----------------------------------------------------
+# -- General configuration -----------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -62,7 +65,7 @@ templates_path = ['_templates']
source_suffix = '.rst'
# The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = 'index'
@@ -82,13 +85,13 @@ release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
+# language = None
# 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'
+# today_fmt = '%B %d, %Y'
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
@@ -96,27 +99,27 @@ exclude_patterns = ['_build']
# 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'
# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
-# -- Options for HTML output ---------------------------------------------------
+# -- Options for HTML output ---------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
@@ -125,26 +128,26 @@ html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-#html_theme_options = {}
+# html_theme_options = {}
# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
# 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 (relative to this directory) 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,
@@ -153,90 +156,89 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# 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_domain_indices = True
+# html_domain_indices = 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, links to the reST sources are added to the pages.
html_show_sourcelink = False
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = 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 = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
# Output file base name for HTML help builder.
htmlhelp_basename = 'alotdoc'
-# -- Options for LaTeX output --------------------------------------------------
+# -- Options for LaTeX output --------------------------------------------
# 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, documentclass
# [howto/manual]).
latex_documents = [
- ('index', 'alot.tex', u'alot Documentation',
- u'Patrick Totzke', 'manual'),
+ ('index', 'alot.tex', 'alot Documentation', 'Patrick Totzke', 'manual'),
]
# 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
# If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
# If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = 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_domain_indices = True
+# latex_domain_indices = True
-# -- Options for manual page output --------------------------------------------
+# -- Options for manual page output --------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
@@ -248,7 +250,7 @@ man_pages = [
autodoc_member_order = 'bysource'
autoclass_content = 'both'
intersphinx_mapping = {
- 'python': ('http://docs.python.org/3.5', None),
- 'notmuch': ('http://packages.python.org/notmuch', None),
- 'urwid': ('http://urwid.readthedocs.org/en/latest', None),
- }
+ 'python': ('http://docs.python.org/3.5', None),
+ 'notmuch': ('http://packages.python.org/notmuch', None),
+ 'urwid': ('http://urwid.readthedocs.org/en/latest', None),
+}
diff --git a/docs/source/generate_commands.py b/docs/source/generate_commands.py
index d2f61003..2677d0f9 100755
--- a/docs/source/generate_commands.py
+++ b/docs/source/generate_commands.py
@@ -45,7 +45,7 @@ def rstify_parser(parser):
out += '.. describe:: %s\n\n' % parser.prog
# description
- out += ' '*4 + parser.description
+ out += ' ' * 4 + parser.description
out += '\n\n'
if len(parser._positionals._group_actions) == 1:
@@ -53,7 +53,7 @@ def rstify_parser(parser):
a = parser._positionals._group_actions[0]
out += ' '*8 + str(parser._positionals._group_actions[0].help)
if a.choices:
- out += "; valid choices are: %s" % ','.join(['\`%s\`' % s for s
+ out += "; valid choices are: %s" % ','.join(['\'%s\'' % s for s
in a.choices])
if a.default:
out += " (defaults to: '%s')" % a.default
@@ -64,7 +64,7 @@ def rstify_parser(parser):
out += " %s: %s" % (index, a.help)
if a.choices:
out += "; valid choices are: %s" % ','.join(
- ['\`%s\`' % s for s in a.choices])
+ ['\'%s\'' % s for s in a.choices])
if a.default:
out += " (defaults to: '%s')" % a.default
out += '\n'
@@ -76,7 +76,7 @@ def rstify_parser(parser):
switches = [s.replace('--', '---') for s in a.option_strings]
out += " :%s: %s" % (', '.join(switches), a.help)
if a.choices and not isinstance(a, BooleanAction):
- out += "; valid choices are: %s" % ','.join(['\`%s\`' % s for s
+ out += "; valid choices are: %s" % ','.join(['\'%s\'' % s for s
in a.choices])
if a.default:
out += " (defaults to: '%s')" % a.default
@@ -85,6 +85,7 @@ def rstify_parser(parser):
return out
+
def get_mode_docs():
docs = {}
b = alot.buffers.Buffer
@@ -105,7 +106,7 @@ if __name__ == "__main__":
modefile.write(NOTE)
if mode != 'global':
modes.append(mode)
- header = 'Commands in `%s` mode' % mode
+ header = 'Commands in \'%s\' mode' % mode
modefile.write('%s\n%s\n' % (header, '-' * len(header)))
modefile.write('The following commands are available in %s mode:'
'\n\n' % mode)
diff --git a/docs/source/generate_configs.py b/docs/source/generate_configs.py
index 8ce483c4..c30f9f04 100755
--- a/docs/source/generate_configs.py
+++ b/docs/source/generate_configs.py
@@ -39,7 +39,7 @@ def rewrite_entries(config, path, specpath, sec=None):
comments = [sec.inline_comments[entry]] + sec.comments[entry]
for c in comments:
if c:
- description += ' '*4 + re.sub('^\s*#', '', c)
+ description += ' ' * 4 + re.sub(r'^\s*#', '', c)
description = description.rstrip(' ') + '\n'
if etype == 'option':
description += '\n :type: option, one of %s\n' % eargs
diff --git a/docs/source/usage/modes/bufferlist.rst b/docs/source/usage/modes/bufferlist.rst
index 673856a3..144bb6fc 100644
--- a/docs/source/usage/modes/bufferlist.rst
+++ b/docs/source/usage/modes/bufferlist.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `bufferlist` mode
+Commands in 'bufferlist' mode
-----------------------------
The following commands are available in bufferlist mode:
diff --git a/docs/source/usage/modes/envelope.rst b/docs/source/usage/modes/envelope.rst
index f003503a..e9689964 100644
--- a/docs/source/usage/modes/envelope.rst
+++ b/docs/source/usage/modes/envelope.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `envelope` mode
+Commands in 'envelope' mode
---------------------------
The following commands are available in envelope mode:
diff --git a/docs/source/usage/modes/global.rst b/docs/source/usage/modes/global.rst
index 3a93090e..260c9dac 100644
--- a/docs/source/usage/modes/global.rst
+++ b/docs/source/usage/modes/global.rst
@@ -194,7 +194,7 @@ The following commands are available globally:
search string
optional arguments
- :---sort: sort order; valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`
+ :---sort: sort order; valid choices are: 'oldest_first','newest_first','message_id','unsorted'
.. _cmd.global.shellescape:
diff --git a/docs/source/usage/modes/namedqueries.rst b/docs/source/usage/modes/namedqueries.rst
index b3aec3fe..ad382358 100644
--- a/docs/source/usage/modes/namedqueries.rst
+++ b/docs/source/usage/modes/namedqueries.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `namedqueries` mode
+Commands in 'namedqueries' mode
-------------------------------
The following commands are available in namedqueries mode:
diff --git a/docs/source/usage/modes/search.rst b/docs/source/usage/modes/search.rst
index c0cc77c5..e413fd11 100644
--- a/docs/source/usage/modes/search.rst
+++ b/docs/source/usage/modes/search.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `search` mode
+Commands in 'search' mode
-------------------------
The following commands are available in search mode:
@@ -25,7 +25,7 @@ The following commands are available in search mode:
search string
optional arguments
- :---sort: sort order; valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`
+ :---sort: sort order; valid choices are: 'oldest_first','newest_first','message_id','unsorted'
.. _cmd.search.refineprompt:
@@ -82,7 +82,7 @@ The following commands are available in search mode:
set sort order
argument
- sort order; valid choices are: \`oldest_first\`,\`newest_first\`,\`message_id\`,\`unsorted\`
+ sort order; valid choices are: 'oldest_first','newest_first','message_id','unsorted'
.. _cmd.search.tag:
diff --git a/docs/source/usage/modes/taglist.rst b/docs/source/usage/modes/taglist.rst
index 83400bbb..08917bb2 100644
--- a/docs/source/usage/modes/taglist.rst
+++ b/docs/source/usage/modes/taglist.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `taglist` mode
+Commands in 'taglist' mode
--------------------------
The following commands are available in taglist mode:
diff --git a/docs/source/usage/modes/thread.rst b/docs/source/usage/modes/thread.rst
index 5fe5686f..2f8ba6e4 100644
--- a/docs/source/usage/modes/thread.rst
+++ b/docs/source/usage/modes/thread.rst
@@ -1,7 +1,7 @@
.. CAUTION: THIS FILE IS AUTO-GENERATED!
-Commands in `thread` mode
+Commands in 'thread' mode
-------------------------
The following commands are available in thread mode:
@@ -72,7 +72,7 @@ The following commands are available in thread mode:
optional arguments
:---all: pass all messages
- :---format: output format; valid choices are: \`raw\`,\`decoded\`,\`id\`,\`filepath\` (defaults to: 'raw')
+ :---format: output format; valid choices are: 'raw','decoded','id','filepath' (defaults to: 'raw')
:---separately: call command once for each message
:---background: don't stop the interface
:---add_tags: add 'Tags' header to the message