conf.py 6.9 KB

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