/conf.py

https://bitbucket.org/shibu/sphinx-usersjp-web/ · Python · 196 lines · 27 code · 51 blank · 118 comment · 0 complexity · b03ed649ab69f54c5b68cf6a3af8ede6 MD5 · raw file

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Sphinx-Users.jp documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Jan 7 15:34:51 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. # -- General configuration -----------------------------------------------------
  19. # Add any Sphinx extension module names here, as strings. They can be extensions
  20. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  21. extensions = ['sphinx.ext.todo', 'japanesesupport']
  22. # Add any paths that contain templates here, relative to this directory.
  23. templates_path = ['_templates']
  24. # The suffix of source filenames.
  25. source_suffix = '.rst'
  26. # The encoding of source files.
  27. #source_encoding = 'utf-8'
  28. # The master toctree document.
  29. master_doc = 'index'
  30. # General information about the project.
  31. project = u'Sphinx-Users.jp'
  32. copyright = u'2010-2011, Sphinx-Users.jp'
  33. # The version info for the project you're documenting, acts as replacement for
  34. # |version| and |release|, also used in various other places throughout the
  35. # built documents.
  36. #
  37. # The short X.Y version.
  38. version = '1.0'
  39. # The full version, including alpha/beta/rc tags.
  40. release = '1.0'
  41. # The language for content autogenerated by Sphinx. Refer to documentation
  42. # for a list of supported languages.
  43. language = 'ja'
  44. # There are two options for replacing |today|: either, you set today to some
  45. # non-false value, then it is used:
  46. #today = ''
  47. # Else, today_fmt is used as the format for a strftime call.
  48. #today_fmt = '%B %d, %Y'
  49. # List of documents that shouldn't be included in the build.
  50. #unused_docs = []
  51. # List of directories, relative to source directory, that shouldn't be searched
  52. # for source files.
  53. exclude_trees = []
  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. Major themes that come with
  70. # Sphinx are currently 'default' and 'sphinxdoc'.
  71. html_theme = 'sphinx-jp'
  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. 'top_image': ''
  77. }
  78. # Add any paths that contain custom themes here, relative to this directory.
  79. html_theme_path = ['.']
  80. # The name for this set of Sphinx documents. If None, it defaults to
  81. # "<project> v<release> documentation".
  82. html_title = u'Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会'
  83. # A shorter title for the navigation bar. Default is the same as html_title.
  84. #html_short_title = None
  85. # The name of an image file (relative to this directory) to place at the top
  86. # of the sidebar.
  87. html_logo = '_static/logo.png'
  88. # The name of an image file (within the static path) to use as favicon of the
  89. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  90. # pixels large.
  91. #html_favicon = None
  92. # Add any paths that contain custom static files (such as style sheets) here,
  93. # relative to this directory. They are copied after the builtin static files,
  94. # so a file named "default.css" will overwrite the builtin "default.css".
  95. html_static_path = ['_static']
  96. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  97. # using the given strftime format.
  98. html_last_updated_fmt = '%b %d, %Y'
  99. # If true, SmartyPants will be used to convert quotes and dashes to
  100. # typographically correct entities.
  101. #html_use_smartypants = True
  102. # Custom sidebar templates, maps document names to template names.
  103. #html_sidebars = {}
  104. # Additional templates that should be rendered to pages, maps page names to
  105. # template names.
  106. #html_additional_pages = {}
  107. # If false, no module index is generated.
  108. #html_use_modindex = True
  109. # If false, no index is generated.
  110. #html_use_index = True
  111. # If true, the index is split into individual pages for each letter.
  112. #html_split_index = False
  113. # If true, links to the reST sources are added to the pages.
  114. #html_show_sourcelink = True
  115. # If true, an OpenSearch description file will be output, and all pages will
  116. # contain a <link> tag referring to it. The value of this option must be the
  117. # base URL from which the finished HTML is served.
  118. #html_use_opensearch = ''
  119. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  120. #html_file_suffix = ''
  121. # Output file base name for HTML help builder.
  122. htmlhelp_basename = 'Sphinx-Usersjpdoc'
  123. # -- Options for LaTeX output --------------------------------------------------
  124. # The paper size ('letter' or 'a4').
  125. #latex_paper_size = 'letter'
  126. # The font size ('10pt', '11pt' or '12pt').
  127. #latex_font_size = '10pt'
  128. # Grouping the document tree into LaTeX files. List of tuples
  129. # (source start file, target name, title, author, documentclass [howto/manual]).
  130. latex_documents = [
  131. ('index', 'Sphinx-Usersjp.tex', u'Sphinx-Users.jp Documentation',
  132. u'Sphinx-Users.jp', 'manual'),
  133. ]
  134. # The name of an image file (relative to this directory) to place at the top of
  135. # the title page.
  136. #latex_logo = None
  137. # For "manual" documents, if this is true, then toplevel headings are parts,
  138. # not chapters.
  139. #latex_use_parts = False
  140. # Additional stuff for the LaTeX preamble.
  141. #latex_preamble = ''
  142. # Documents to append as an appendix to all manuals.
  143. #latex_appendices = []
  144. # If false, no module index is generated.
  145. #latex_use_modindex = True