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