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