A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot

243 wiersze
7.7 KiB

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