1+ # -*- coding: utf-8 -*-
2+ #
3+ # Configuration file for the Sphinx documentation builder.
4+ #
5+ # This file does only contain a selection of the most common options. For a
6+ # full list see the documentation:
7+ # http://www.sphinx-doc.org/en/master/config
8+
9+ from twilio import __version__
10+
11+ # -- Path setup --------------------------------------------------------------
12+
13+ # If extensions (or modules to document with autodoc) are in another directory,
14+ # add these directories to sys.path here. If the directory is relative to the
15+ # documentation root, use os.path.abspath to make it absolute, like shown here.
16+ #
17+ import os
18+ import sys
19+ sys .path .insert (0 , os .path .join (os .path .abspath ('..' ), 'twilio' ))
20+ # -- Project information -----------------------------------------------------
21+
22+ project = 'twilio-python'
23+ copyright = '2018, Twilio'
24+ author = 'Twilio'
25+
26+ # The short X.Y version
27+ version = __version__
28+ # The full version, including alpha/beta/rc tags
29+ release = __version__
30+
31+
32+ # -- General configuration ---------------------------------------------------
33+
34+ # If your documentation needs a minimal Sphinx version, state it here.
35+ #
36+ # needs_sphinx = '1.0'
37+
38+ # Add any Sphinx extension module names here, as strings. They can be
39+ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
40+ # ones.
41+ extensions = [
42+ 'sphinx.ext.autodoc' ,
43+ 'sphinx.ext.doctest' ,
44+ 'sphinx.ext.intersphinx' ,
45+ 'sphinx.ext.coverage' ,
46+ 'sphinx.ext.ifconfig' ,
47+ 'sphinx.ext.viewcode' ,
48+ ]
49+
50+ # Add any paths that contain templates here, relative to this directory.
51+ templates_path = ['source/_templates' ]
52+
53+ # The suffix(es) of source filenames.
54+ # You can specify multiple suffix as a list of string:
55+ #
56+ # source_suffix = ['.rst', '.md']
57+ source_suffix = '.rst'
58+
59+ # The master toctree document.
60+ master_doc = 'source/index'
61+
62+ # The language for content autogenerated by Sphinx. Refer to documentation
63+ # for a list of supported languages.
64+ #
65+ # This is also used if you do content translation via gettext catalogs.
66+ # Usually you set "language" from the command line for these cases.
67+ language = None
68+
69+ # List of patterns, relative to source directory, that match files and
70+ # directories to ignore when looking for source files.
71+ # This pattern also affects html_static_path and html_extra_path .
72+ exclude_patterns = []
73+
74+ # The name of the Pygments (syntax highlighting) style to use.
75+ pygments_style = 'sphinx'
76+
77+
78+ # -- Options for HTML output -------------------------------------------------
79+
80+ # The theme to use for HTML and HTML Help pages. See the documentation for
81+ # a list of builtin themes.
82+ #
83+ html_theme = 'alabaster'
84+
85+ # Theme options are theme-specific and customize the look and feel of a theme
86+ # further. For a list of options available for each theme, see the
87+ # documentation.
88+ #
89+ # html_theme_options = {}
90+
91+ html_static_path = ['source/_static' ]
92+
93+ # Custom sidebar templates, must be a dictionary that maps document names
94+ # to template names.
95+ #
96+ # The default sidebars (for documents that don't match any pattern) are
97+ # defined by theme itself. Builtin themes are using these templates by
98+ # default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
99+ # 'searchbox.html']``.
100+ #
101+ html_sidebars = {
102+ '**' : [ 'sidebarintro.html' , 'localtoc.html' , 'relations.html' ,
103+ 'sourcelink.html' , 'searchbox.html' ]
104+ }
105+
106+
107+ # -- Options for HTMLHelp output ---------------------------------------------
108+
109+ # Output file base name for HTML help builder.
110+ htmlhelp_basename = 'twilio-pythondoc'
111+
112+
113+ # -- Options for LaTeX output ------------------------------------------------
114+
115+ latex_elements = {
116+ # The paper size ('letterpaper' or 'a4paper').
117+ #
118+ # 'papersize': 'letterpaper',
119+
120+ # The font size ('10pt', '11pt' or '12pt').
121+ #
122+ # 'pointsize': '10pt',
123+
124+ # Additional stuff for the LaTeX preamble.
125+ #
126+ # 'preamble': '',
127+
128+ # Latex figure (float) alignment
129+ #
130+ # 'figure_align': 'htbp',
131+ }
132+
133+ # Grouping the document tree into LaTeX files. List of tuples
134+ # (source start file, target name, title,
135+ # author, documentclass [howto, manual, or own class]).
136+ latex_documents = [
137+ (master_doc , 'twilio-python.tex' , 'twilio-python Documentation' ,
138+ 'Twilio' , 'manual' ),
139+ ]
140+
141+
142+ # -- Options for manual page output ------------------------------------------
143+
144+ # One entry per manual page. List of tuples
145+ # (source start file, name, description, authors, manual section).
146+ man_pages = [
147+ (master_doc , 'twilio-python' , 'twilio-python Documentation' ,
148+ [author ], 1 )
149+ ]
150+
151+
152+ # -- Options for Texinfo output ----------------------------------------------
153+
154+ # Grouping the document tree into Texinfo files. List of tuples
155+ # (source start file, target name, title, author,
156+ # dir menu entry, description, category)
157+ texinfo_documents = [
158+ (master_doc , 'twilio-python' , 'twilio-python Documentation' ,
159+ author , 'twilio-python' , 'One line description of project.' ,
160+ 'Miscellaneous' ),
161+ ]
162+
163+
164+ # -- Options for Epub output -------------------------------------------------
165+
166+ # Bibliographic Dublin Core info.
167+ epub_title = project
168+ epub_author = author
169+ epub_publisher = author
170+ epub_copyright = copyright
171+
172+ # The unique identifier of the text. This can be a ISBN number
173+ # or the project homepage.
174+ #
175+ # epub_identifier = ''
176+
177+ # A unique identification for the text.
178+ #
179+ # epub_uid = ''
180+
181+ # A list of files that should not be packed into the epub file.
182+ epub_exclude_files = ['search.html' ]
183+
184+
185+ # -- Extension configuration -------------------------------------------------
186+
187+ # -- Options for intersphinx extension ---------------------------------------
188+
189+ # Example configuration for intersphinx: refer to the Python standard library.
190+ intersphinx_mapping = {'https://docs.python.org/' : None }
0 commit comments