conf.py 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271
  1. # -*- coding: utf-8 -*-
  2. #
  3. # Synapse documentation build configuration file, created by
  4. # sphinx-quickstart on Tue Jun 10 17:31:02 2014.
  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. # -- General configuration ------------------------------------------------
  21. # If your documentation needs a minimal Sphinx version, state it here.
  22. #needs_sphinx = '1.0'
  23. # Add any Sphinx extension module names here, as strings. They can be
  24. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
  25. # ones.
  26. extensions = [
  27. 'sphinx.ext.autodoc',
  28. 'sphinx.ext.intersphinx',
  29. 'sphinx.ext.coverage',
  30. 'sphinx.ext.ifconfig',
  31. 'sphinxcontrib.napoleon',
  32. ]
  33. # Add any paths that contain templates here, relative to this directory.
  34. templates_path = ['_templates']
  35. # The suffix of source filenames.
  36. source_suffix = '.rst'
  37. # The encoding of source files.
  38. #source_encoding = 'utf-8-sig'
  39. # The master toctree document.
  40. master_doc = 'index'
  41. # General information about the project.
  42. project = u'Synapse'
  43. copyright = u'2014, TNG'
  44. # The version info for the project you're documenting, acts as replacement for
  45. # |version| and |release|, also used in various other places throughout the
  46. # built documents.
  47. #
  48. # The short X.Y version.
  49. version = '1.0'
  50. # The full version, including alpha/beta/rc tags.
  51. release = '1.0'
  52. # The language for content autogenerated by Sphinx. Refer to documentation
  53. # for a list of supported languages.
  54. #language = None
  55. # There are two options for replacing |today|: either, you set today to some
  56. # non-false value, then it is used:
  57. #today = ''
  58. # Else, today_fmt is used as the format for a strftime call.
  59. #today_fmt = '%B %d, %Y'
  60. # List of patterns, relative to source directory, that match files and
  61. # directories to ignore when looking for source files.
  62. exclude_patterns = ['_build']
  63. # The reST default role (used for this markup: `text`) to use for all
  64. # documents.
  65. #default_role = None
  66. # If true, '()' will be appended to :func: etc. cross-reference text.
  67. #add_function_parentheses = True
  68. # If true, the current module name will be prepended to all description
  69. # unit titles (such as .. function::).
  70. #add_module_names = True
  71. # If true, sectionauthor and moduleauthor directives will be shown in the
  72. # output. They are ignored by default.
  73. #show_authors = False
  74. # The name of the Pygments (syntax highlighting) style to use.
  75. pygments_style = 'sphinx'
  76. # A list of ignored prefixes for module index sorting.
  77. #modindex_common_prefix = []
  78. # If true, keep warnings as "system message" paragraphs in the built documents.
  79. #keep_warnings = False
  80. # -- Options for HTML output ----------------------------------------------
  81. # The theme to use for HTML and HTML Help pages. See the documentation for
  82. # a list of builtin themes.
  83. html_theme = 'default'
  84. # Theme options are theme-specific and customize the look and feel of a theme
  85. # further. For a list of options available for each theme, see the
  86. # documentation.
  87. #html_theme_options = {}
  88. # Add any paths that contain custom themes here, relative to this directory.
  89. #html_theme_path = []
  90. # The name for this set of Sphinx documents. If None, it defaults to
  91. # "<project> v<release> documentation".
  92. #html_title = None
  93. # A shorter title for the navigation bar. Default is the same as html_title.
  94. #html_short_title = None
  95. # The name of an image file (relative to this directory) to place at the top
  96. # of the sidebar.
  97. #html_logo = None
  98. # The name of an image file (within the static path) to use as favicon of the
  99. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  100. # pixels large.
  101. #html_favicon = None
  102. # Add any paths that contain custom static files (such as style sheets) here,
  103. # relative to this directory. They are copied after the builtin static files,
  104. # so a file named "default.css" will overwrite the builtin "default.css".
  105. html_static_path = ['_static']
  106. # Add any extra paths that contain custom files (such as robots.txt or
  107. # .htaccess) here, relative to this directory. These files are copied
  108. # directly to the root of the documentation.
  109. #html_extra_path = []
  110. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  111. # using the given strftime format.
  112. #html_last_updated_fmt = '%b %d, %Y'
  113. # If true, SmartyPants will be used to convert quotes and dashes to
  114. # typographically correct entities.
  115. #html_use_smartypants = True
  116. # Custom sidebar templates, maps document names to template names.
  117. #html_sidebars = {}
  118. # Additional templates that should be rendered to pages, maps page names to
  119. # template names.
  120. #html_additional_pages = {}
  121. # If false, no module index is generated.
  122. #html_domain_indices = True
  123. # If false, no index is generated.
  124. #html_use_index = True
  125. # If true, the index is split into individual pages for each letter.
  126. #html_split_index = False
  127. # If true, links to the reST sources are added to the pages.
  128. #html_show_sourcelink = True
  129. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  130. #html_show_sphinx = True
  131. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  132. #html_show_copyright = True
  133. # If true, an OpenSearch description file will be output, and all pages will
  134. # contain a <link> tag referring to it. The value of this option must be the
  135. # base URL from which the finished HTML is served.
  136. #html_use_opensearch = ''
  137. # This is the file name suffix for HTML files (e.g. ".xhtml").
  138. #html_file_suffix = None
  139. # Output file base name for HTML help builder.
  140. htmlhelp_basename = 'Synapsedoc'
  141. # -- Options for LaTeX output ---------------------------------------------
  142. latex_elements = {
  143. # The paper size ('letterpaper' or 'a4paper').
  144. #'papersize': 'letterpaper',
  145. # The font size ('10pt', '11pt' or '12pt').
  146. #'pointsize': '10pt',
  147. # Additional stuff for the LaTeX preamble.
  148. #'preamble': '',
  149. }
  150. # Grouping the document tree into LaTeX files. List of tuples
  151. # (source start file, target name, title,
  152. # author, documentclass [howto, manual, or own class]).
  153. latex_documents = [
  154. ('index', 'Synapse.tex', u'Synapse Documentation',
  155. u'TNG', 'manual'),
  156. ]
  157. # The name of an image file (relative to this directory) to place at the top of
  158. # the title page.
  159. #latex_logo = None
  160. # For "manual" documents, if this is true, then toplevel headings are parts,
  161. # not chapters.
  162. #latex_use_parts = False
  163. # If true, show page references after internal links.
  164. #latex_show_pagerefs = False
  165. # If true, show URL addresses after external links.
  166. #latex_show_urls = False
  167. # Documents to append as an appendix to all manuals.
  168. #latex_appendices = []
  169. # If false, no module index is generated.
  170. #latex_domain_indices = True
  171. # -- Options for manual page output ---------------------------------------
  172. # One entry per manual page. List of tuples
  173. # (source start file, name, description, authors, manual section).
  174. man_pages = [
  175. ('index', 'synapse', u'Synapse Documentation',
  176. [u'TNG'], 1)
  177. ]
  178. # If true, show URL addresses after external links.
  179. #man_show_urls = False
  180. # -- Options for Texinfo output -------------------------------------------
  181. # Grouping the document tree into Texinfo files. List of tuples
  182. # (source start file, target name, title, author,
  183. # dir menu entry, description, category)
  184. texinfo_documents = [
  185. ('index', 'Synapse', u'Synapse Documentation',
  186. u'TNG', 'Synapse', 'One line description of project.',
  187. 'Miscellaneous'),
  188. ]
  189. # Documents to append as an appendix to all manuals.
  190. #texinfo_appendices = []
  191. # If false, no module index is generated.
  192. #texinfo_domain_indices = True
  193. # How to display URL addresses: 'footnote', 'no', or 'inline'.
  194. #texinfo_show_urls = 'footnote'
  195. # If true, do not generate a @detailmenu in the "Top" node's menu.
  196. #texinfo_no_detailmenu = False
  197. # Example configuration for intersphinx: refer to the Python standard library.
  198. intersphinx_mapping = {'http://docs.python.org/': None}
  199. napoleon_include_special_with_doc = True
  200. napoleon_use_ivar = True