src/third_party/mozjs-45/python/psutil/docs/conf.py - cobalt - Git at Google

 # -*- coding: utf-8 -*-
 #
 # psutil documentation build configuration file, created by
 # sphinx-quickstart.
 #
 # 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 datetime
 import os


 PROJECT_NAME = "psutil"
 AUTHOR = "Giampaolo Rodola'"
 THIS_YEAR = str(datetime.datetime.now().year)
 HERE = os.path.abspath(os.path.dirname(__file__))


 def get_version():
     INIT = os.path.abspath(os.path.join(HERE, '../psutil/__init__.py'))
     with open(INIT, 'r') as f:
         for line in f:
             if line.startswith('__version__'):
                 ret = eval(line.strip().split(' = ')[1])
                 assert ret.count('.') == 2, ret
                 for num in ret.split('.'):
                     assert num.isdigit(), ret
                 return ret
         else:
             raise ValueError("couldn't find version string")

 VERSION = get_version()

 # 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.coverage',
               'sphinx.ext.pngmath',
               'sphinx.ext.viewcode',
               'sphinx.ext.intersphinx']

 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_template']

 # 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 = PROJECT_NAME
 copyright = '2009-%s, %s' % (THIS_YEAR, AUTHOR)

 # 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 = 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

 autodoc_docstring_signature = 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.

 # 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 = 'pydoctheme'
 html_theme_options = {'collapsiblesidebar': True}

 # Add any paths that contain custom themes here, relative to this directory.
 html_theme_path = ["_themes"]

 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 html_title = "{project} {version} documentation".format(**locals())

 # 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 = 'logo.png'

 # 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 = '_static/favicon.ico'

 # 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 = {
     'index': 'indexsidebar.html',
     '**': ['globaltoc.html',
            'relations.html',
            'sourcelink.html',
            'searchbox.html']
 }

 # Additional templates that should be rendered to pages, maps page names to
 # template names.
 # html_additional_pages = {
 #    'index': 'indexcontent.html',
 # }

 # If false, no module index is generated.
 html_domain_indices = False

 # 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 = '%s-doc' % PROJECT_NAME

 # -- Options for LaTeX output ------------------------------------------------

 # The paper size ('letter' or 'a4').
 # latex_paper_size = 'letter'

 # 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]).
 latex_documents = [
     ('index', '%s.tex' % PROJECT_NAME,
      '%s documentation' % PROJECT_NAME, AUTHOR),
 ]

 # 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

 # Additional stuff for the LaTeX preamble.
 # latex_preamble = ''

 # 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', PROJECT_NAME, '%s documentation' % PROJECT_NAME, [AUTHOR], 1)
 ]

 # If true, show URL addresses after external links.
 # man_show_urls = False
	# -- coding: utf-8 --
	#
	# psutil documentation build configuration file, created by
	# sphinx-quickstart.
	#
	# 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 datetime
	import os


	PROJECT_NAME = "psutil"
	AUTHOR = "Giampaolo Rodola'"
	THIS_YEAR = str(datetime.datetime.now().year)
	HERE = os.path.abspath(os.path.dirname(__file__))


	def get_version():
	INIT = os.path.abspath(os.path.join(HERE, '../psutil/__init__.py'))
	with open(INIT, 'r') as f:
	for line in f:
	if line.startswith('__version__'):
	ret = eval(line.strip().split(' = ')[1])
	assert ret.count('.') == 2, ret
	for num in ret.split('.'):
	assert num.isdigit(), ret
	return ret
	else:
	raise ValueError("couldn't find version string")

	VERSION = get_version()

	# 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.coverage',
	'sphinx.ext.pngmath',
	'sphinx.ext.viewcode',
	'sphinx.ext.intersphinx']

	# Add any paths that contain templates here, relative to this directory.
	templates_path = ['_template']

	# 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 = PROJECT_NAME
	copyright = '2009-%s, %s' % (THIS_YEAR, AUTHOR)

	# 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 = 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

	autodoc_docstring_signature = 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.

	# 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 = 'pydoctheme'
	html_theme_options = {'collapsiblesidebar': True}

	# Add any paths that contain custom themes here, relative to this directory.
	html_theme_path = ["_themes"]

	# The name for this set of Sphinx documents. If None, it defaults to
	# "<project> v<release> documentation".
	html_title = "{project} {version} documentation".format(**locals())

	# 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 = 'logo.png'

	# 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 = '_static/favicon.ico'

	# 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 = {
	'index': 'indexsidebar.html',
	'**': ['globaltoc.html',
	'relations.html',
	'sourcelink.html',
	'searchbox.html']
	}

	# Additional templates that should be rendered to pages, maps page names to
	# template names.
	# html_additional_pages = {
	# 'index': 'indexcontent.html',
	# }

	# If false, no module index is generated.
	html_domain_indices = False

	# 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 = '%s-doc' % PROJECT_NAME

	# -- Options for LaTeX output ------------------------------------------------

	# The paper size ('letter' or 'a4').
	# latex_paper_size = 'letter'

	# 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]).
	latex_documents = [
	('index', '%s.tex' % PROJECT_NAME,
	'%s documentation' % PROJECT_NAME, AUTHOR),
	]

	# 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

	# Additional stuff for the LaTeX preamble.
	# latex_preamble = ''

	# 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', PROJECT_NAME, '%s documentation' % PROJECT_NAME, [AUTHOR], 1)
	]

	# If true, show URL addresses after external links.
	# man_show_urls = False