Anders and Briegel in Python

conf.py 9.0KB

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