/docs/conf.py

https://bitbucket.org/neithere/argh/ · Python · 244 lines · 24 code · 65 blank · 155 comment · 2 complexity · bdf68637668ff560a5e86d6cd650f3fb MD5 · raw file

  1. # -*- coding: utf-8 -*-
  2. #
  3. # argh documentation build configuration file, created by
  4. # sphinx-quickstart on Tue Nov 9 23:06:31 2010.
  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.append(os.path.abspath('..'))
  18. from argh import __version__ as full_version
  19. # -- General configuration -----------------------------------------------------
  20. # If your documentation needs a minimal Sphinx version, state it here.
  21. #needs_sphinx = '1.0'
  22. # Add any Sphinx extension module names here, as strings. They can be extensions
  23. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  24. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage']
  25. # Add any paths that contain templates here, relative to this directory.
  26. templates_path = ['_templates']
  27. # The suffix of source filenames.
  28. source_suffix = '.rst'
  29. # The encoding of source files.
  30. #source_encoding = 'utf-8-sig'
  31. # The master toctree document.
  32. master_doc = 'index'
  33. # General information about the project.
  34. project = u'argh'
  35. copyright = u'2013, Andrey Mikhaylenko'
  36. # The version info for the project you're documenting, acts as replacement for
  37. # |version| and |release|, also used in various other places throughout the
  38. # built documents.
  39. #
  40. # The short X.Y version.
  41. version = full_version.rpartition('.')[0]
  42. # The full version, including alpha/beta/rc tags.
  43. release = full_version
  44. # The language for content autogenerated by Sphinx. Refer to documentation
  45. # for a list of supported languages.
  46. #language = None
  47. # There are two options for replacing |today|: either, you set today to some
  48. # non-false value, then it is used:
  49. #today = ''
  50. # Else, today_fmt is used as the format for a strftime call.
  51. #today_fmt = '%B %d, %Y'
  52. # List of patterns, relative to source directory, that match files and
  53. # directories to ignore when looking for source files.
  54. exclude_patterns = ['_build']
  55. # The reST default role (used for this markup: `text`) to use for all documents.
  56. #default_role = None
  57. # If true, '()' will be appended to :func: etc. cross-reference text.
  58. #add_function_parentheses = True
  59. # If true, the current module name will be prepended to all description
  60. # unit titles (such as .. function::).
  61. #add_module_names = True
  62. # If true, sectionauthor and moduleauthor directives will be shown in the
  63. # output. They are ignored by default.
  64. #show_authors = False
  65. # The name of the Pygments (syntax highlighting) style to use.
  66. pygments_style = 'sphinx'
  67. # A list of ignored prefixes for module index sorting.
  68. #modindex_common_prefix = []
  69. # -- Options for HTML output ---------------------------------------------------
  70. # The theme to use for HTML and HTML Help pages. Major themes that come with
  71. # Sphinx are currently 'default' and 'sphinxdoc'.
  72. # see http://read-the-docs.readthedocs.org/en/latest/faq.html#how-do-i-change-behavior-for-read-the-docs
  73. on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
  74. if on_rtd:
  75. html_theme = 'default'
  76. else:
  77. html_theme = 'nature'
  78. # Theme options are theme-specific and customize the look and feel of a theme
  79. # further. For a list of options available for each theme, see the
  80. # documentation.
  81. #html_theme_options = {}
  82. # Add any paths that contain custom themes here, relative to this directory.
  83. #html_theme_path = []
  84. # The name for this set of Sphinx documents. If None, it defaults to
  85. # "<project> v<release> documentation".
  86. #html_title = None
  87. # A shorter title for the navigation bar. Default is the same as html_title.
  88. #html_short_title = None
  89. # The name of an image file (relative to this directory) to place at the top
  90. # of the sidebar.
  91. #html_logo = None
  92. # The name of an image file (within the static path) to use as favicon of the
  93. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  94. # pixels large.
  95. #html_favicon = None
  96. # Add any paths that contain custom static files (such as style sheets) here,
  97. # relative to this directory. They are copied after the builtin static files,
  98. # so a file named "default.css" will overwrite the builtin "default.css".
  99. html_static_path = ['_static']
  100. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  101. # using the given strftime format.
  102. #html_last_updated_fmt = '%b %d, %Y'
  103. # If true, SmartyPants will be used to convert quotes and dashes to
  104. # typographically correct entities.
  105. #html_use_smartypants = True
  106. # Custom sidebar templates, maps document names to template names.
  107. #html_sidebars = {}
  108. # Additional templates that should be rendered to pages, maps page names to
  109. # template names.
  110. #html_additional_pages = {}
  111. # If false, no module index is generated.
  112. #html_use_modindex = True
  113. # If false, no index is generated.
  114. #html_use_index = True
  115. # If true, the index is split into individual pages for each letter.
  116. #html_split_index = False
  117. # If true, links to the reST sources are added to the pages.
  118. #html_show_sourcelink = True
  119. # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
  120. #html_show_sphinx = True
  121. # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
  122. #html_show_copyright = True
  123. # If true, an OpenSearch description file will be output, and all pages will
  124. # contain a <link> tag referring to it. The value of this option must be the
  125. # base URL from which the finished HTML is served.
  126. #html_use_opensearch = ''
  127. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  128. #html_file_suffix = ''
  129. # Output file base name for HTML help builder.
  130. htmlhelp_basename = 'arghdoc'
  131. # -- Options for LaTeX output --------------------------------------------------
  132. # The paper size ('letter' or 'a4').
  133. #latex_paper_size = 'letter'
  134. # The font size ('10pt', '11pt' or '12pt').
  135. #latex_font_size = '10pt'
  136. # Grouping the document tree into LaTeX files. List of tuples
  137. # (source start file, target name, title, author, documentclass [howto/manual]).
  138. latex_documents = [
  139. ('index', 'argh.tex', u'argh Documentation',
  140. u'Andrey Mikhaylenko', 'manual'),
  141. ]
  142. # The name of an image file (relative to this directory) to place at the top of
  143. # the title page.
  144. #latex_logo = None
  145. # For "manual" documents, if this is true, then toplevel headings are parts,
  146. # not chapters.
  147. #latex_use_parts = False
  148. # Additional stuff for the LaTeX preamble.
  149. #latex_preamble = ''
  150. # Documents to append as an appendix to all manuals.
  151. #latex_appendices = []
  152. # If false, no module index is generated.
  153. #latex_use_modindex = True
  154. # -- Options for Epub output ---------------------------------------------------
  155. # Bibliographic Dublin Core info.
  156. #epub_title = ''
  157. #epub_author = ''
  158. #epub_publisher = ''
  159. #epub_copyright = ''
  160. # The language of the text. It defaults to the language option
  161. # or en if the language is not set.
  162. #epub_language = ''
  163. # The scheme of the identifier. Typical schemes are ISBN or URL.
  164. #epub_scheme = ''
  165. # The unique identifier of the text. This can be a ISBN number
  166. # or the project homepage.
  167. #epub_identifier = ''
  168. # A unique identification for the text.
  169. #epub_uid = ''
  170. # HTML files that should be inserted before the pages created by sphinx.
  171. # The format is a list of tuples containing the path and title.
  172. #epub_pre_files = []
  173. # HTML files shat should be inserted after the pages created by sphinx.
  174. # The format is a list of tuples containing the path and title.
  175. #epub_post_files = []
  176. # A list of files that should not be packed into the epub file.
  177. #epub_exclude_files = []
  178. # The depth of the table of contents in toc.ncx.
  179. #epub_tocdepth = 3