1 # -*- coding: utf-8 -*-
3 # the Drupal Extension to Behat and Mink documentation build configuration file, created by
4 # sphinx-quickstart on Sun Jul 7 09:40:13 2013.
6 # This file is execfile()d with the current directory set to its containing dir.
8 # Note that not all possible configuration values are present in this
11 # All configuration values have a default; values that are commented out
12 # serve to show the default.
16 # Check if this build is on readthedocs.org
17 on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
19 import sphinx_rtd_theme
20 html_theme = "sphinx_rtd_theme"
21 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
23 # If extensions (or modules to document with autodoc) are in another directory,
24 # add these directories to sys.path here. If the directory is relative to the
25 # documentation root, use os.path.abspath to make it absolute, like shown here.
26 #sys.path.insert(0, os.path.abspath('.'))
28 # -- General configuration -----------------------------------------------------
30 # If your documentation needs a minimal Sphinx version, state it here.
33 # Add any Sphinx extension module names here, as strings. They can be extensions
34 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
35 extensions = ['sphinx.ext.todo', 'sphinx.ext.ifconfig']
37 # Add any paths that contain templates here, relative to this directory.
38 templates_path = ['_templates']
40 # The suffix of source filenames.
41 source_suffix = '.rst'
43 # The encoding of source files.
44 #source_encoding = 'utf-8-sig'
46 # The master toctree document.
49 # General information about the project.
50 project = u'the Drupal Extension to Behat and Mink'
51 copyright = u'2013, Melissa Anderson'
53 # The version info for the project you're documenting, acts as replacement for
54 # |version| and |release|, also used in various other places throughout the
57 # The short X.Y version.
59 # The full version, including alpha/beta/rc tags.
62 # The language for content autogenerated by Sphinx. Refer to documentation
63 # for a list of supported languages.
66 # There are two options for replacing |today|: either, you set today to some
67 # non-false value, then it is used:
69 # Else, today_fmt is used as the format for a strftime call.
70 #today_fmt = '%B %d, %Y'
72 # List of patterns, relative to source directory, that match files and
73 # directories to ignore when looking for source files.
74 exclude_patterns = ['_build']
76 # The reST default role (used for this markup: `text`) to use for all documents.
79 # If true, '()' will be appended to :func: etc. cross-reference text.
80 #add_function_parentheses = True
82 # If true, the current module name will be prepended to all description
83 # unit titles (such as .. function::).
84 #add_module_names = True
86 # If true, sectionauthor and moduleauthor directives will be shown in the
87 # output. They are ignored by default.
90 # The name of the Pygments (syntax highlighting) style to use.
91 # pygments_style = 'sphinx'
93 # A list of ignored prefixes for module index sorting.
94 #modindex_common_prefix = []
97 # -- Options for HTML output ---------------------------------------------------
99 # The theme to use for HTML and HTML Help pages. See the documentation for
100 # a list of builtin themes.
101 #html_theme = 'default'
103 # '**':['globaltoc.html','searchbox.html'],
104 # 'using/windows': ['windowssidebar.html', 'searchbox.html'],
106 # Theme options are theme-specific and customize the look and feel of a theme
107 # further. For a list of options available for each theme, see the
109 #html_theme_options = {}
111 # Add any paths that contain custom themes here, relative to this directory.
112 #html_theme_path = []
114 # The name for this set of Sphinx documents. If None, it defaults to
115 # "<project> v<release> documentation".
118 # A shorter title for the navigation bar. Default is the same as html_title.
119 #html_short_title = None
121 # The name of an image file (relative to this directory) to place at the top
125 # The name of an image file (within the static path) to use as favicon of the
126 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
128 html_favicon = "_static/favicon.ico"
130 # Add any paths that contain custom static files (such as style sheets) here,
131 # relative to this directory. They are copied after the builtin static files,
132 # so a file named "default.css" will overwrite the builtin "default.css".
133 html_static_path = ['_static']
135 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
136 # using the given strftime format.
137 #html_last_updated_fmt = '%b %d, %Y'
139 # If true, SmartyPants will be used to convert quotes and dashes to
140 # typographically correct entities.
141 #html_use_smartypants = True
143 # Custom sidebar templates, maps document names to template names.
146 # Additional templates that should be rendered to pages, maps page names to
148 #html_additional_pages = {}
150 # If false, no module index is generated.
151 #html_domain_indices = True
153 # If false, no index is generated.
154 #html_use_index = True
156 # If true, the index is split into individual pages for each letter.
157 #html_split_index = False
159 # If true, links to the reST sources are added to the pages.
160 #html_show_sourcelink = True
162 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
163 #html_show_sphinx = True
165 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
166 html_show_copyright = False
168 # If true, an OpenSearch description file will be output, and all pages will
169 # contain a <link> tag referring to it. The value of this option must be the
170 # base URL from which the finished HTML is served.
171 #html_use_opensearch = ''
173 # This is the file name suffix for HTML files (e.g. ".xhtml").
174 #html_file_suffix = None
176 # Output file base name for HTML help builder.
177 htmlhelp_basename = 'theDrupalExtensiontoBehatandMinkdoc'
180 # -- Options for LaTeX output --------------------------------------------------
183 # The paper size ('letterpaper' or 'a4paper').
184 #'papersize': 'letterpaper',
186 # The font size ('10pt', '11pt' or '12pt').
187 #'pointsize': '10pt',
189 # Additional stuff for the LaTeX preamble.
193 # Grouping the document tree into LaTeX files. List of tuples
194 # (source start file, target name, title, author, documentclass [howto/manual]).
196 ('index', 'theDrupalExtensiontoBehatandMink.tex', u'the Drupal Extension to Behat and Mink Documentation',
197 u'Melissa Anderson', 'manual'),
200 # The name of an image file (relative to this directory) to place at the top of
204 # For "manual" documents, if this is true, then toplevel headings are parts,
206 #latex_use_parts = False
208 # If true, show page references after internal links.
209 #latex_show_pagerefs = False
211 # If true, show URL addresses after external links.
212 #latex_show_urls = False
214 # Documents to append as an appendix to all manuals.
215 #latex_appendices = []
217 # If false, no module index is generated.
218 #latex_domain_indices = True
221 # -- Options for manual page output --------------------------------------------
223 # One entry per manual page. List of tuples
224 # (source start file, name, description, authors, manual section).
226 ('main.rst', 'thedrupalextensiontobehatandmink', u'the Drupal Extension to Behat and Mink Documentation',
227 [u'Melissa Anderson'], 1)
230 # If true, show URL addresses after external links.
231 #man_show_urls = False
234 # -- Options for Texinfo output ------------------------------------------------
236 # Grouping the document tree into Texinfo files. List of tuples
237 # (source start file, target name, title, author,
238 # dir menu entry, description, category)
239 texinfo_documents = [
240 ('main.rst', 'theDrupalExtensiontoBehatandMink', u'the Drupal Extension to Behat and Mink Documentation',
241 u'Melissa Anderson', 'theDrupalExtensiontoBehatandMink', 'One line description of project.',
245 # Documents to append as an appendix to all manuals.
246 #texinfo_appendices = []
248 # If false, no module index is generated.
249 #texinfo_domain_indices = True
251 # How to display URL addresses: 'footnote', 'no', or 'inline'.
252 #texinfo_show_urls = 'footnote'