Home | History | Annotate | Download | only in documentation
      1 # -*- coding: utf-8 -*-
      2 #
      3 # six documentation build configuration file
      4 
      5 import os
      6 import sys
      7 
      8 # If extensions (or modules to document with autodoc) are in another directory,
      9 # add these directories to sys.path here. If the directory is relative to the
     10 # documentation root, use os.path.abspath to make it absolute, like shown here.
     11 #sys.path.append(os.path.abspath('.'))
     12 
     13 # -- General configuration -----------------------------------------------------
     14 
     15 # If your documentation needs a minimal Sphinx version, state it here.
     16 needs_sphinx = "1.0"
     17 
     18 # Add any Sphinx extension module names here, as strings. They can be extensions
     19 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
     20 extensions = ["sphinx.ext.intersphinx"]
     21 
     22 # Add any paths that contain templates here, relative to this directory.
     23 templates_path = ["_templates"]
     24 
     25 # The suffix of source filenames.
     26 source_suffix = ".rst"
     27 
     28 # The encoding of source files.
     29 #source_encoding = "utf-8-sig"
     30 
     31 # The master toctree document.
     32 master_doc = "index"
     33 
     34 # General information about the project.
     35 project = u"six"
     36 copyright = u"2010-2017, Benjamin Peterson"
     37 
     38 sys.path.append(os.path.abspath(os.path.join(".", "..")))
     39 from six import __version__ as six_version
     40 sys.path.pop()
     41 
     42 # The version info for the project you're documenting, acts as replacement for
     43 # |version| and |release|, also used in various other places throughout the
     44 # built documents.
     45 #
     46 # The short X.Y version.
     47 version = six_version[:-2]
     48 # The full version, including alpha/beta/rc tags.
     49 release = six_version
     50 
     51 # The language for content autogenerated by Sphinx. Refer to documentation
     52 # for a list of supported languages.
     53 #language = None
     54 
     55 # There are two options for replacing |today|: either, you set today to some
     56 # non-false value, then it is used:
     57 #today = ''
     58 # Else, today_fmt is used as the format for a strftime call.
     59 #today_fmt = '%B %d, %Y'
     60 
     61 # List of patterns, relative to source directory, that match files and
     62 # directories to ignore when looking for source files.
     63 exclude_patterns = ["_build"]
     64 
     65 # The reST default role (used for this markup: `text`) to use for all documents.
     66 #default_role = None
     67 
     68 # If true, '()' will be appended to :func: etc. cross-reference text.
     69 #add_function_parentheses = True
     70 
     71 # If true, the current module name will be prepended to all description
     72 # unit titles (such as .. function::).
     73 #add_module_names = True
     74 
     75 # If true, sectionauthor and moduleauthor directives will be shown in the
     76 # output. They are ignored by default.
     77 #show_authors = False
     78 
     79 # The name of the Pygments (syntax highlighting) style to use.
     80 pygments_style = "sphinx"
     81 
     82 # A list of ignored prefixes for module index sorting.
     83 #modindex_common_prefix = []
     84 
     85 
     86 # -- Options for HTML output ---------------------------------------------------
     87 
     88 # The theme to use for HTML and HTML Help pages.  See the documentation for
     89 # a list of builtin themes.
     90 html_theme = "default"
     91 
     92 # Theme options are theme-specific and customize the look and feel of a theme
     93 # further.  For a list of options available for each theme, see the
     94 # documentation.
     95 #html_theme_options = {}
     96 
     97 # Add any paths that contain custom themes here, relative to this directory.
     98 #html_theme_path = []
     99 
    100 # The name for this set of Sphinx documents.  If None, it defaults to
    101 # "<project> v<release> documentation".
    102 #html_title = None
    103 
    104 # A shorter title for the navigation bar.  Default is the same as html_title.
    105 #html_short_title = None
    106 
    107 # The name of an image file (relative to this directory) to place at the top
    108 # of the sidebar.
    109 #html_logo = None
    110 
    111 # The name of an image file (within the static path) to use as favicon of the
    112 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
    113 # pixels large.
    114 #html_favicon = None
    115 
    116 # Add any paths that contain custom static files (such as style sheets) here,
    117 # relative to this directory. They are copied after the builtin static files,
    118 # so a file named "default.css" will overwrite the builtin "default.css".
    119 html_static_path = ["_static"]
    120 
    121 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
    122 # using the given strftime format.
    123 #html_last_updated_fmt = '%b %d, %Y'
    124 
    125 # If true, SmartyPants will be used to convert quotes and dashes to
    126 # typographically correct entities.
    127 #html_use_smartypants = True
    128 
    129 # Custom sidebar templates, maps document names to template names.
    130 #html_sidebars = {}
    131 
    132 # Additional templates that should be rendered to pages, maps page names to
    133 # template names.
    134 #html_additional_pages = {}
    135 
    136 # If false, no module index is generated.
    137 #html_domain_indices = True
    138 
    139 # If false, no index is generated.
    140 #html_use_index = True
    141 
    142 # If true, the index is split into individual pages for each letter.
    143 #html_split_index = False
    144 
    145 # If true, links to the reST sources are added to the pages.
    146 #html_show_sourcelink = True
    147 
    148 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
    149 #html_show_sphinx = True
    150 
    151 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
    152 #html_show_copyright = True
    153 
    154 # If true, an OpenSearch description file will be output, and all pages will
    155 # contain a <link> tag referring to it.  The value of this option must be the
    156 # base URL from which the finished HTML is served.
    157 #html_use_opensearch = ''
    158 
    159 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
    160 #html_file_suffix = ''
    161 
    162 # Output file base name for HTML help builder.
    163 htmlhelp_basename = 'sixdoc'
    164 
    165 
    166 # -- Options for LaTeX output --------------------------------------------------
    167 
    168 # The paper size ('letter' or 'a4').
    169 #latex_paper_size = 'letter'
    170 
    171 # The font size ('10pt', '11pt' or '12pt').
    172 #latex_font_size = '10pt'
    173 
    174 # Grouping the document tree into LaTeX files. List of tuples
    175 # (source start file, target name, title, author, documentclass [howto/manual]).
    176 latex_documents = [
    177   ("index", "six.tex", u"six Documentation",
    178    u"Benjamin Peterson", "manual"),
    179 ]
    180 
    181 # The name of an image file (relative to this directory) to place at the top of
    182 # the title page.
    183 #latex_logo = None
    184 
    185 # For "manual" documents, if this is true, then toplevel headings are parts,
    186 # not chapters.
    187 #latex_use_parts = False
    188 
    189 # If true, show page references after internal links.
    190 #latex_show_pagerefs = False
    191 
    192 # If true, show URL addresses after external links.
    193 #latex_show_urls = False
    194 
    195 # Additional stuff for the LaTeX preamble.
    196 #latex_preamble = ''
    197 
    198 # Documents to append as an appendix to all manuals.
    199 #latex_appendices = []
    200 
    201 # If false, no module index is generated.
    202 #latex_domain_indices = True
    203 
    204 
    205 # -- Options for manual page output --------------------------------------------
    206 
    207 # One entry per manual page. List of tuples
    208 # (source start file, name, description, authors, manual section).
    209 man_pages = [
    210     ("index", "six", u"six Documentation",
    211      [u"Benjamin Peterson"], 1)
    212 ]
    213 
    214 # -- Intersphinx ---------------------------------------------------------------
    215 
    216 intersphinx_mapping = {"py2" : ("https://docs.python.org/2/", None),
    217                        "py3" : ("https://docs.python.org/3/", None)}
    218