Anders and Briegel in Python
Vous ne pouvez pas sélectionner plus de 25 sujets Les noms de sujets doivent commencer par une lettre ou un nombre, peuvent contenir des tirets ('-') et peuvent comporter jusqu'à 35 caractères.

289 lignes
9.0KB

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