conf.py 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Requests documentation build configuration file, created by
  4. # sphinx-quickstart on Fri Feb 19 00:05:47 2016.
  5. #
  6. # This file is execfile()d with the current directory set to its
  7. # containing dir.
  8. #
  9. # Note that not all possible configuration values are present in this
  10. # autogenerated file.
  11. #
  12. # All configuration values have a default; values that are commented out
  13. # serve to show the default.
  14. import sys
  15. import os
  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.insert(0, os.path.abspath('.'))
  20. # Insert Requests' path into the system.
  21. sys.path.insert(0, os.path.abspath('..'))
  22. sys.path.insert(0, os.path.abspath('_themes'))
  23. import requests
  24. from requests import __version__
  25. # -- General configuration ------------------------------------------------
  26. # If your documentation needs a minimal Sphinx version, state it here.
  27. #needs_sphinx = '1.0'
  28. # Add any Sphinx extension module names here, as strings. They can be
  29. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  30. # ones.
  31. extensions = [
  32. 'sphinx.ext.autodoc',
  33. 'sphinx.ext.intersphinx',
  34. 'sphinx.ext.todo',
  35. 'sphinx.ext.viewcode',
  36. ]
  37. # Add any paths that contain templates here, relative to this directory.
  38. templates_path = ['_templates']
  39. # The suffix(es) of source filenames.
  40. # You can specify multiple suffix as a list of string:
  41. # source_suffix = ['.rst', '.md']
  42. source_suffix = '.rst'
  43. # The encoding of source files.
  44. #source_encoding = 'utf-8-sig'
  45. # The master toctree document.
  46. master_doc = 'index'
  47. # General information about the project.
  48. project = u'Requests'
  49. copyright = u'2016. A <a href="http://kennethreitz.com/pages/open-projects.html">Kenneth Reitz</a> Project'
  50. author = u'Kenneth Reitz'
  51. # The version info for the project you're documenting, acts as replacement for
  52. # |version| and |release|, also used in various other places throughout the
  53. # built documents.
  54. #
  55. # The short X.Y version.
  56. version = __version__
  57. # The full version, including alpha/beta/rc tags.
  58. release = __version__
  59. # The language for content autogenerated by Sphinx. Refer to documentation
  60. # for a list of supported languages.
  61. #
  62. # This is also used if you do content translation via gettext catalogs.
  63. # Usually you set "language" from the command line for these cases.
  64. language = None
  65. # There are two options for replacing |today|: either, you set today to some
  66. # non-false value, then it is used:
  67. #today = ''
  68. # Else, today_fmt is used as the format for a strftime call.
  69. #today_fmt = '%B %d, %Y'
  70. # List of patterns, relative to source directory, that match files and
  71. # directories to ignore when looking for source files.
  72. exclude_patterns = ['_build']
  73. # The reST default role (used for this markup: `text`) to use for all
  74. # documents.
  75. #default_role = None
  76. # If true, '()' will be appended to :func: etc. cross-reference text.
  77. add_function_parentheses = False
  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. # If true, sectionauthor and moduleauthor directives will be shown in the
  82. # output. They are ignored by default.
  83. #show_authors = False
  84. # The name of the Pygments (syntax highlighting) style to use.
  85. pygments_style = 'flask_theme_support.FlaskyStyle'
  86. # A list of ignored prefixes for module index sorting.
  87. #modindex_common_prefix = []
  88. # If true, keep warnings as "system message" paragraphs in the built documents.
  89. #keep_warnings = False
  90. # If true, `todo` and `todoList` produce output, else they produce nothing.
  91. todo_include_todos = True
  92. # -- Options for HTML output ----------------------------------------------
  93. # The theme to use for HTML and HTML Help pages. See the documentation for
  94. # a list of builtin themes.
  95. html_theme = 'alabaster'
  96. # Theme options are theme-specific and customize the look and feel of a theme
  97. # further. For a list of options available for each theme, see the
  98. # documentation.
  99. html_theme_options = {
  100. 'show_powered_by': False,
  101. 'github_user': 'kennethreitz',
  102. 'github_repo': 'requests',
  103. 'github_banner': True,
  104. 'show_related': False
  105. }
  106. # Add any paths that contain custom themes here, relative to this directory.
  107. #html_theme_path = []
  108. # The name for this set of Sphinx documents. If None, it defaults to
  109. # "<project> v<release> documentation".
  110. #html_title = None
  111. # A shorter title for the navigation bar. Default is the same as html_title.
  112. #html_short_title = None
  113. # The name of an image file (relative to this directory) to place at the top
  114. # of the sidebar.
  115. #html_logo = None
  116. # The name of an image file (within the static path) to use as favicon of the
  117. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  118. # pixels large.
  119. #html_favicon = None
  120. # Add any paths that contain custom static files (such as style sheets) here,
  121. # relative to this directory. They are copied after the builtin static files,
  122. # so a file named "default.css" will overwrite the builtin "default.css".
  123. html_static_path = ['_static']
  124. # Add any extra paths that contain custom files (such as robots.txt or
  125. # .htaccess) here, relative to this directory. These files are copied
  126. # directly to the root of the documentation.
  127. #html_extra_path = []
  128. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  129. # using the given strftime format.
  130. #html_last_updated_fmt = '%b %d, %Y'
  131. # If true, SmartyPants will be used to convert quotes and dashes to
  132. # typographically correct entities.
  133. html_use_smartypants = False
  134. # Custom sidebar templates, maps document names to template names.
  135. html_sidebars = {
  136. 'index': ['sidebarintro.html', 'sourcelink.html', 'searchbox.html',
  137. 'hacks.html'],
  138. '**': ['sidebarlogo.html', 'localtoc.html', 'relations.html',
  139. 'sourcelink.html', 'searchbox.html', 'hacks.html']
  140. }
  141. # Additional templates that should be rendered to pages, maps page names to
  142. # template names.
  143. #html_additional_pages = {}
  144. # If false, no module index is generated.
  145. #html_domain_indices = True
  146. # If false, no index is generated.
  147. #html_use_index = True
  148. # If true, the index is split into individual pages for each letter.
  149. #html_split_index = False
  150. # If true, links to the reST sources are added to the pages.
  151. html_show_sourcelink = False
  152. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  153. html_show_sphinx = False
  154. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  155. html_show_copyright = True
  156. # If true, an OpenSearch description file will be output, and all pages will
  157. # contain a <link> tag referring to it. The value of this option must be the
  158. # base URL from which the finished HTML is served.
  159. #html_use_opensearch = ''
  160. # This is the file name suffix for HTML files (e.g. ".xhtml").
  161. #html_file_suffix = None
  162. # Language to be used for generating the HTML full-text search index.
  163. # Sphinx supports the following languages:
  164. # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
  165. # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
  166. #html_search_language = 'en'
  167. # A dictionary with options for the search language support, empty by default.
  168. # Now only 'ja' uses this config value
  169. #html_search_options = {'type': 'default'}
  170. # The name of a javascript file (relative to the configuration directory) that
  171. # implements a search results scorer. If empty, the default will be used.
  172. #html_search_scorer = 'scorer.js'
  173. # Output file base name for HTML help builder.
  174. htmlhelp_basename = 'Requestsdoc'
  175. # -- Options for LaTeX output ---------------------------------------------
  176. latex_elements = {
  177. # The paper size ('letterpaper' or 'a4paper').
  178. #'papersize': 'letterpaper',
  179. # The font size ('10pt', '11pt' or '12pt').
  180. #'pointsize': '10pt',
  181. # Additional stuff for the LaTeX preamble.
  182. #'preamble': '',
  183. # Latex figure (float) alignment
  184. #'figure_align': 'htbp',
  185. }
  186. # Grouping the document tree into LaTeX files. List of tuples
  187. # (source start file, target name, title,
  188. # author, documentclass [howto, manual, or own class]).
  189. latex_documents = [
  190. (master_doc, 'Requests.tex', u'Requests Documentation',
  191. u'Kenneth Reitz', 'manual'),
  192. ]
  193. # The name of an image file (relative to this directory) to place at the top of
  194. # the title page.
  195. #latex_logo = None
  196. # For "manual" documents, if this is true, then toplevel headings are parts,
  197. # not chapters.
  198. #latex_use_parts = False
  199. # If true, show page references after internal links.
  200. #latex_show_pagerefs = False
  201. # If true, show URL addresses after external links.
  202. #latex_show_urls = False
  203. # Documents to append as an appendix to all manuals.
  204. #latex_appendices = []
  205. # If false, no module index is generated.
  206. #latex_domain_indices = True
  207. # -- Options for manual page output ---------------------------------------
  208. # One entry per manual page. List of tuples
  209. # (source start file, name, description, authors, manual section).
  210. man_pages = [
  211. (master_doc, 'requests', u'Requests Documentation',
  212. [author], 1)
  213. ]
  214. # If true, show URL addresses after external links.
  215. #man_show_urls = False
  216. # -- Options for Texinfo output -------------------------------------------
  217. # Grouping the document tree into Texinfo files. List of tuples
  218. # (source start file, target name, title, author,
  219. # dir menu entry, description, category)
  220. texinfo_documents = [
  221. (master_doc, 'Requests', u'Requests Documentation',
  222. author, 'Requests', 'One line description of project.',
  223. 'Miscellaneous'),
  224. ]
  225. # Documents to append as an appendix to all manuals.
  226. #texinfo_appendices = []
  227. # If false, no module index is generated.
  228. #texinfo_domain_indices = True
  229. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  230. #texinfo_show_urls = 'footnote'
  231. # If true, do not generate a @detailmenu in the "Top" node's menu.
  232. #texinfo_no_detailmenu = False
  233. # -- Options for Epub output ----------------------------------------------
  234. # Bibliographic Dublin Core info.
  235. epub_title = project
  236. epub_author = author
  237. epub_publisher = author
  238. epub_copyright = copyright
  239. # The basename for the epub file. It defaults to the project name.
  240. #epub_basename = project
  241. # The HTML theme for the epub output. Since the default themes are not
  242. # optimized for small screen space, using the same theme for HTML and epub
  243. # output is usually not wise. This defaults to 'epub', a theme designed to save
  244. # visual space.
  245. #epub_theme = 'epub'
  246. # The language of the text. It defaults to the language option
  247. # or 'en' if the language is not set.
  248. #epub_language = ''
  249. # The scheme of the identifier. Typical schemes are ISBN or URL.
  250. #epub_scheme = ''
  251. # The unique identifier of the text. This can be a ISBN number
  252. # or the project homepage.
  253. #epub_identifier = ''
  254. # A unique identification for the text.
  255. #epub_uid = ''
  256. # A tuple containing the cover image and cover page html template filenames.
  257. #epub_cover = ()
  258. # A sequence of (type, uri, title) tuples for the guide element of content.opf.
  259. #epub_guide = ()
  260. # HTML files that should be inserted before the pages created by sphinx.
  261. # The format is a list of tuples containing the path and title.
  262. #epub_pre_files = []
  263. # HTML files that should be inserted after the pages created by sphinx.
  264. # The format is a list of tuples containing the path and title.
  265. #epub_post_files = []
  266. # A list of files that should not be packed into the epub file.
  267. epub_exclude_files = ['search.html']
  268. # The depth of the table of contents in toc.ncx.
  269. #epub_tocdepth = 3
  270. # Allow duplicate toc entries.
  271. #epub_tocdup = True
  272. # Choose between 'default' and 'includehidden'.
  273. #epub_tocscope = 'default'
  274. # Fix unsupported image types using the Pillow.
  275. #epub_fix_images = False
  276. # Scale large images.
  277. #epub_max_image_width = 0
  278. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  279. #epub_show_urls = 'inline'
  280. # If false, no index is generated.
  281. #epub_use_index = True
  282. intersphinx_mapping = {'urllib3': ('http://urllib3.readthedocs.io/en/latest', None)}