conf.py 8.2 KB

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