Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 226 lines (171 sloc) 6.795 kb
9587886 @mcdonc initial bit of code for foldering and cataloging
mcdonc authored
1 # -*- coding: utf-8 -*-
2 #
3 # substanced documentation build configuration file
4 #
5 # This file is execfile()d with the current directory set to its containing
6 # dir.
7 #
8 # The contents of this file are pickled, so don't put values in the
9 # namespace that aren't pickleable (module imports are okay, they're
10 # removed automatically).
11 #
12 # All configuration values have a default value; values that are commented
13 # out serve to show the default value.
14
15 # If your extensions are in another directory, add it here. If the
16 # directory is relative to the documentation root, use os.path.abspath to
17 # make it absolute, like shown here.
18 #sys.path.append(os.path.abspath('some/directory'))
19
20
21 import sys, os
22
23 # Add and use Pylons theme
24 if 'sphinx-build' in ' '.join(sys.argv): # protect against dumb importers
25 from subprocess import call, Popen, PIPE
26
27 p = Popen('which git', shell=True, stdout=PIPE)
28 git = p.stdout.read().strip()
29 cwd = os.getcwd()
30 _themes = os.path.join(cwd, '_themes')
31
32 if not os.path.isdir(_themes):
33 call([git, 'clone', 'git://github.com/Pylons/pylons_sphinx_theme.git',
34 '_themes'])
35 else:
36 os.chdir(_themes)
37 call([git, 'checkout', 'master'])
38 call([git, 'pull'])
39 os.chdir(cwd)
40
41 sys.path.append(os.path.abspath('_themes'))
42
43 # General configuration
44 # ---------------------
45
46 # Add any Sphinx extension module names here, as strings. They can be
47 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
48 extensions = [
49 'sphinx.ext.autodoc',
50 'sphinx.ext.intersphinx',
25a9ce9 @mcdonc docs
mcdonc authored
51 'repoze.sphinx.autointerface',
9587886 @mcdonc initial bit of code for foldering and cataloging
mcdonc authored
52 ]
53
54 # Looks for pyramid's objects
55 intersphinx_mapping = {
56 'pyramid':
57 ('http://docs.pylonsproject.org/projects/pyramid/en/latest/', None)}
58
59 # Add any paths that contain templates here, relative to this directory.
60 templates_path = ['.templates']
61
62 # The suffix of source filenames.
63 source_suffix = '.rst'
64
65 # The master toctree document.
66 master_doc = 'index'
67
68 # General substitutions.
69 project = 'substanced'
70 copyright = '2012, Agendaless Consulting <chrism@plope.com>'
71
72 # The default replacements for |version| and |release|, also used in various
73 # other places throughout the built documents.
74 #
75 # The short X.Y version.
4d77b23 @mcdonc version
mcdonc authored
76 version = '0.0'
9587886 @mcdonc initial bit of code for foldering and cataloging
mcdonc authored
77 # The full version, including alpha/beta/rc tags.
78 release = version
79
80 # There are two options for replacing |today|: either, you set today to
81 # some non-false value, then it is used:
82 #today = ''
83 # Else, today_fmt is used as the format for a strftime call.
84 today_fmt = '%B %d, %Y'
85
86 # List of documents that shouldn't be included in the build.
87 #unused_docs = []
88
89 # List of directories, relative to source directories, that shouldn't be
90 # searched for source files.
91 #exclude_dirs = []
92
93 exclude_patterns = ['_themes/README.rst',]
94
95 # The reST default role (used for this markup: `text`) to use for all
96 # documents.
97 #default_role = None
98
99 # If true, '()' will be appended to :func: etc. cross-reference text.
100 #add_function_parentheses = True
101
102 # If true, the current module name will be prepended to all description
103 # unit titles (such as .. function::).
104 #add_module_names = True
105
106 # If true, sectionauthor and moduleauthor directives will be shown in the
107 # output. They are ignored by default.
108 #show_authors = False
109
110 # The name of the Pygments (syntax highlighting) style to use.
111 pygments_style = 'sphinx'
112
113
114 # Options for HTML output
115 # -----------------------
116
117 # Add and use Pylons theme
118 html_theme_path = ['_themes']
119 html_theme = 'pyramid'
120 html_theme_options = dict(
121 github_url='https://github.com/Pylons/substanced',
122 # in_progress='true'
123 )
124
125 # The style sheet to use for HTML and HTML Help pages. A file of that name
126 # must exist either in Sphinx' static/ path, or in one of the custom paths
127 # given in html_static_path.
128 # html_style = 'repoze.css'
129
130 # The name for this set of Sphinx documents. If None, it defaults to
131 # "<project> v<release> documentation".
132 #html_title = None
133
134 # A shorter title for the navigation bar. Default is the same as
135 # html_title.
136 #html_short_title = None
137
138 # The name of an image file (within the static path) to place at the top of
139 # the sidebar.
140 # html_logo = '.static/logo_hi.gif'
141
142 # The name of an image file (within the static path) to use as favicon of
143 # the docs. This file should be a Windows icon file (.ico) being 16x16 or
144 # 32x32 pixels large.
145 #html_favicon = None
146
147 # Add any paths that contain custom static files (such as style sheets)
148 # here, relative to this directory. They are copied after the builtin
149 # static files, so a file named "default.css" will overwrite the builtin
150 # "default.css".
151 #html_static_path = ['.static']
152
153 # If not '', a 'Last updated on:' timestamp is inserted at every page
154 # bottom, using the given strftime format.
155 html_last_updated_fmt = '%b %d, %Y'
156
157 # If true, SmartyPants will be used to convert quotes and dashes to
158 # typographically correct entities.
159 #html_use_smartypants = True
160
161 # Custom sidebar templates, maps document names to template names.
162 #html_sidebars = {}
163
164 # Additional templates that should be rendered to pages, maps page names to
165 # template names.
166 #html_additional_pages = {}
167
168 # If false, no module index is generated.
169 #html_use_modindex = True
170
171 # If false, no index is generated.
172 #html_use_index = True
173
174 # If true, the index is split into individual pages for each letter.
175 #html_split_index = False
176
177 # If true, the reST sources are included in the HTML build as
178 # _sources/<name>.
179 #html_copy_source = True
180
181 # If true, an OpenSearch description file will be output, and all pages
182 # will contain a <link> tag referring to it. The value of this option must
183 # be the base URL from which the finished HTML is served.
184 #html_use_opensearch = ''
185
186 # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
187 #html_file_suffix = ''
188
189 # Output file base name for HTML help builder.
190 htmlhelp_basename = 'atemplatedoc'
191
192
193 # Options for LaTeX output
194 # ------------------------
195
196 # The paper size ('letter' or 'a4').
197 #latex_paper_size = 'letter'
198
199 # The font size ('10pt', '11pt' or '12pt').
200 #latex_font_size = '10pt'
201
202 # Grouping the document tree into LaTeX files. List of tuples
203 # (source start file, target name, title,
204 # author, document class [howto/manual]).
205 latex_documents = [
206 ('index', 'substanced.tex', 'substanced Documentation',
207 'Repoze Developers', 'manual'),
208 ]
209
210 # The name of an image file (relative to this directory) to place at the
211 # top of the title page.
212 latex_logo = '.static/logo_hi.gif'
213
214 # For "manual" documents, if this is true, then toplevel headings are
215 # parts, not chapters.
216 #latex_use_parts = False
217
218 # Additional stuff for the LaTeX preamble.
219 #latex_preamble = ''
220
221 # Documents to append as an appendix to all manuals.
222 #latex_appendices = []
223
224 # If false, no module index is generated.
225 #latex_use_modindex = True
Something went wrong with that request. Please try again.