[Summary view] [Print] [Text view]

   1  # -*- coding: utf-8 -*-
   2  #
   3  # Services_Twilio documentation build configuration file, created by
   4  # sphinx-quickstart on Tue Mar  8 04:02:01 2011.
   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  from datetime import datetime
  16  
  17  # If extensions (or modules to document with autodoc) are in another directory,
  18  # add these directories to sys.path here. If the directory is relative to the
  19  # documentation root, use os.path.abspath to make it absolute, like shown here.
  20  #sys.path.insert(0, os.path.abspath('.'))
  21  
  22  # -- General configuration -----------------------------------------------------
  23  
  24  # If your documentation needs a minimal Sphinx version, state it here.
  25  #needs_sphinx = '1.0'
  26  
  27  # Add any Sphinx extension module names here, as strings. They can be extensions
  28  # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  29  extensions = ['sphinxcontrib.phpdomain', 'sphinxcontrib_phpautodoc']
  30  
  31  primary_domain = 'php'
  32  
  33  # Add any paths that contain templates here, relative to this directory.
  34  templates_path = ['_templates']
  35  
  36  # The suffix of source filenames.
  37  source_suffix = '.rst'
  38  
  39  # The encoding of source files.
  40  #source_encoding = 'utf-8-sig'
  41  
  42  # The master toctree document.
  43  master_doc = 'index'
  44  
  45  # General information about the project.
  46  project = u'Services_Twilio'
  47  copyright = unicode(datetime.utcnow().year) + u', Twilio Inc'
  48  
  49  # The version info for the project you're documenting, acts as replacement for
  50  # |version| and |release|, also used in various other places throughout the
  51  # built documents.
  52  #
  53  # The short X.Y version.
  54  version = '3.12'
  55  # The full version, including alpha/beta/rc tags.
  56  release = '3.12.4'
  57  
  58  # The language for content autogenerated by Sphinx. Refer to documentation
  59  # for a list of supported languages.
  60  #language = None
  61  
  62  # There are two options for replacing |today|: either, you set today to some
  63  # non-false value, then it is used:
  64  #today = ''
  65  # Else, today_fmt is used as the format for a strftime call.
  66  #today_fmt = '%B %d, %Y'
  67  
  68  # List of patterns, relative to source directory, that match files and
  69  # directories to ignore when looking for source files.
  70  exclude_patterns = ['_build']
  71  
  72  # The reST default role (used for this markup: `text`) to use for all documents.
  73  #default_role = None
  74  
  75  # If true, '()' will be appended to :func: etc. cross-reference text.
  76  #add_function_parentheses = True
  77  
  78  # If true, the current module name will be prepended to all description
  79  # unit titles (such as .. function::).
  80  #add_module_names = True
  81  
  82  # If true, sectionauthor and moduleauthor directives will be shown in the
  83  # output. They are ignored by default.
  84  #show_authors = False
  85  
  86  # The name of the Pygments (syntax highlighting) style to use.
  87  pygments_style = 'sphinx'
  88  
  89  # A list of ignored prefixes for module index sorting.
  90  #modindex_common_prefix = []
  91  
  92  
  93  # -- Options for HTML output ---------------------------------------------------
  94  sys.path.append(os.path.abspath('_themes'))
  95  html_theme_path = ['_themes']
  96  html_theme = 'kr'
  97  
  98  from sphinx.highlighting import lexers
  99  from pygments.lexers.web import PhpLexer
 100  lexers['php'] = PhpLexer(startinline=True)
 101  
 102  # The theme to use for HTML and HTML Help pages.  See the documentation for
 103  # a list of builtin themes.
 104  #html_theme = 'default'
 105  
 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
 108  # documentation.
 109  #html_theme_options = {}
 110  
 111  # Add any paths that contain custom themes here, relative to this directory.
 112  #html_theme_path = []
 113  
 114  # The name for this set of Sphinx documents.  If None, it defaults to
 115  # "<project> v<release> documentation".
 116  #html_title = None
 117  
 118  # A shorter title for the navigation bar.  Default is the same as html_title.
 119  #html_short_title = None
 120  
 121  # The name of an image file (relative to this directory) to place at the top
 122  # of the sidebar.
 123  #html_logo = None
 124  
 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
 127  # pixels large.
 128  #html_favicon = None
 129  
 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']
 134  
 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'
 138  
 139  # If true, SmartyPants will be used to convert quotes and dashes to
 140  # typographically correct entities.
 141  #html_use_smartypants = True
 142  
 143  # Custom sidebar templates, maps document names to template names.
 144  #html_sidebars = {}
 145  
 146  # Additional templates that should be rendered to pages, maps page names to
 147  # template names.
 148  #html_additional_pages = {}
 149  
 150  # If false, no module index is generated.
 151  #html_domain_indices = True
 152  
 153  # If false, no index is generated.
 154  #html_use_index = True
 155  
 156  # If true, the index is split into individual pages for each letter.
 157  #html_split_index = False
 158  
 159  # If true, links to the reST sources are added to the pages.
 160  #html_show_sourcelink = True
 161  
 162  # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
 163  #html_show_sphinx = True
 164  
 165  # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
 166  #html_show_copyright = True
 167  
 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 = ''
 172  
 173  # This is the file name suffix for HTML files (e.g. ".xhtml").
 174  #html_file_suffix = None
 175  
 176  # Output file base name for HTML help builder.
 177  htmlhelp_basename = 'Services_Twiliodoc'
 178  
 179  
 180  # -- Options for LaTeX output --------------------------------------------------
 181  
 182  # The paper size ('letter' or 'a4').
 183  #latex_paper_size = 'letter'
 184  
 185  # The font size ('10pt', '11pt' or '12pt').
 186  #latex_font_size = '10pt'
 187  
 188  # Grouping the document tree into LaTeX files. List of tuples
 189  # (source start file, target name, title, author, documentclass [howto/manual]).
 190  latex_documents = [
 191    ('index', 'Services_Twilio.tex', u'Services\\_Twilio Documentation',
 192     u'Neuman Vong', 'manual'),
 193  ]
 194  
 195  # The name of an image file (relative to this directory) to place at the top of
 196  # the title page.
 197  #latex_logo = None
 198  
 199  # For "manual" documents, if this is true, then toplevel headings are parts,
 200  # not chapters.
 201  #latex_use_parts = False
 202  
 203  # If true, show page references after internal links.
 204  #latex_show_pagerefs = False
 205  
 206  # If true, show URL addresses after external links.
 207  #latex_show_urls = False
 208  
 209  # Additional stuff for the LaTeX preamble.
 210  #latex_preamble = ''
 211  
 212  # Documents to append as an appendix to all manuals.
 213  #latex_appendices = []
 214  
 215  # If false, no module index is generated.
 216  #latex_domain_indices = True
 217  
 218  
 219  # -- Options for manual page output --------------------------------------------
 220  
 221  # One entry per manual page. List of tuples
 222  # (source start file, name, description, authors, manual section).
 223  man_pages = [
 224      ('index', 'services_twilio', u'Services_Twilio Documentation',
 225       [u'Neuman Vong'], 1)
 226  ]