423 lines
13 KiB
Python
423 lines
13 KiB
Python
#
|
||
# pytest documentation build configuration file, created by
|
||
# sphinx-quickstart on Fri Oct 8 17:54:28 2010.
|
||
#
|
||
# 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.
|
||
# 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 full version, including alpha/beta/rc tags.
|
||
# The short X.Y version.
|
||
import ast
|
||
import os
|
||
import sys
|
||
from typing import List
|
||
from typing import TYPE_CHECKING
|
||
|
||
from _pytest import __version__ as version
|
||
|
||
if TYPE_CHECKING:
|
||
import sphinx.application
|
||
|
||
|
||
release = ".".join(version.split(".")[:2])
|
||
|
||
# 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('.'))
|
||
|
||
autodoc_member_order = "bysource"
|
||
autodoc_typehints = "description"
|
||
todo_include_todos = 1
|
||
|
||
# -- 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 = [
|
||
"pallets_sphinx_themes",
|
||
"pygments_pytest",
|
||
"sphinx.ext.autodoc",
|
||
"sphinx.ext.autosummary",
|
||
"sphinx.ext.intersphinx",
|
||
"sphinx.ext.todo",
|
||
"sphinx.ext.viewcode",
|
||
"sphinx_removed_in",
|
||
"sphinxcontrib_trio",
|
||
]
|
||
|
||
# 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 = "contents"
|
||
|
||
# General information about the project.
|
||
project = "pytest"
|
||
copyright = "2015–2021, holger krekel and pytest-dev team"
|
||
|
||
|
||
# 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",
|
||
"naming20.rst",
|
||
"test/*",
|
||
"old_*",
|
||
"*attic*",
|
||
"*/attic*",
|
||
"funcargs.rst",
|
||
"setup.rst",
|
||
"example/remoteinterp.rst",
|
||
]
|
||
|
||
|
||
# The reST default role (used for this markup: `text`) to use for all documents.
|
||
default_role = "literal"
|
||
|
||
# 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 = False
|
||
|
||
# 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 = []
|
||
|
||
# A list of regular expressions that match URIs that should not be checked when
|
||
# doing a linkcheck.
|
||
linkcheck_ignore = [
|
||
"https://github.com/numpy/numpy/blob/master/doc/release/1.16.0-notes.rst#new-deprecations",
|
||
"https://blogs.msdn.microsoft.com/bharry/2017/06/28/testing-in-a-cloud-delivery-cadence/",
|
||
"http://pythontesting.net/framework/pytest-introduction/",
|
||
r"https://github.com/pytest-dev/pytest/issues/\d+",
|
||
r"https://github.com/pytest-dev/pytest/pull/\d+",
|
||
]
|
||
|
||
# The number of worker threads to use when checking links (default=5).
|
||
linkcheck_workers = 5
|
||
|
||
|
||
# -- Options for HTML output ---------------------------------------------------
|
||
|
||
sys.path.append(os.path.abspath("_themes"))
|
||
html_theme_path = ["_themes"]
|
||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||
# a list of builtin themes.
|
||
html_theme = "flask"
|
||
|
||
# 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 = {"index_logo": None}
|
||
|
||
# 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 = "pytest documentation"
|
||
|
||
# A shorter title for the navigation bar. Default is the same as html_title.
|
||
html_short_title = "pytest-%s" % release
|
||
|
||
# The name of an image file (relative to this directory) to place at the top
|
||
# of the sidebar.
|
||
html_logo = "img/pytest_logo_curves.svg"
|
||
|
||
# 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 = "img/favicon.png"
|
||
|
||
# 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 = {}
|
||
# html_sidebars = {'index': 'indexsidebar.html'}
|
||
|
||
html_sidebars = {
|
||
"index": [
|
||
"slim_searchbox.html",
|
||
"sidebarintro.html",
|
||
"globaltoc.html",
|
||
"links.html",
|
||
"sourcelink.html",
|
||
],
|
||
"**": [
|
||
"slim_searchbox.html",
|
||
"globaltoc.html",
|
||
"relations.html",
|
||
"links.html",
|
||
"sourcelink.html",
|
||
],
|
||
}
|
||
|
||
# Additional templates that should be rendered to pages, maps page names to
|
||
# template names.
|
||
# html_additional_pages = {}
|
||
# html_additional_pages = {'index': 'index.html'}
|
||
|
||
|
||
# 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 = False
|
||
|
||
# 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 = "pytestdoc"
|
||
|
||
|
||
# -- 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 = [
|
||
(
|
||
"contents",
|
||
"pytest.tex",
|
||
"pytest Documentation",
|
||
"holger krekel, trainer and consultant, https://merlinux.eu/",
|
||
"manual",
|
||
)
|
||
]
|
||
|
||
# The name of an image file (relative to this directory) to place at the top of
|
||
# the title page.
|
||
latex_logo = "img/pytest1.png"
|
||
|
||
# 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 = False
|
||
|
||
# -- Options for manual page output --------------------------------------------
|
||
|
||
# One entry per manual page. List of tuples
|
||
# (source start file, name, description, authors, manual section).
|
||
man_pages = [("usage", "pytest", "pytest usage", ["holger krekel at merlinux eu"], 1)]
|
||
|
||
|
||
# -- Options for Epub output ---------------------------------------------------
|
||
|
||
# Bibliographic Dublin Core info.
|
||
epub_title = "pytest"
|
||
epub_author = "holger krekel at merlinux eu"
|
||
epub_publisher = "holger krekel at merlinux eu"
|
||
epub_copyright = "2013-2021, holger krekel et alii"
|
||
|
||
# The language of the text. It defaults to the language option
|
||
# or en if the language is not set.
|
||
# epub_language = ''
|
||
|
||
# The scheme of the identifier. Typical schemes are ISBN or URL.
|
||
# epub_scheme = ''
|
||
|
||
# The unique identifier of the text. This can be a ISBN number
|
||
# or the project homepage.
|
||
# epub_identifier = ''
|
||
|
||
# A unique identification for the text.
|
||
# epub_uid = ''
|
||
|
||
# HTML files that should be inserted before the pages created by sphinx.
|
||
# The format is a list of tuples containing the path and title.
|
||
# epub_pre_files = []
|
||
|
||
# HTML files shat should be inserted after the pages created by sphinx.
|
||
# The format is a list of tuples containing the path and title.
|
||
# epub_post_files = []
|
||
|
||
# A list of files that should not be packed into the epub file.
|
||
# epub_exclude_files = []
|
||
|
||
# The depth of the table of contents in toc.ncx.
|
||
# epub_tocdepth = 3
|
||
|
||
# Allow duplicate toc entries.
|
||
# epub_tocdup = True
|
||
|
||
|
||
# -- Options for texinfo output ------------------------------------------------
|
||
|
||
texinfo_documents = [
|
||
(
|
||
master_doc,
|
||
"pytest",
|
||
"pytest Documentation",
|
||
(
|
||
"Holger Krekel@*Benjamin Peterson@*Ronny Pfannschmidt@*"
|
||
"Floris Bruynooghe@*others"
|
||
),
|
||
"pytest",
|
||
"simple powerful testing with Python",
|
||
"Programming",
|
||
1,
|
||
)
|
||
]
|
||
|
||
|
||
# Example configuration for intersphinx: refer to the Python standard library.
|
||
intersphinx_mapping = {
|
||
"pluggy": ("https://pluggy.readthedocs.io/en/stable", None),
|
||
"python": ("https://docs.python.org/3", None),
|
||
}
|
||
|
||
|
||
def configure_logging(app: "sphinx.application.Sphinx") -> None:
|
||
"""Configure Sphinx's WarningHandler to handle (expected) missing include."""
|
||
import sphinx.util.logging
|
||
import logging
|
||
|
||
class WarnLogFilter(logging.Filter):
|
||
def filter(self, record: logging.LogRecord) -> bool:
|
||
"""Ignore warnings about missing include with "only" directive.
|
||
|
||
Ref: https://github.com/sphinx-doc/sphinx/issues/2150."""
|
||
if (
|
||
record.msg.startswith('Problems with "include" directive path:')
|
||
and "_changelog_towncrier_draft.rst" in record.msg
|
||
):
|
||
return False
|
||
return True
|
||
|
||
logger = logging.getLogger(sphinx.util.logging.NAMESPACE)
|
||
warn_handler = [x for x in logger.handlers if x.level == logging.WARNING]
|
||
assert len(warn_handler) == 1, warn_handler
|
||
warn_handler[0].filters.insert(0, WarnLogFilter())
|
||
|
||
|
||
def setup(app: "sphinx.application.Sphinx") -> None:
|
||
# from sphinx.ext.autodoc import cut_lines
|
||
# app.connect('autodoc-process-docstring', cut_lines(4, what=['module']))
|
||
app.add_crossref_type(
|
||
"fixture",
|
||
"fixture",
|
||
objname="built-in fixture",
|
||
indextemplate="pair: %s; fixture",
|
||
)
|
||
|
||
app.add_object_type(
|
||
"confval",
|
||
"confval",
|
||
objname="configuration value",
|
||
indextemplate="pair: %s; configuration value",
|
||
)
|
||
|
||
app.add_object_type(
|
||
"globalvar",
|
||
"globalvar",
|
||
objname="global variable interpreted by pytest",
|
||
indextemplate="pair: %s; global variable interpreted by pytest",
|
||
)
|
||
|
||
configure_logging(app)
|
||
|
||
# Make Sphinx mark classes with "final" when decorated with @final.
|
||
# We need this because we import final from pytest._compat, not from
|
||
# typing (for Python < 3.8 compat), so Sphinx doesn't detect it.
|
||
# To keep things simple we accept any `@final` decorator.
|
||
# Ref: https://github.com/pytest-dev/pytest/pull/7780
|
||
import sphinx.pycode.ast
|
||
import sphinx.pycode.parser
|
||
|
||
original_is_final = sphinx.pycode.parser.VariableCommentPicker.is_final
|
||
|
||
def patched_is_final(self, decorators: List[ast.expr]) -> bool:
|
||
if original_is_final(self, decorators):
|
||
return True
|
||
return any(
|
||
sphinx.pycode.ast.unparse(decorator) == "final" for decorator in decorators
|
||
)
|
||
|
||
sphinx.pycode.parser.VariableCommentPicker.is_final = patched_is_final
|