doc/conf.py - platform/external/python/pyopenssl - Git at Google

 # -*- coding: utf-8 -*-
 #
 # pyOpenSSL documentation build configuration file, created by
 # sphinx-quickstart on Sat Jul 16 07:12:22 2011.
 #
 # This file is execfile()d with the current directory set to its parent 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 codecs
 import os
 import re
 import sys


 HERE = os.path.abspath(os.path.dirname(__file__))


 def read_file(*parts):
     """
     Build an absolute path from *parts* and return the contents of the
     resulting file.  Assume UTF-8 encoding.
     """
     with codecs.open(os.path.join(HERE, *parts), "rb", "ascii") as f:
         return f.read()


 def find_version(*file_paths):
     version_file = read_file(*file_paths)
     version_match = re.search(
         r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M
     )
     if version_match:
         return version_match.group(1)
     raise RuntimeError("Unable to find version string.")


 DOC_DIR = os.path.abspath(os.path.dirname(__file__))
 sys.path.insert(0, os.path.abspath(os.path.join(DOC_DIR, "..")))

 # If extensions (or modules to document with autodoc) are in another directory,
 # 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('.'))

 # -- 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",
 ]

 # 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 = u"pyOpenSSL"
 authors = u"The pyOpenSSL developers"
 copyright = u"2001 " + authors

 # 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 = find_version("..", "src", "OpenSSL", "version.py")
 # The full version, including alpha/beta/rc tags.
 release = 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 not on_rtd:  # only import and set the theme if we're building docs locally
     import sphinx_rtd_theme

     html_theme = "sphinx_rtd_theme"
     html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

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

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


 # -- 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", "pyOpenSSL.tex", u"pyOpenSSL Documentation", authors, "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

 # 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", "pyopenssl", u"pyOpenSSL Documentation", [authors], 1)]

 intersphinx_mapping = {
     "https://docs.python.org/3": None,
     "https://cryptography.io/en/latest/": None,
 }
	# -- coding: utf-8 --
	#
	# pyOpenSSL documentation build configuration file, created by
	# sphinx-quickstart on Sat Jul 16 07:12:22 2011.
	#
	# This file is execfile()d with the current directory set to its parent 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 codecs
	import os
	import re
	import sys


	HERE = os.path.abspath(os.path.dirname(__file__))


	def read_file(*parts):
	"""
	Build an absolute path from parts and return the contents of the
	resulting file. Assume UTF-8 encoding.
	"""
	with codecs.open(os.path.join(HERE, *parts), "rb", "ascii") as f:
	return f.read()


	def find_version(*file_paths):
	version_file = read_file(*file_paths)
	version_match = re.search(
	r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M
	)
	if version_match:
	return version_match.group(1)
	raise RuntimeError("Unable to find version string.")


	DOC_DIR = os.path.abspath(os.path.dirname(__file__))
	sys.path.insert(0, os.path.abspath(os.path.join(DOC_DIR, "..")))

	# If extensions (or modules to document with autodoc) are in another directory,
	# 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('.'))

	# -- 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",
	]

	# 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 = u"pyOpenSSL"
	authors = u"The pyOpenSSL developers"
	copyright = u"2001 " + authors

	# 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 = find_version("..", "src", "OpenSSL", "version.py")
	# The full version, including alpha/beta/rc tags.
	release = 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 not on_rtd: # only import and set the theme if we're building docs locally
	import sphinx_rtd_theme

	html_theme = "sphinx_rtd_theme"
	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

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

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


	# -- 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", "pyOpenSSL.tex", u"pyOpenSSL Documentation", authors, "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

	# 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", "pyopenssl", u"pyOpenSSL Documentation", [authors], 1)]

	intersphinx_mapping = {
	"https://docs.python.org/3": None,
	"https://cryptography.io/en/latest/": None,
	}