conf.py 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242
  1. # -*- coding: utf-8 -*-
  2. #
  3. # nose documentation build configuration file, created by
  4. # sphinx-quickstart on Thu Mar 26 16:49:00 2009.
  5. #
  6. # This file is execfile()d with the current directory set to its containing dir.
  7. #
  8. # The contents of this file are pickled, so don't put values in the namespace
  9. # that aren't pickleable (module imports are okay, they're removed automatically).
  10. #
  11. # Note that not all possible configuration values are present in this
  12. # autogenerated file.
  13. #
  14. # All configuration values have a default; values that are commented out
  15. # serve to show the default.
  16. import sys, os
  17. # If your extensions are in another directory, add it here. If the directory
  18. # is relative to the documentation root, use os.path.abspath to make it
  19. # absolute, like shown here.
  20. # need to be brutal because of easy_install's pth hacks:
  21. sys.path.insert(0,
  22. os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
  23. sys.path.insert(0, os.path.abspath('.'))
  24. from nose import __versioninfo__ as nose_version
  25. nose_version = tuple(str(x) for x in nose_version)
  26. # General configuration
  27. # ---------------------
  28. # Add any Sphinx extension module names here, as strings. They can be extensions
  29. # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
  30. extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
  31. 'nose.sphinx.pluginopts']
  32. # Add any paths that contain templates here, relative to this directory.
  33. templates_path = ['.templates']
  34. # The suffix of source filenames.
  35. source_suffix = '.rst'
  36. # The encoding of source files.
  37. #source_encoding = 'utf-8'
  38. # The master toctree document.
  39. master_doc = 'index'
  40. # General information about the project.
  41. project = u'nose'
  42. copyright = u'2009, Jason Pellerin'
  43. # The version info for the project you're documenting, acts as replacement for
  44. # |version| and |release|, also used in various other places throughout the
  45. # built documents.
  46. #
  47. # The short X.Y version.
  48. version = '.'.join(nose_version[:2])
  49. # The full version, including alpha/beta/rc tags.
  50. release = '.'.join(nose_version[:3])
  51. # The language for content autogenerated by Sphinx. Refer to documentation
  52. # for a list of supported languages.
  53. #language = None
  54. # There are two options for replacing |today|: either, you set today to some
  55. # non-false value, then it is used:
  56. #today = ''
  57. # Else, today_fmt is used as the format for a strftime call.
  58. #today_fmt = '%B %d, %Y'
  59. # List of documents that shouldn't be included in the build.
  60. #unused_docs = []
  61. # List of directories, relative to source directory, that shouldn't be searched
  62. # for source files.
  63. exclude_trees = ['.build']
  64. # The reST default role (used for this markup: `text`) to use for all documents.
  65. #default_role = None
  66. # If true, '()' will be appended to :func: etc. cross-reference text.
  67. #add_function_parentheses = True
  68. # If true, the current module name will be prepended to all description
  69. # unit titles (such as .. function::).
  70. #add_module_names = True
  71. # If true, sectionauthor and moduleauthor directives will be shown in the
  72. # output. They are ignored by default.
  73. #show_authors = False
  74. # The name of the Pygments (syntax highlighting) style to use.
  75. pygments_style = 'trac'
  76. # Options for HTML output
  77. # -----------------------
  78. # The style sheet to use for HTML and HTML Help pages. A file of that name
  79. # must exist either in Sphinx' static/ path, or in one of the custom paths
  80. # given in html_static_path.
  81. html_style = 'nose.css'
  82. # The name for this set of Sphinx documents. If None, it defaults to
  83. # "<project> v<release> documentation".
  84. #html_title = None
  85. # A shorter title for the navigation bar. Default is the same as html_title.
  86. #html_short_title = None
  87. # The name of an image file (relative to this directory) to place at the top
  88. # of the sidebar.
  89. #html_logo = None
  90. # The name of an image file (within the static path) to use as favicon of the
  91. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  92. # pixels large.
  93. #html_favicon = None
  94. # Add any paths that contain custom static files (such as style sheets) here,
  95. # relative to this directory. They are copied after the builtin static files,
  96. # so a file named "default.css" will overwrite the builtin "default.css".
  97. html_static_path = ['.static']
  98. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  99. # using the given strftime format.
  100. #html_last_updated_fmt = '%b %d, %Y'
  101. # If true, SmartyPants will be used to convert quotes and dashes to
  102. # typographically correct entities.
  103. #html_use_smartypants = True
  104. # Custom sidebar templates, maps document names to template names.
  105. html_sidebars = {
  106. 'index': 'indexsidebar.html'
  107. }
  108. # Additional templates that should be rendered to pages, maps page names to
  109. # template names.
  110. # html_additional_pages = {'index': 'index.html'}
  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, the reST sources are included in the HTML build as _sources/<name>.
  118. #html_copy_source = True
  119. # If true, an OpenSearch description file will be output, and all pages will
  120. # contain a <link> tag referring to it. The value of this option must be the
  121. # base URL from which the finished HTML is served.
  122. #html_use_opensearch = ''
  123. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  124. #html_file_suffix = ''
  125. # Output file base name for HTML help builder.
  126. htmlhelp_basename = 'nosedoc'
  127. """
  128. footerbgcolor (CSS color): Background color for the footer line.
  129. footertextcolor (CSS color): Text color for the footer line.
  130. sidebarbgcolor (CSS color): Background color for the sidebar.
  131. sidebartextcolor (CSS color): Text color for the sidebar.
  132. sidebarlinkcolor (CSS color): Link color for the sidebar.
  133. relbarbgcolor (CSS color): Background color for the relation bar.
  134. relbartextcolor (CSS color): Text color for the relation bar.
  135. relbarlinkcolor (CSS color): Link color for the relation bar.
  136. bgcolor (CSS color): Body background color.
  137. textcolor (CSS color): Body text color.
  138. linkcolor (CSS color): Body link color.
  139. headbgcolor (CSS color): Background color for headings.
  140. headtextcolor (CSS color): Text color for headings.
  141. headlinkcolor (CSS color): Link color for headings.
  142. codebgcolor (CSS color): Background color for code blocks.
  143. codetextcolor (CSS color): Default text color for code blocks, if not set differently by the highlighting style.
  144. bodyfont (CSS font-family): Font for normal text.
  145. headfont (CSS font-family): Font for headings.
  146. """
  147. html_theme_options = {
  148. 'rightsidebar': 'true',
  149. 'sidebarbgcolor': '#fff',
  150. 'sidebartextcolor': '#20435c',
  151. 'sidebarlinkcolor': '#355f7c',
  152. 'bgcolor': '#fff',
  153. 'codebgcolor': '#ffe',
  154. 'headbgcolor': '#fff',
  155. 'relbarbgcolor': '#fff',
  156. 'relbartextcolor': '#20435c',
  157. 'relbarlinkcolor': '#355f7c',
  158. }
  159. # the css mostly overrides this:
  160. html_theme = 'default'
  161. # Options for LaTeX output
  162. # ------------------------
  163. # The paper size ('letter' or 'a4').
  164. #latex_paper_size = 'letter'
  165. # The font size ('10pt', '11pt' or '12pt').
  166. #latex_font_size = '10pt'
  167. # Grouping the document tree into LaTeX files. List of tuples
  168. # (source start file, target name, title, author, document class [howto/manual]).
  169. latex_documents = [
  170. ('index', 'nose.tex', ur'nose Documentation',
  171. ur'Jason Pellerin', 'manual'),
  172. ]
  173. # The name of an image file (relative to this directory) to place at the top of
  174. # the title page.
  175. #latex_logo = None
  176. # For "manual" documents, if this is true, then toplevel headings are parts,
  177. # not chapters.
  178. #latex_use_parts = False
  179. # Additional stuff for the LaTeX preamble.
  180. #latex_preamble = ''
  181. # Documents to append as an appendix to all manuals.
  182. #latex_appendices = []
  183. # If false, no module index is generated.
  184. #latex_use_modindex = True
  185. # Example configuration for intersphinx: refer to the Python standard library.
  186. intersphinx_mapping = {'http://docs.python.org/dev': None}
  187. # Man page
  188. man_pages = [('man', 'nosetests', 'Nicer testing for Python', 'Nose developers', 1)]