conf.py 9.5 KB

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