python/virtualenv/docs/conf.py

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 # -*- coding: utf-8 -*-
     2 #
     3 # Paste documentation build configuration file, created by
     4 # sphinx-quickstart on Tue Apr 22 22:08:49 2008.
     5 #
     6 # This file is execfile()d with the current directory set to its containing dir.
     7 #
     8 # The contents of this file are pickled, so don't put values in the namespace
     9 # that aren't pickleable (module imports are okay, they're removed automatically).
    10 #
    11 # All configuration values have a default value; values that are commented out
    12 # serve to show the default value.
    14 import os
    15 import sys
    17 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
    19 # If your extensions are in another directory, add it here.
    20 sys.path.insert(0, os.path.abspath(os.pardir))
    22 # General configuration
    23 # ---------------------
    25 # Add any Sphinx extension module names here, as strings. They can be extensions
    26 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
    27 extensions = ['sphinx.ext.autodoc']
    29 # Add any paths that contain templates here, relative to this directory.
    30 ## FIXME: disabled for now because I haven't figured out how to use this:
    31 #templates_path = ['_templates']
    33 # The suffix of source filenames.
    34 source_suffix = '.rst'
    36 # The master toctree document.
    37 master_doc = 'index'
    39 # General substitutions.
    40 project = 'virtualenv'
    41 copyright = '2007-2014, Ian Bicking, The Open Planning Project, PyPA'
    43 # The default replacements for |version| and |release|, also used in various
    44 # other places throughout the built documents.
    45 try:
    46     from virtualenv import __version__
    47     # The short X.Y version.
    48     version = '.'.join(__version__.split('.')[:2])
    49     # The full version, including alpha/beta/rc tags.
    50     release = __version__
    51 except ImportError:
    52     version = release = 'dev'
    54 # There are two options for replacing |today|: either, you set today to some
    55 # non-false value, then it is used:
    56 #today = ''
    57 # Else, today_fmt is used as the format for a strftime call.
    58 today_fmt = '%B %d, %Y'
    60 # List of documents that shouldn't be included in the build.
    61 unused_docs = []
    63 # If true, '()' will be appended to :func: etc. cross-reference text.
    64 #add_function_parentheses = True
    66 # If true, the current module name will be prepended to all description
    67 # unit titles (such as .. function::).
    68 #add_module_names = True
    70 # If true, sectionauthor and moduleauthor directives will be shown in the
    71 # output. They are ignored by default.
    72 #show_authors = False
    74 # The name of the Pygments (syntax highlighting) style to use.
    75 pygments_style = 'sphinx'
    78 # Options for HTML output
    79 # -----------------------
    81 # The style sheet to use for HTML and HTML Help pages. A file of that name
    82 # must exist either in Sphinx' static/ path, or in one of the custom paths
    83 # given in html_static_path.
    84 #html_style = 'default.css'
    86 if os.environ.get('DOCS_LOCAL'):
    87     import sphinx_rtd_theme
    88     html_theme = "sphinx_rtd_theme"
    89     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
    90 else:
    91     # on RTD
    92     html_theme = 'default'
    95 # Add any paths that contain custom static files (such as style sheets) here,
    96 # relative to this directory. They are copied after the builtin static files,
    97 # so a file named "default.css" will overwrite the builtin "default.css".
    98 # html_static_path = ['_static']
   100 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
   101 # using the given strftime format.
   102 html_last_updated_fmt = '%b %d, %Y'
   104 # If true, SmartyPants will be used to convert quotes and dashes to
   105 # typographically correct entities.
   106 #html_use_smartypants = True
   108 # Content template for the index page.
   109 #html_index = ''
   111 # Custom sidebar templates, maps document names to template names.
   112 #html_sidebars = {}
   114 # Additional templates that should be rendered to pages, maps page names to
   115 # template names.
   116 #html_additional_pages = {}
   118 # If false, no module index is generated.
   119 #html_use_modindex = True
   121 # If true, the reST sources are included in the HTML build as _sources/<name>.
   122 #html_copy_source = True
   124 # Output file base name for HTML help builder.
   125 htmlhelp_basename = 'Pastedoc'
   128 # Options for LaTeX output
   129 # ------------------------
   131 # The paper size ('letter' or 'a4').
   132 #latex_paper_size = 'letter'
   134 # The font size ('10pt', '11pt' or '12pt').
   135 #latex_font_size = '10pt'
   137 # Grouping the document tree into LaTeX files. List of tuples
   138 # (source start file, target name, title, author, document class [howto/manual]).
   139 #latex_documents = []
   141 # Additional stuff for the LaTeX preamble.
   142 #latex_preamble = ''
   144 # Documents to append as an appendix to all manuals.
   145 #latex_appendices = []
   147 # If false, no module index is generated.
   148 #latex_use_modindex = True

mercurial