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