flake8 sphinx conf, bootstrap stuff

Author: tony

bootstrap_env.py

@@ -1,7 +1,6 @@
 #!/usr/bin/env python
 
-from __future__ import (absolute_import, division, print_function,
-                        unicode_literals, with_statement)
+from __future__ import absolute_import, print_function, unicode_literals
 
 import os
 import subprocess
@@ -16,9 +15,6 @@ def fail(message):
     sys.exit("Error: {message}".format(message=message))
 
 
-PY2 = sys.version_info[0] == 2
-
-
 def has_module(module_name):
     try:
         import imp
@@ -77,6 +73,8 @@ def which(exe=None, throw=True):
 sphinx_requirements_filepath = os.path.join(
     project_dir, 'requirements', 'doc.txt'
 )
+test_requirements_filepath = os.path.join(
+    project_dir, 'requirements', 'test.txt')
 
 
 try:
@@ -121,6 +119,11 @@ def main():
             [pip_bin, 'install', '-e', project_dir]
         )
 
+    if not has_module('pytest'):
+        subprocess.check_call(
+            [pip_bin, 'install', '-r', test_requirements_filepath]
+        )
+
     if not os.path.isfile(os.path.join(env_dir, 'bin', 'sphinx-quickstart')):
         subprocess.check_call(
             [pip_bin, 'install', '-r', sphinx_requirements_filepath]

doc/conf.py

@@ -1,121 +1,49 @@
 # -*- coding: utf-8 -*-
-#
-# libtmux documentation build configuration file, created by
-# sphinx-quickstart on Sun Sep  8 17:59:29 2013.
-#
-# 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.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
 
 import os
 import sys
 
-from libtmux import __version__, test
-
 # Get the project root dir, which is the parent dir of this
 cwd = os.getcwd()
 project_root = os.path.dirname(cwd)
 
-# Insert the project root dir as the first element in the PYTHONPATH.
-# This lets us ensure that the source package is imported, and that its
-# version is used.
 sys.path.insert(0, project_root)
-sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
+
+from libtmux import test  # NOQA
 
 # package data
 about = {}
 with open("../libtmux/__about__.py") as fp:
     exec(fp.read(), about)
 
 
-# -- General configuration -----------------------------------------------------
-
-
-# If your documentation needs a minimal Sphinx version, state it here.
-#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 ones.
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
               'releases',
               ]
 
-# 'releases' (changelog) settings
 releases_unstable_prehistory = True
 releases_document_name = "history"
 releases_issue_uri = "https://github.com/tony/libtmux/issues/%s"
 releases_release_uri = "https://github.com/tony/libtmux/tree/%s"
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
-# The suffix of source filenames.
 source_suffix = '.rst'
 
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
-# The master toctree document.
 master_doc = 'index'
 
-# General information about the project.
 project = about['__title__']
 copyright = about['__copyright__']
 
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
 version = '%s' % ('.'.join(about['__version__'].split('.'))[:2])
-# The full version, including alpha/beta/rc tags.
 release = '%s' % (about['__version__'])
 
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
 exclude_patterns = ['_build']
 
-# 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.
-#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
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#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 = []
-
-
-# -- Options for HTML output ---------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 if on_rtd:
     html_theme = 'default'
@@ -127,169 +55,27 @@
     except ImportError:
         html_theme = 'pyramid'
 
-#html_theme = 'sphinx_rtd_theme'
-
-# 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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ['_themes']
-#html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
-
-# from pyramid_sphinx_themes import get_html_themes_path
-# html_theme_path = get_html_themes_path()
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-#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
-
-# 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
-
-# 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']
-
-# 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'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
 
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is 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 = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = '%sdoc' % about['__title__']
 
-# -- Options for LaTeX output --------------------------------------------------
-
-latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', '{0}.tex'.format(about['__package_name__']), '{0} Documentation'.format(about['__title__']),
-   about['__author__'], 'manual'),
+    ('index', '{0}.tex'.format(about['__package_name__']),
+     '{0} Documentation'.format(about['__title__']),
+     about['__author__'], 'manual'),
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
-
-
-# -- Options for manual page output --------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', about['__package_name__'], '{0} Documentation'.format(about['__title__']),
-    about['__author__'], 1),
+    ('index', about['__package_name__'],
+     '{0} Documentation'.format(about['__title__']),
+     about['__author__'], 1),
 ]
 
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-
-# -- Options for Texinfo output ------------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
 texinfo_documents = [
-    ('index', '{0}'.format(about['__package_name__']), '{0} Documentation'.format(about['__title__']),
-    about['__author__'], about['__package_name__'], about['__description__'], 'Miscellaneous'),
+    ('index', '{0}'.format(about['__package_name__']),
+     '{0} Documentation'.format(about['__title__']),
+     about['__author__'], about['__package_name__'],
+     about['__description__'], 'Miscellaneous'),
 ]
 
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-#texinfo_no_detailmenu = False
-
-# Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {'http://docs.python.org/': None}
-
-# aafig format, try to get working with pdf
-aafig_format = dict(latex='pdf', html='gif')
-
-aafig_default_options = dict(
-    scale=.75,
-    aspect=0.5,
-    proportional=True,
-)