conf.py 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302
  1. # -*- coding: utf-8 -*-
  2. # Licensed to the Apache Software Foundation (ASF) under one or more
  3. # contributor license agreements. See the NOTICE file distributed with
  4. # this work for additional information regarding copyright ownership.
  5. # The ASF licenses this file to You under the Apache License, Version 2.0
  6. # (the "License"); you may not use this file except in compliance with
  7. # the License. You may obtain a copy of the License at
  8. #
  9. # http://www.apache.org/licenses/LICENSE-2.0
  10. #
  11. # Unless required by applicable law or agreed to in writing, software
  12. # distributed under the License is distributed on an "AS IS" BASIS,
  13. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. # See the License for the specific language governing permissions and
  15. # limitations under the License.
  16. # phoenixdb documentation build configuration file, created by
  17. # sphinx-quickstart on Sun Jun 28 18:07:35 2015.
  18. #
  19. # This file is execfile()d with the current directory set to its
  20. # containing dir.
  21. #
  22. # Note that not all possible configuration values are present in this
  23. # autogenerated file.
  24. #
  25. # All configuration values have a default; values that are commented out
  26. # serve to show the default.
  27. import sys
  28. import os
  29. import shlex
  30. # If extensions (or modules to document with autodoc) are in another directory,
  31. # add these directories to sys.path here. If the directory is relative to the
  32. # documentation root, use os.path.abspath to make it absolute, like shown here.
  33. sys.path.insert(0, os.path.abspath('../phoenixdb'))
  34. # -- General configuration ------------------------------------------------
  35. # If your documentation needs a minimal Sphinx version, state it here.
  36. #needs_sphinx = '1.0'
  37. # Add any Sphinx extension module names here, as strings. They can be
  38. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  39. # ones.
  40. extensions = [
  41. 'sphinx.ext.autodoc',
  42. 'sphinx.ext.doctest',
  43. 'sphinx.ext.intersphinx',
  44. ]
  45. # Add any paths that contain templates here, relative to this directory.
  46. templates_path = ['_templates']
  47. # The suffix(es) of source filenames.
  48. # You can specify multiple suffix as a list of string:
  49. # source_suffix = ['.rst', '.md']
  50. source_suffix = '.rst'
  51. # The encoding of source files.
  52. source_encoding = 'utf-8-sig'
  53. # The master toctree document.
  54. master_doc = 'index'
  55. # General information about the project.
  56. project = u'phoenixdb'
  57. copyright = u'2015, Lukas Lalinsky'
  58. author = u'Lukas Lalinsky'
  59. # The version info for the project you're documenting, acts as replacement for
  60. # |version| and |release|, also used in various other places throughout the
  61. # built documents.
  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. # There are two options for replacing |today|: either, you set today to some
  69. # non-false value, then it is used:
  70. #today = ''
  71. # Else, today_fmt is used as the format for a strftime call.
  72. #today_fmt = '%B %d, %Y'
  73. # List of patterns, relative to source directory, that match files and
  74. # directories to ignore when looking for source files.
  75. exclude_patterns = ['_build']
  76. # The reST default role (used for this markup: `text`) to use for all
  77. # documents.
  78. #default_role = None
  79. # If true, '()' will be appended to :func: etc. cross-reference text.
  80. #add_function_parentheses = True
  81. # If true, the current module name will be prepended to all description
  82. # unit titles (such as .. function::).
  83. #add_module_names = True
  84. # If true, sectionauthor and moduleauthor directives will be shown in the
  85. # output. They are ignored by default.
  86. #show_authors = False
  87. # The name of the Pygments (syntax highlighting) style to use.
  88. pygments_style = 'sphinx'
  89. # A list of ignored prefixes for module index sorting.
  90. #modindex_common_prefix = []
  91. # If true, keep warnings as "system message" paragraphs in the built documents.
  92. #keep_warnings = False
  93. # If true, `todo` and `todoList` produce output, else they produce nothing.
  94. todo_include_todos = False
  95. # -- Options for HTML output ----------------------------------------------
  96. # The theme to use for HTML and HTML Help pages. See the documentation for
  97. # a list of builtin themes.
  98. html_theme = 'classic'
  99. # Theme options are theme-specific and customize the look and feel of a theme
  100. # further. For a list of options available for each theme, see the
  101. # documentation.
  102. #html_theme_options = {}
  103. # Add any paths that contain custom themes here, relative to this directory.
  104. #html_theme_path = []
  105. # The name for this set of Sphinx documents. If None, it defaults to
  106. # "<project> v<release> documentation".
  107. #html_title = None
  108. # A shorter title for the navigation bar. Default is the same as html_title.
  109. #html_short_title = None
  110. # The name of an image file (relative to this directory) to place at the top
  111. # of the sidebar.
  112. #html_logo = None
  113. # The name of an image file (within the static path) to use as favicon of the
  114. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  115. # pixels large.
  116. #html_favicon = None
  117. # Add any paths that contain custom static files (such as style sheets) here,
  118. # relative to this directory. They are copied after the builtin static files,
  119. # so a file named "default.css" will overwrite the builtin "default.css".
  120. html_static_path = ['_static']
  121. # Add any extra paths that contain custom files (such as robots.txt or
  122. # .htaccess) here, relative to this directory. These files are copied
  123. # directly to the root of the documentation.
  124. #html_extra_path = []
  125. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  126. # using the given strftime format.
  127. #html_last_updated_fmt = '%b %d, %Y'
  128. # If true, SmartyPants will be used to convert quotes and dashes to
  129. # typographically correct entities.
  130. #html_use_smartypants = True
  131. # Custom sidebar templates, maps document names to template names.
  132. #html_sidebars = {}
  133. # Additional templates that should be rendered to pages, maps page names to
  134. # template names.
  135. #html_additional_pages = {}
  136. # If false, no module index is generated.
  137. #html_domain_indices = True
  138. # If false, no index is generated.
  139. #html_use_index = True
  140. # If true, the index is split into individual pages for each letter.
  141. #html_split_index = False
  142. # If true, links to the reST sources are added to the pages.
  143. html_show_sourcelink = False
  144. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  145. #html_show_sphinx = True
  146. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  147. #html_show_copyright = True
  148. # If true, an OpenSearch description file will be output, and all pages will
  149. # contain a <link> tag referring to it. The value of this option must be the
  150. # base URL from which the finished HTML is served.
  151. #html_use_opensearch = ''
  152. # This is the file name suffix for HTML files (e.g. ".xhtml").
  153. #html_file_suffix = None
  154. # Language to be used for generating the HTML full-text search index.
  155. # Sphinx supports the following languages:
  156. # 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
  157. # 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
  158. #html_search_language = 'en'
  159. # A dictionary with options for the search language support, empty by default.
  160. # Now only 'ja' uses this config value
  161. #html_search_options = {'type': 'default'}
  162. # The name of a javascript file (relative to the configuration directory) that
  163. # implements a search results scorer. If empty, the default will be used.
  164. #html_search_scorer = 'scorer.js'
  165. # Output file base name for HTML help builder.
  166. htmlhelp_basename = 'phoenixdbdoc'
  167. # -- Options for LaTeX output ---------------------------------------------
  168. #latex_elements = {
  169. # The paper size ('letterpaper' or 'a4paper').
  170. #'papersize': 'letterpaper',
  171. # The font size ('10pt', '11pt' or '12pt').
  172. #'pointsize': '10pt',
  173. # Additional stuff for the LaTeX preamble.
  174. #'preamble': '',
  175. # Latex figure (float) alignment
  176. #'figure_align': 'htbp',
  177. #}
  178. # Grouping the document tree into LaTeX files. List of tuples
  179. # (source start file, target name, title,
  180. # author, documentclass [howto, manual, or own class]).
  181. #latex_documents = [
  182. # (master_doc, 'phoenixdb.tex', u'phoenixdb Documentation',
  183. # u'Lukas Lalinsky', 'manual'),
  184. #]
  185. # The name of an image file (relative to this directory) to place at the top of
  186. # the title page.
  187. #latex_logo = None
  188. # For "manual" documents, if this is true, then toplevel headings are parts,
  189. # not chapters.
  190. #latex_use_parts = False
  191. # If true, show page references after internal links.
  192. #latex_show_pagerefs = False
  193. # If true, show URL addresses after external links.
  194. #latex_show_urls = False
  195. # Documents to append as an appendix to all manuals.
  196. #latex_appendices = []
  197. # If false, no module index is generated.
  198. #latex_domain_indices = True
  199. # -- Options for manual page output ---------------------------------------
  200. # One entry per manual page. List of tuples
  201. # (source start file, name, description, authors, manual section).
  202. man_pages = [
  203. (master_doc, 'phoenixdb', u'phoenixdb Documentation',
  204. [author], 1)
  205. ]
  206. # If true, show URL addresses after external links.
  207. #man_show_urls = False
  208. # -- Options for Texinfo output -------------------------------------------
  209. # Grouping the document tree into Texinfo files. List of tuples
  210. # (source start file, target name, title, author,
  211. # dir menu entry, description, category)
  212. texinfo_documents = [
  213. (master_doc, 'phoenixdb', u'phoenixdb Documentation',
  214. author, 'phoenixdb', 'One line description of project.',
  215. 'Miscellaneous'),
  216. ]
  217. # Documents to append as an appendix to all manuals.
  218. #texinfo_appendices = []
  219. # If false, no module index is generated.
  220. #texinfo_domain_indices = True
  221. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  222. #texinfo_show_urls = 'footnote'
  223. # If true, do not generate a @detailmenu in the "Top" node's menu.
  224. #texinfo_no_detailmenu = False
  225. # Example configuration for intersphinx: refer to the Python standard library.
  226. intersphinx_mapping = {'https://docs.python.org/': None}