conf.py 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192
  1. # -*- coding: utf-8 -*-
  2. #
  3. # repoze.who documentation build configuration file, created by
  4. # sphinx-quickstart on Wed Jul 16 13:18:14 2008.
  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. # All configuration values have a default value; values that are commented out
  12. # serve to show the default value.
  13. import sys, os
  14. # If your extensions are in another directory, add it here. If the directory
  15. # is relative to the documentation root, use os.path.abspath to make it
  16. # absolute, like shown here.
  17. parent = os.path.dirname(os.path.dirname(__file__))
  18. sys.path.append(os.path.abspath(parent))
  19. wd = os.getcwd()
  20. os.chdir(parent)
  21. os.system('%s setup.py test -q' % sys.executable)
  22. os.chdir(wd)
  23. for item in os.listdir(parent):
  24. if item.endswith('.egg'):
  25. sys.path.append(os.path.join(parent, item))
  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 = [
  31. 'sphinx.ext.autodoc',
  32. 'sphinx.ext.doctest',
  33. 'repoze.sphinx.autointerface',
  34. ]
  35. # Add any paths that contain templates here, relative to this directory.
  36. templates_path = ['.templates']
  37. # The suffix of source filenames.
  38. source_suffix = '.rst'
  39. # The master toctree document.
  40. master_doc = 'index'
  41. # General substitutions.
  42. project = 'repoze.who'
  43. copyright = '2008 - 2013, Agendaless Consulting'
  44. # The default replacements for |version| and |release|, also used in various
  45. # other places throughout the built documents.
  46. #
  47. # The short X.Y version.
  48. version = '2.2'
  49. # The full version, including alpha/beta/rc tags.
  50. release = version
  51. # There are two options for replacing |today|: either, you set today to some
  52. # non-false value, then it is used:
  53. #today = ''
  54. # Else, today_fmt is used as the format for a strftime call.
  55. today_fmt = '%B %d, %Y'
  56. # List of documents that shouldn't be included in the build.
  57. #unused_docs = []
  58. # List of directories, relative to source directories, that shouldn't be searched
  59. # for source files.
  60. #exclude_dirs = []
  61. # The reST default role (used for this markup: `text`) to use for all documents.
  62. #default_role = None
  63. # If true, '()' will be appended to :func: etc. cross-reference text.
  64. #add_function_parentheses = True
  65. # If true, the current module name will be prepended to all description
  66. # unit titles (such as .. function::).
  67. #add_module_names = True
  68. # If true, sectionauthor and moduleauthor directives will be shown in the
  69. # output. They are ignored by default.
  70. #show_authors = False
  71. # The name of the Pygments (syntax highlighting) style to use.
  72. pygments_style = 'sphinx'
  73. # Options for HTML output
  74. # -----------------------
  75. # The style sheet to use for HTML and HTML Help pages. A file of that name
  76. # must exist either in Sphinx' static/ path, or in one of the custom paths
  77. # given in html_static_path.
  78. html_style = 'repoze.css'
  79. # The name for this set of Sphinx documents. If None, it defaults to
  80. # "<project> v<release> documentation".
  81. #html_title = None
  82. # A shorter title for the navigation bar. Default is the same as html_title.
  83. #html_short_title = None
  84. # The name of an image file (within the static path) to place at the top of
  85. # the sidebar.
  86. html_logo = '.static/logo_hi.gif'
  87. # The name of an image file (within the static path) to use as favicon of the
  88. # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
  89. # pixels large.
  90. #html_favicon = None
  91. # Add any paths that contain custom static files (such as style sheets) here,
  92. # relative to this directory. They are copied after the builtin static files,
  93. # so a file named "default.css" will overwrite the builtin "default.css".
  94. html_static_path = ['.static']
  95. # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
  96. # using the given strftime format.
  97. html_last_updated_fmt = '%b %d, %Y'
  98. # If true, SmartyPants will be used to convert quotes and dashes to
  99. # typographically correct entities.
  100. #html_use_smartypants = True
  101. # Custom sidebar templates, maps document names to template names.
  102. #html_sidebars = {}
  103. # Additional templates that should be rendered to pages, maps page names to
  104. # template names.
  105. #html_additional_pages = {}
  106. # If false, no module index is generated.
  107. #html_use_modindex = True
  108. # If false, no index is generated.
  109. #html_use_index = True
  110. # If true, the index is split into individual pages for each letter.
  111. #html_split_index = False
  112. # If true, the reST sources are included in the HTML build as _sources/<name>.
  113. #html_copy_source = True
  114. # If true, an OpenSearch description file will be output, and all pages will
  115. # contain a <link> tag referring to it. The value of this option must be the
  116. # base URL from which the finished HTML is served.
  117. #html_use_opensearch = ''
  118. # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
  119. #html_file_suffix = ''
  120. # Output file base name for HTML help builder.
  121. htmlhelp_basename = 'repozebfgdoc'
  122. # Options for LaTeX output
  123. # ------------------------
  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, document class [howto/manual]).
  130. latex_documents = [
  131. ('index', 'repozebfg.tex', 'repoze.who Documentation', 'Agendaless Consulting', 'manual'),
  132. ]
  133. # The name of an image file (relative to this directory) to place at the top of
  134. # the title page.
  135. latex_logo = '.static/logo_hi.gif'
  136. # For "manual" documents, if this is true, then toplevel headings are parts,
  137. # not chapters.
  138. #latex_use_parts = False
  139. # Additional stuff for the LaTeX preamble.
  140. #latex_preamble = ''
  141. # Documents to append as an appendix to all manuals.
  142. #latex_appendices = []
  143. # If false, no module index is generated.
  144. #latex_use_modindex = True