387 lines
12 KiB
Python
387 lines
12 KiB
Python
# -*- coding: utf-8 -*-
|
||
#
|
||
# Bugzilla documentation build configuration file, created by
|
||
# sphinx-quickstart on Tue Sep 3 16:11:00 2013.
|
||
#
|
||
# 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 sys, os, re
|
||
|
||
# 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.todo', 'sphinx.ext.extlinks']
|
||
|
||
if tags.has('enable_rst2pdf'):
|
||
extensions.append('rst2pdf.pdfbuilder')
|
||
|
||
# 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'Bugzilla'
|
||
copyright = u'2014, The Bugzilla Team'
|
||
|
||
# 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 = 'Unknown'
|
||
# The full version, including alpha/beta/rc tags.
|
||
release = 'Unknown'
|
||
|
||
for line in open("../../../Bugzilla/Constants.pm"):
|
||
match = re.search(r'BUGZILLA_VERSION\s+=>\s+"([^"]+)"', line)
|
||
if (match):
|
||
release = match.group(1)
|
||
match = re.search(r'^\d+\.\d+', release)
|
||
if (match):
|
||
version = match.group(0)
|
||
else:
|
||
version = release
|
||
break
|
||
|
||
# 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 = ['**.inc.rst']
|
||
|
||
# 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 = []
|
||
|
||
rst_prolog = """
|
||
.. role:: param
|
||
:class: param
|
||
|
||
.. role:: paramval
|
||
:class: paramval
|
||
|
||
.. role:: group
|
||
:class: group
|
||
|
||
.. role:: field
|
||
:class: field
|
||
|
||
.. |min-perl-ver| replace:: 5.10.1
|
||
"""
|
||
|
||
rst_epilog = """
|
||
|
||
----------
|
||
|
||
This documentation undoubtedly has bugs; if you find some, please file
|
||
them `here <https://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&component=Documentation>`_.
|
||
"""
|
||
|
||
# -- Options for HTML output ---------------------------------------------------
|
||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||
# a list of builtin themes.
|
||
html_theme = 'default'
|
||
|
||
# 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
|
||
|
||
html_style = "bugzilla.css"
|
||
|
||
# The name of an image file (relative to this directory) to place at the top
|
||
# of the sidebar.
|
||
html_logo = "../images/bugzilla.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 = '../../../images/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.
|
||
# Switched off because it converted --long-option to –long-option
|
||
html_use_smartypants = False
|
||
|
||
# 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 = False
|
||
|
||
# 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 = False
|
||
|
||
# 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 = 'Bugzilladoc'
|
||
|
||
# -- Options for LaTeX output --------------------------------------------------
|
||
|
||
latex_elements = {
|
||
# The paper size ('letterpaper' or 'a4paper').
|
||
#'papersize': 'letterpaper',
|
||
|
||
# The font size ('10pt', '11pt' or '12pt').
|
||
#'pointsize': '10pt',
|
||
|
||
# Additional stuff for the LaTeX preamble.
|
||
#'preamble': '',
|
||
}
|
||
|
||
# Grouping the document tree into LaTeX files. List of tuples
|
||
# (source start file, target name, title, author, documentclass [howto/manual]).
|
||
latex_documents = [
|
||
('index', 'Bugzilla.tex', u'Bugzilla Documentation',
|
||
u'The Bugzilla Team', '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
|
||
|
||
# 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', 'bugzilla', u'Bugzilla Documentation',
|
||
[u'The Bugzilla Team'], 1)
|
||
]
|
||
|
||
# If true, show URL addresses after external links.
|
||
#man_show_urls = False
|
||
|
||
|
||
# -- Options for Texinfo output ------------------------------------------------
|
||
|
||
# Grouping the document tree into Texinfo files. List of tuples
|
||
# (source start file, target name, title, author,
|
||
# dir menu entry, description, category)
|
||
texinfo_documents = [
|
||
('index', 'Bugzilla', u'Bugzilla Documentation',
|
||
u'The Bugzilla Team', 'Bugzilla', 'One line description of project.',
|
||
'Miscellaneous'),
|
||
]
|
||
|
||
# Documents to append as an appendix to all manuals.
|
||
#texinfo_appendices = []
|
||
|
||
# If false, no module index is generated.
|
||
#texinfo_domain_indices = True
|
||
|
||
# How to display URL addresses: 'footnote', 'no', or 'inline'.
|
||
#texinfo_show_urls = 'footnote'
|
||
|
||
# -- Options for PDF output --------------------------------------------------
|
||
|
||
# Grouping the document tree into PDF files. List of tuples
|
||
# (source start file, target name, title, author, options).
|
||
#
|
||
# If there is more than one author, separate them with \\.
|
||
# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
|
||
#
|
||
# The options element is a dictionary that lets you override
|
||
# this config per-document.
|
||
# For example,
|
||
# ('index', u'MyProject', u'My Project', u'Author Name',
|
||
# dict(pdf_compressed = True))
|
||
# would mean that specific document would be compressed
|
||
# regardless of the global pdf_compressed setting.
|
||
|
||
pdf_documents = [
|
||
('index', u'Bugzilla', u'Bugzilla Documentation', u'The Bugzilla Team'),
|
||
]
|
||
|
||
# A comma-separated list of custom stylesheets. Example:
|
||
pdf_stylesheets = ['sphinx','kerning','a4']
|
||
|
||
# A list of folders to search for stylesheets. Example:
|
||
pdf_style_path = ['.', '_styles']
|
||
|
||
# Create a compressed PDF
|
||
# Use True/False or 1/0
|
||
# Example: compressed=True
|
||
pdf_compressed = True
|
||
|
||
# A colon-separated list of folders to search for fonts. Example:
|
||
# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']
|
||
|
||
# Language to be used for hyphenation support
|
||
#pdf_language = "en_US"
|
||
|
||
# Mode for literal blocks wider than the frame. Can be
|
||
# overflow, shrink or truncate
|
||
pdf_fit_mode = "shrink"
|
||
|
||
# Section level that forces a break page.
|
||
# For example: 1 means top-level sections start in a new page
|
||
# 0 means disabled
|
||
pdf_break_level = 2
|
||
|
||
# When a section starts in a new page, force it to be 'even', 'odd',
|
||
# or just use 'any'
|
||
#pdf_breakside = 'any'
|
||
|
||
# Insert footnotes where they are defined instead of
|
||
# at the end.
|
||
#pdf_inline_footnotes = True
|
||
|
||
# verbosity level. 0 1 or 2
|
||
pdf_verbosity = 0
|
||
|
||
# If false, no index is generated.
|
||
pdf_use_index = False
|
||
|
||
# If false, no modindex is generated.
|
||
pdf_use_modindex = False
|
||
|
||
# If false, no coverpage is generated.
|
||
#pdf_use_coverpage = True
|
||
|
||
# Name of the cover page template to use
|
||
#pdf_cover_template = 'sphinxcover.tmpl'
|
||
|
||
# Documents to append as an appendix to all manuals.
|
||
#pdf_appendices = []
|
||
|
||
# Enable experimental feature to split table cells. Use it
|
||
# if you get "DelayedTable too big" errors
|
||
#pdf_splittables = False
|
||
|
||
# Set the default DPI for images
|
||
#pdf_default_dpi = 72
|
||
|
||
# Enable rst2pdf extension modules (default is only vectorpdf)
|
||
# you need vectorpdf if you want to use sphinx's graphviz support
|
||
pdf_extensions = ['vectorpdf', 'dotted_toc']
|
||
|
||
# Page template name for "regular" pages
|
||
#pdf_page_template = 'cutePage'
|
||
|
||
# Show Table Of Contents at the beginning?
|
||
pdf_use_toc = True
|
||
|
||
# How many levels deep should the table of contents be?
|
||
pdf_toc_depth = 5
|
||
|
||
# Add section number to section references
|
||
pdf_use_numbered_links = True
|
||
|
||
# Background images fitting mode
|
||
pdf_fit_background_mode = 'scale'
|
||
|
||
# -- Options for Sphinx extensions -------------------------------------------
|
||
|
||
# Temporary highlighting of TODO items
|
||
todo_include_todos = True
|
||
|
||
extlinks = {'bug': ('https://bugzilla.mozilla.org/show_bug.cgi?id=%s', 'bug ')}
|