Status: | Merged |
---|---|
Approved by: | Eric Day |
Approved revision: | 12 |
Merged at revision: | 5 |
Proposed branch: | lp:~eday/burrow/start-docs |
Merge into: | lp:burrow |
Diff against target: |
845 lines (+770/-1) 11 files modified
.bzrignore (+3/-0) ChangeLog (+4/-0) MANIFEST.in (+1/-0) burrow/__init__.py (+1/-1) doc/source/_ga/layout.html (+17/-0) doc/source/_static/basic.css (+416/-0) doc/source/_static/tweaks.css (+65/-0) doc/source/_theme/layout.html (+2/-0) doc/source/_theme/theme.conf (+5/-0) doc/source/conf.py (+218/-0) doc/source/index.rst (+38/-0) |
To merge this branch: | bzr merge lp:~eday/burrow/start-docs |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Burrow Core Team | Pending | ||
Review via email: mp+56675@code.launchpad.net |
Commit message
Description of the change
Added hooks and templates to build OpenStack themed Sphinx documentation.
To post a comment you must log in.
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === added file '.bzrignore' | |||
2 | --- .bzrignore 1970-01-01 00:00:00 +0000 | |||
3 | +++ .bzrignore 2011-04-07 00:17:24 +0000 | |||
4 | @@ -0,0 +1,3 @@ | |||
5 | 1 | burrow.egg-info | ||
6 | 2 | dist | ||
7 | 3 | doc/build/* | ||
8 | 0 | 4 | ||
9 | === modified file 'ChangeLog' | |||
10 | --- ChangeLog 2011-04-06 02:03:37 +0000 | |||
11 | +++ ChangeLog 2011-04-07 00:17:24 +0000 | |||
12 | @@ -1,3 +1,7 @@ | |||
13 | 1 | 2011-04-05 Eric Day <eday@oddments.org> | ||
14 | 2 | |||
15 | 3 | Added command line tool, start of client class, and HTTP backend. | ||
16 | 4 | |||
17 | 1 | 2011-03-30 Eric Day <eday@oddments.org> | 5 | 2011-03-30 Eric Day <eday@oddments.org> |
18 | 2 | 6 | ||
19 | 3 | Merged burrow and burrowd packages, the interfaces for backend/client can be shared, and this will also allow modular in-process queues. | 7 | Merged burrow and burrowd packages, the interfaces for backend/client can be shared, and this will also allow modular in-process queues. |
20 | 4 | 8 | ||
21 | === modified file 'MANIFEST.in' | |||
22 | --- MANIFEST.in 2011-03-18 00:47:26 +0000 | |||
23 | +++ MANIFEST.in 2011-04-07 00:17:24 +0000 | |||
24 | @@ -1,3 +1,4 @@ | |||
25 | 1 | graft doc | ||
26 | 1 | graft etc | 2 | graft etc |
27 | 2 | graft locale | 3 | graft locale |
28 | 3 | include Authors | 4 | include Authors |
29 | 4 | 5 | ||
30 | === modified file 'burrow/__init__.py' | |||
31 | --- burrow/__init__.py 2011-04-06 02:03:37 +0000 | |||
32 | +++ burrow/__init__.py 2011-04-07 00:17:24 +0000 | |||
33 | @@ -22,7 +22,7 @@ | |||
34 | 22 | from burrow.server import Server | 22 | from burrow.server import Server |
35 | 23 | import burrow.config | 23 | import burrow.config |
36 | 24 | 24 | ||
38 | 25 | __version__ = '0.1' | 25 | __version__ = '2011.2' |
39 | 26 | 26 | ||
40 | 27 | # This installs the _(...) function as a built-in so all other modules | 27 | # This installs the _(...) function as a built-in so all other modules |
41 | 28 | # don't need to. | 28 | # don't need to. |
42 | 29 | 29 | ||
43 | === added directory 'doc' | |||
44 | === added directory 'doc/build' | |||
45 | === added directory 'doc/source' | |||
46 | === added directory 'doc/source/_ga' | |||
47 | === added file 'doc/source/_ga/layout.html' | |||
48 | --- doc/source/_ga/layout.html 1970-01-01 00:00:00 +0000 | |||
49 | +++ doc/source/_ga/layout.html 2011-04-07 00:17:24 +0000 | |||
50 | @@ -0,0 +1,17 @@ | |||
51 | 1 | {% extends "!layout.html" %} | ||
52 | 2 | |||
53 | 3 | {% block footer %} | ||
54 | 4 | {{ super() }} | ||
55 | 5 | <script type="text/javascript"> | ||
56 | 6 | var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); | ||
57 | 7 | document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); | ||
58 | 8 | </script> | ||
59 | 9 | <script type="text/javascript"> | ||
60 | 10 | try { | ||
61 | 11 | var pageTracker = _gat._getTracker("UA-17511903-4"); | ||
62 | 12 | pageTracker._setDomainName("none"); | ||
63 | 13 | pageTracker._setAllowLinker(true); | ||
64 | 14 | pageTracker._trackPageview(); | ||
65 | 15 | } catch(err) {}</script> | ||
66 | 16 | {% endblock %} | ||
67 | 17 | |||
68 | 0 | 18 | ||
69 | === added directory 'doc/source/_static' | |||
70 | === added file 'doc/source/_static/basic.css' | |||
71 | --- doc/source/_static/basic.css 1970-01-01 00:00:00 +0000 | |||
72 | +++ doc/source/_static/basic.css 2011-04-07 00:17:24 +0000 | |||
73 | @@ -0,0 +1,416 @@ | |||
74 | 1 | /** | ||
75 | 2 | * Sphinx stylesheet -- basic theme | ||
76 | 3 | * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
77 | 4 | */ | ||
78 | 5 | |||
79 | 6 | /* -- main layout ----------------------------------------------------------- */ | ||
80 | 7 | |||
81 | 8 | div.clearer { | ||
82 | 9 | clear: both; | ||
83 | 10 | } | ||
84 | 11 | |||
85 | 12 | /* -- relbar ---------------------------------------------------------------- */ | ||
86 | 13 | |||
87 | 14 | div.related { | ||
88 | 15 | width: 100%; | ||
89 | 16 | font-size: 90%; | ||
90 | 17 | } | ||
91 | 18 | |||
92 | 19 | div.related h3 { | ||
93 | 20 | display: none; | ||
94 | 21 | } | ||
95 | 22 | |||
96 | 23 | div.related ul { | ||
97 | 24 | margin: 0; | ||
98 | 25 | padding: 0 0 0 10px; | ||
99 | 26 | list-style: none; | ||
100 | 27 | } | ||
101 | 28 | |||
102 | 29 | div.related li { | ||
103 | 30 | display: inline; | ||
104 | 31 | } | ||
105 | 32 | |||
106 | 33 | div.related li.right { | ||
107 | 34 | float: right; | ||
108 | 35 | margin-right: 5px; | ||
109 | 36 | } | ||
110 | 37 | |||
111 | 38 | /* -- sidebar --------------------------------------------------------------- */ | ||
112 | 39 | |||
113 | 40 | div.sphinxsidebarwrapper { | ||
114 | 41 | padding: 10px 5px 0 10px; | ||
115 | 42 | } | ||
116 | 43 | |||
117 | 44 | div.sphinxsidebar { | ||
118 | 45 | float: left; | ||
119 | 46 | width: 230px; | ||
120 | 47 | margin-left: -100%; | ||
121 | 48 | font-size: 90%; | ||
122 | 49 | } | ||
123 | 50 | |||
124 | 51 | div.sphinxsidebar ul { | ||
125 | 52 | list-style: none; | ||
126 | 53 | } | ||
127 | 54 | |||
128 | 55 | div.sphinxsidebar ul ul, | ||
129 | 56 | div.sphinxsidebar ul.want-points { | ||
130 | 57 | margin-left: 20px; | ||
131 | 58 | list-style: square; | ||
132 | 59 | } | ||
133 | 60 | |||
134 | 61 | div.sphinxsidebar ul ul { | ||
135 | 62 | margin-top: 0; | ||
136 | 63 | margin-bottom: 0; | ||
137 | 64 | } | ||
138 | 65 | |||
139 | 66 | div.sphinxsidebar form { | ||
140 | 67 | margin-top: 10px; | ||
141 | 68 | } | ||
142 | 69 | |||
143 | 70 | div.sphinxsidebar input { | ||
144 | 71 | border: 1px solid #98dbcc; | ||
145 | 72 | font-family: sans-serif; | ||
146 | 73 | font-size: 1em; | ||
147 | 74 | } | ||
148 | 75 | |||
149 | 76 | img { | ||
150 | 77 | border: 0; | ||
151 | 78 | } | ||
152 | 79 | |||
153 | 80 | /* -- search page ----------------------------------------------------------- */ | ||
154 | 81 | |||
155 | 82 | ul.search { | ||
156 | 83 | margin: 10px 0 0 20px; | ||
157 | 84 | padding: 0; | ||
158 | 85 | } | ||
159 | 86 | |||
160 | 87 | ul.search li { | ||
161 | 88 | padding: 5px 0 5px 20px; | ||
162 | 89 | background-image: url(file.png); | ||
163 | 90 | background-repeat: no-repeat; | ||
164 | 91 | background-position: 0 7px; | ||
165 | 92 | } | ||
166 | 93 | |||
167 | 94 | ul.search li a { | ||
168 | 95 | font-weight: bold; | ||
169 | 96 | } | ||
170 | 97 | |||
171 | 98 | ul.search li div.context { | ||
172 | 99 | color: #888; | ||
173 | 100 | margin: 2px 0 0 30px; | ||
174 | 101 | text-align: left; | ||
175 | 102 | } | ||
176 | 103 | |||
177 | 104 | ul.keywordmatches li.goodmatch a { | ||
178 | 105 | font-weight: bold; | ||
179 | 106 | } | ||
180 | 107 | |||
181 | 108 | /* -- index page ------------------------------------------------------------ */ | ||
182 | 109 | |||
183 | 110 | table.contentstable { | ||
184 | 111 | width: 90%; | ||
185 | 112 | } | ||
186 | 113 | |||
187 | 114 | table.contentstable p.biglink { | ||
188 | 115 | line-height: 150%; | ||
189 | 116 | } | ||
190 | 117 | |||
191 | 118 | a.biglink { | ||
192 | 119 | font-size: 1.3em; | ||
193 | 120 | } | ||
194 | 121 | |||
195 | 122 | span.linkdescr { | ||
196 | 123 | font-style: italic; | ||
197 | 124 | padding-top: 5px; | ||
198 | 125 | font-size: 90%; | ||
199 | 126 | } | ||
200 | 127 | |||
201 | 128 | /* -- general index --------------------------------------------------------- */ | ||
202 | 129 | |||
203 | 130 | table.indextable td { | ||
204 | 131 | text-align: left; | ||
205 | 132 | vertical-align: top; | ||
206 | 133 | } | ||
207 | 134 | |||
208 | 135 | table.indextable dl, table.indextable dd { | ||
209 | 136 | margin-top: 0; | ||
210 | 137 | margin-bottom: 0; | ||
211 | 138 | } | ||
212 | 139 | |||
213 | 140 | table.indextable tr.pcap { | ||
214 | 141 | height: 10px; | ||
215 | 142 | } | ||
216 | 143 | |||
217 | 144 | table.indextable tr.cap { | ||
218 | 145 | margin-top: 10px; | ||
219 | 146 | background-color: #f2f2f2; | ||
220 | 147 | } | ||
221 | 148 | |||
222 | 149 | img.toggler { | ||
223 | 150 | margin-right: 3px; | ||
224 | 151 | margin-top: 3px; | ||
225 | 152 | cursor: pointer; | ||
226 | 153 | } | ||
227 | 154 | |||
228 | 155 | /* -- general body styles --------------------------------------------------- */ | ||
229 | 156 | |||
230 | 157 | a.headerlink { | ||
231 | 158 | visibility: hidden; | ||
232 | 159 | } | ||
233 | 160 | |||
234 | 161 | h1:hover > a.headerlink, | ||
235 | 162 | h2:hover > a.headerlink, | ||
236 | 163 | h3:hover > a.headerlink, | ||
237 | 164 | h4:hover > a.headerlink, | ||
238 | 165 | h5:hover > a.headerlink, | ||
239 | 166 | h6:hover > a.headerlink, | ||
240 | 167 | dt:hover > a.headerlink { | ||
241 | 168 | visibility: visible; | ||
242 | 169 | } | ||
243 | 170 | |||
244 | 171 | div.body p.caption { | ||
245 | 172 | text-align: inherit; | ||
246 | 173 | } | ||
247 | 174 | |||
248 | 175 | div.body td { | ||
249 | 176 | text-align: left; | ||
250 | 177 | } | ||
251 | 178 | |||
252 | 179 | .field-list ul { | ||
253 | 180 | padding-left: 1em; | ||
254 | 181 | } | ||
255 | 182 | |||
256 | 183 | .first { | ||
257 | 184 | } | ||
258 | 185 | |||
259 | 186 | p.rubric { | ||
260 | 187 | margin-top: 30px; | ||
261 | 188 | font-weight: bold; | ||
262 | 189 | } | ||
263 | 190 | |||
264 | 191 | /* -- sidebars -------------------------------------------------------------- */ | ||
265 | 192 | |||
266 | 193 | div.sidebar { | ||
267 | 194 | margin: 0 0 0.5em 1em; | ||
268 | 195 | border: 1px solid #ddb; | ||
269 | 196 | padding: 7px 7px 0 7px; | ||
270 | 197 | background-color: #ffe; | ||
271 | 198 | width: 40%; | ||
272 | 199 | float: right; | ||
273 | 200 | } | ||
274 | 201 | |||
275 | 202 | p.sidebar-title { | ||
276 | 203 | font-weight: bold; | ||
277 | 204 | } | ||
278 | 205 | |||
279 | 206 | /* -- topics ---------------------------------------------------------------- */ | ||
280 | 207 | |||
281 | 208 | div.topic { | ||
282 | 209 | border: 1px solid #ccc; | ||
283 | 210 | padding: 7px 7px 0 7px; | ||
284 | 211 | margin: 10px 0 10px 0; | ||
285 | 212 | } | ||
286 | 213 | |||
287 | 214 | p.topic-title { | ||
288 | 215 | font-size: 1.1em; | ||
289 | 216 | font-weight: bold; | ||
290 | 217 | margin-top: 10px; | ||
291 | 218 | } | ||
292 | 219 | |||
293 | 220 | /* -- admonitions ----------------------------------------------------------- */ | ||
294 | 221 | |||
295 | 222 | div.admonition { | ||
296 | 223 | margin-top: 10px; | ||
297 | 224 | margin-bottom: 10px; | ||
298 | 225 | padding: 7px; | ||
299 | 226 | } | ||
300 | 227 | |||
301 | 228 | div.admonition dt { | ||
302 | 229 | font-weight: bold; | ||
303 | 230 | } | ||
304 | 231 | |||
305 | 232 | div.admonition dl { | ||
306 | 233 | margin-bottom: 0; | ||
307 | 234 | } | ||
308 | 235 | |||
309 | 236 | p.admonition-title { | ||
310 | 237 | margin: 0px 10px 5px 0px; | ||
311 | 238 | font-weight: bold; | ||
312 | 239 | } | ||
313 | 240 | |||
314 | 241 | div.body p.centered { | ||
315 | 242 | text-align: center; | ||
316 | 243 | margin-top: 25px; | ||
317 | 244 | } | ||
318 | 245 | |||
319 | 246 | /* -- tables ---------------------------------------------------------------- */ | ||
320 | 247 | |||
321 | 248 | table.docutils { | ||
322 | 249 | border: 0; | ||
323 | 250 | border-collapse: collapse; | ||
324 | 251 | } | ||
325 | 252 | |||
326 | 253 | table.docutils td, table.docutils th { | ||
327 | 254 | padding: 1px 8px 1px 0; | ||
328 | 255 | border-top: 0; | ||
329 | 256 | border-left: 0; | ||
330 | 257 | border-right: 0; | ||
331 | 258 | border-bottom: 1px solid #aaa; | ||
332 | 259 | } | ||
333 | 260 | |||
334 | 261 | table.field-list td, table.field-list th { | ||
335 | 262 | border: 0 !important; | ||
336 | 263 | } | ||
337 | 264 | |||
338 | 265 | table.footnote td, table.footnote th { | ||
339 | 266 | border: 0 !important; | ||
340 | 267 | } | ||
341 | 268 | |||
342 | 269 | th { | ||
343 | 270 | text-align: left; | ||
344 | 271 | padding-right: 5px; | ||
345 | 272 | } | ||
346 | 273 | |||
347 | 274 | /* -- other body styles ----------------------------------------------------- */ | ||
348 | 275 | |||
349 | 276 | dl { | ||
350 | 277 | margin-bottom: 15px; | ||
351 | 278 | } | ||
352 | 279 | |||
353 | 280 | dd p { | ||
354 | 281 | margin-top: 0px; | ||
355 | 282 | } | ||
356 | 283 | |||
357 | 284 | dd ul, dd table { | ||
358 | 285 | margin-bottom: 10px; | ||
359 | 286 | } | ||
360 | 287 | |||
361 | 288 | dd { | ||
362 | 289 | margin-top: 3px; | ||
363 | 290 | margin-bottom: 10px; | ||
364 | 291 | margin-left: 30px; | ||
365 | 292 | } | ||
366 | 293 | |||
367 | 294 | dt:target, .highlight { | ||
368 | 295 | background-color: #fbe54e; | ||
369 | 296 | } | ||
370 | 297 | |||
371 | 298 | dl.glossary dt { | ||
372 | 299 | font-weight: bold; | ||
373 | 300 | font-size: 1.1em; | ||
374 | 301 | } | ||
375 | 302 | |||
376 | 303 | .field-list ul { | ||
377 | 304 | margin: 0; | ||
378 | 305 | padding-left: 1em; | ||
379 | 306 | } | ||
380 | 307 | |||
381 | 308 | .field-list p { | ||
382 | 309 | margin: 0; | ||
383 | 310 | } | ||
384 | 311 | |||
385 | 312 | .refcount { | ||
386 | 313 | color: #060; | ||
387 | 314 | } | ||
388 | 315 | |||
389 | 316 | .optional { | ||
390 | 317 | font-size: 1.3em; | ||
391 | 318 | } | ||
392 | 319 | |||
393 | 320 | .versionmodified { | ||
394 | 321 | font-style: italic; | ||
395 | 322 | } | ||
396 | 323 | |||
397 | 324 | .system-message { | ||
398 | 325 | background-color: #fda; | ||
399 | 326 | padding: 5px; | ||
400 | 327 | border: 3px solid red; | ||
401 | 328 | } | ||
402 | 329 | |||
403 | 330 | .footnote:target { | ||
404 | 331 | background-color: #ffa | ||
405 | 332 | } | ||
406 | 333 | |||
407 | 334 | .line-block { | ||
408 | 335 | display: block; | ||
409 | 336 | margin-top: 1em; | ||
410 | 337 | margin-bottom: 1em; | ||
411 | 338 | } | ||
412 | 339 | |||
413 | 340 | .line-block .line-block { | ||
414 | 341 | margin-top: 0; | ||
415 | 342 | margin-bottom: 0; | ||
416 | 343 | margin-left: 1.5em; | ||
417 | 344 | } | ||
418 | 345 | |||
419 | 346 | /* -- code displays --------------------------------------------------------- */ | ||
420 | 347 | |||
421 | 348 | pre { | ||
422 | 349 | overflow: auto; | ||
423 | 350 | } | ||
424 | 351 | |||
425 | 352 | td.linenos pre { | ||
426 | 353 | padding: 5px 0px; | ||
427 | 354 | border: 0; | ||
428 | 355 | background-color: transparent; | ||
429 | 356 | color: #aaa; | ||
430 | 357 | } | ||
431 | 358 | |||
432 | 359 | table.highlighttable { | ||
433 | 360 | margin-left: 0.5em; | ||
434 | 361 | } | ||
435 | 362 | |||
436 | 363 | table.highlighttable td { | ||
437 | 364 | padding: 0 0.5em 0 0.5em; | ||
438 | 365 | } | ||
439 | 366 | |||
440 | 367 | tt.descname { | ||
441 | 368 | background-color: transparent; | ||
442 | 369 | font-weight: bold; | ||
443 | 370 | font-size: 1.2em; | ||
444 | 371 | } | ||
445 | 372 | |||
446 | 373 | tt.descclassname { | ||
447 | 374 | background-color: transparent; | ||
448 | 375 | } | ||
449 | 376 | |||
450 | 377 | tt.xref, a tt { | ||
451 | 378 | background-color: transparent; | ||
452 | 379 | font-weight: bold; | ||
453 | 380 | } | ||
454 | 381 | |||
455 | 382 | h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { | ||
456 | 383 | background-color: transparent; | ||
457 | 384 | } | ||
458 | 385 | |||
459 | 386 | /* -- math display ---------------------------------------------------------- */ | ||
460 | 387 | |||
461 | 388 | img.math { | ||
462 | 389 | vertical-align: middle; | ||
463 | 390 | } | ||
464 | 391 | |||
465 | 392 | div.body div.math p { | ||
466 | 393 | text-align: center; | ||
467 | 394 | } | ||
468 | 395 | |||
469 | 396 | span.eqno { | ||
470 | 397 | float: right; | ||
471 | 398 | } | ||
472 | 399 | |||
473 | 400 | /* -- printout stylesheet --------------------------------------------------- */ | ||
474 | 401 | |||
475 | 402 | @media print { | ||
476 | 403 | div.document, | ||
477 | 404 | div.documentwrapper, | ||
478 | 405 | div.bodywrapper { | ||
479 | 406 | margin: 0 !important; | ||
480 | 407 | width: 100%; | ||
481 | 408 | } | ||
482 | 409 | |||
483 | 410 | div.sphinxsidebar, | ||
484 | 411 | div.related, | ||
485 | 412 | div.footer, | ||
486 | 413 | #top-link { | ||
487 | 414 | display: none; | ||
488 | 415 | } | ||
489 | 416 | } | ||
490 | 0 | 417 | ||
491 | === added file 'doc/source/_static/tweaks.css' | |||
492 | --- doc/source/_static/tweaks.css 1970-01-01 00:00:00 +0000 | |||
493 | +++ doc/source/_static/tweaks.css 2011-04-07 00:17:24 +0000 | |||
494 | @@ -0,0 +1,65 @@ | |||
495 | 1 | ul.todo_list { | ||
496 | 2 | list-style-type: none; | ||
497 | 3 | margin: 0; | ||
498 | 4 | padding: 0; | ||
499 | 5 | } | ||
500 | 6 | |||
501 | 7 | ul.todo_list li { | ||
502 | 8 | display: block; | ||
503 | 9 | margin: 0; | ||
504 | 10 | padding: 7px 0; | ||
505 | 11 | border-top: 1px solid #eee; | ||
506 | 12 | } | ||
507 | 13 | |||
508 | 14 | ul.todo_list li p { | ||
509 | 15 | display: inline; | ||
510 | 16 | } | ||
511 | 17 | |||
512 | 18 | ul.todo_list li p.link { | ||
513 | 19 | font-weight: bold; | ||
514 | 20 | } | ||
515 | 21 | |||
516 | 22 | ul.todo_list li p.details { | ||
517 | 23 | font-style: italic; | ||
518 | 24 | } | ||
519 | 25 | |||
520 | 26 | ul.todo_list li { | ||
521 | 27 | } | ||
522 | 28 | |||
523 | 29 | div.admonition { | ||
524 | 30 | border: 1px solid #8F1000; | ||
525 | 31 | } | ||
526 | 32 | |||
527 | 33 | div.admonition p.admonition-title { | ||
528 | 34 | background-color: #8F1000; | ||
529 | 35 | border-bottom: 1px solid #8E8E8E; | ||
530 | 36 | } | ||
531 | 37 | |||
532 | 38 | a { | ||
533 | 39 | color: #CF2F19; | ||
534 | 40 | } | ||
535 | 41 | |||
536 | 42 | div.related ul li a { | ||
537 | 43 | color: #CF2F19; | ||
538 | 44 | } | ||
539 | 45 | |||
540 | 46 | div.sphinxsidebar h4 { | ||
541 | 47 | background-color:#8E8E8E; | ||
542 | 48 | border:1px solid #255E6E; | ||
543 | 49 | color:white; | ||
544 | 50 | font-size:1em; | ||
545 | 51 | margin:1em 0 0.5em; | ||
546 | 52 | padding:0.1em 0 0.1em 0.5em; | ||
547 | 53 | } | ||
548 | 54 | |||
549 | 55 | em { | ||
550 | 56 | font-style: normal; | ||
551 | 57 | } | ||
552 | 58 | |||
553 | 59 | table.docutils { | ||
554 | 60 | font-size: 11px; | ||
555 | 61 | } | ||
556 | 62 | |||
557 | 63 | a tt { | ||
558 | 64 | color:#CF2F19; | ||
559 | 65 | } | ||
560 | 0 | \ No newline at end of file | 66 | \ No newline at end of file |
561 | 1 | 67 | ||
562 | === added directory 'doc/source/_templates' | |||
563 | === added directory 'doc/source/_theme' | |||
564 | === added file 'doc/source/_theme/layout.html' | |||
565 | --- doc/source/_theme/layout.html 1970-01-01 00:00:00 +0000 | |||
566 | +++ doc/source/_theme/layout.html 2011-04-07 00:17:24 +0000 | |||
567 | @@ -0,0 +1,2 @@ | |||
568 | 1 | {% extends "sphinxdoc/layout.html" %} | ||
569 | 2 | {% set css_files = css_files + ['_static/tweaks.css'] %} | ||
570 | 0 | 3 | ||
571 | === added file 'doc/source/_theme/theme.conf' | |||
572 | --- doc/source/_theme/theme.conf 1970-01-01 00:00:00 +0000 | |||
573 | +++ doc/source/_theme/theme.conf 2011-04-07 00:17:24 +0000 | |||
574 | @@ -0,0 +1,5 @@ | |||
575 | 1 | [theme] | ||
576 | 2 | inherit = sphinxdoc | ||
577 | 3 | stylesheet = sphinxdoc.css | ||
578 | 4 | pygments_style = friendly | ||
579 | 5 | |||
580 | 0 | 6 | ||
581 | === added file 'doc/source/conf.py' | |||
582 | --- doc/source/conf.py 1970-01-01 00:00:00 +0000 | |||
583 | +++ doc/source/conf.py 2011-04-07 00:17:24 +0000 | |||
584 | @@ -0,0 +1,218 @@ | |||
585 | 1 | # Copyright (C) 2011 OpenStack LLC. | ||
586 | 2 | # | ||
587 | 3 | # Licensed under the Apache License, Version 2.0 (the "License"); | ||
588 | 4 | # you may not use this file except in compliance with the License. | ||
589 | 5 | # You may obtain a copy of the License at | ||
590 | 6 | # | ||
591 | 7 | # http://www.apache.org/licenses/LICENSE-2.0 | ||
592 | 8 | # | ||
593 | 9 | # Unless required by applicable law or agreed to in writing, software | ||
594 | 10 | # distributed under the License is distributed on an "AS IS" BASIS, | ||
595 | 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
596 | 12 | # See the License for the specific language governing permissions and | ||
597 | 13 | # limitations under the License. | ||
598 | 14 | |||
599 | 15 | # Burrow documentation build configuration file, created by | ||
600 | 16 | # sphinx-quickstart on Wed Apr 6 13:19:31 2011. | ||
601 | 17 | # | ||
602 | 18 | # This file is execfile()d with the current directory set to its containing dir. | ||
603 | 19 | # | ||
604 | 20 | # Note that not all possible configuration values are present in this | ||
605 | 21 | # autogenerated file. | ||
606 | 22 | # | ||
607 | 23 | # All configuration values have a default; values that are commented out | ||
608 | 24 | # serve to show the default. | ||
609 | 25 | |||
610 | 26 | import sys, os | ||
611 | 27 | |||
612 | 28 | # If extensions (or modules to document with autodoc) are in another directory, | ||
613 | 29 | # add these directories to sys.path here. If the directory is relative to the | ||
614 | 30 | # documentation root, use os.path.abspath to make it absolute, like shown here. | ||
615 | 31 | sys.path.append([os.path.abspath('../burrow'), os.path.abspath('..'), os.path.abspath('../bin')]) | ||
616 | 32 | |||
617 | 33 | # -- General configuration ----------------------------------------------------- | ||
618 | 34 | |||
619 | 35 | # Add any Sphinx extension module names here, as strings. They can be extensions | ||
620 | 36 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. | ||
621 | 37 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.pngmath', 'sphinx.ext.ifconfig'] | ||
622 | 38 | todo_include_todos = True | ||
623 | 39 | |||
624 | 40 | # Add any paths that contain templates here, relative to this directory. | ||
625 | 41 | templates_path = [] | ||
626 | 42 | if os.getenv('HUDSON_PUBLISH_DOCS'): | ||
627 | 43 | templates_path = ['_ga', '_templates'] | ||
628 | 44 | else: | ||
629 | 45 | templates_path = ['_templates'] | ||
630 | 46 | |||
631 | 47 | # The suffix of source filenames. | ||
632 | 48 | source_suffix = '.rst' | ||
633 | 49 | |||
634 | 50 | # The encoding of source files. | ||
635 | 51 | #source_encoding = 'utf-8' | ||
636 | 52 | |||
637 | 53 | # The master toctree document. | ||
638 | 54 | master_doc = 'index' | ||
639 | 55 | |||
640 | 56 | # General information about the project. | ||
641 | 57 | project = u'Burrow' | ||
642 | 58 | copyright = u'2011, OpenStack, LLC' | ||
643 | 59 | |||
644 | 60 | # The version info for the project you're documenting, acts as replacement for | ||
645 | 61 | # |version| and |release|, also used in various other places throughout the | ||
646 | 62 | # built documents. | ||
647 | 63 | # | ||
648 | 64 | # The short X.Y version. | ||
649 | 65 | import burrow | ||
650 | 66 | version = burrow.__version__.rsplit('.', 1)[0] | ||
651 | 67 | # The full version, including alpha/beta/rc tags. | ||
652 | 68 | release = burrow.__version__ | ||
653 | 69 | |||
654 | 70 | # The language for content autogenerated by Sphinx. Refer to documentation | ||
655 | 71 | # for a list of supported languages. | ||
656 | 72 | #language = None | ||
657 | 73 | |||
658 | 74 | # There are two options for replacing |today|: either, you set today to some | ||
659 | 75 | # non-false value, then it is used: | ||
660 | 76 | #today = '' | ||
661 | 77 | # Else, today_fmt is used as the format for a strftime call. | ||
662 | 78 | #today_fmt = '%B %d, %Y' | ||
663 | 79 | |||
664 | 80 | # List of documents that shouldn't be included in the build. | ||
665 | 81 | #unused_docs = [] | ||
666 | 82 | |||
667 | 83 | # List of directories, relative to source directory, that shouldn't be searched | ||
668 | 84 | # for source files. | ||
669 | 85 | exclude_trees = [] | ||
670 | 86 | |||
671 | 87 | # The reST default role (used for this markup: `text`) to use for all documents. | ||
672 | 88 | #default_role = None | ||
673 | 89 | |||
674 | 90 | # If true, '()' will be appended to :func: etc. cross-reference text. | ||
675 | 91 | #add_function_parentheses = True | ||
676 | 92 | |||
677 | 93 | # If true, the current module name will be prepended to all description | ||
678 | 94 | # unit titles (such as .. function::). | ||
679 | 95 | #add_module_names = True | ||
680 | 96 | |||
681 | 97 | # If true, sectionauthor and moduleauthor directives will be shown in the | ||
682 | 98 | # output. They are ignored by default. | ||
683 | 99 | show_authors = True | ||
684 | 100 | |||
685 | 101 | # The name of the Pygments (syntax highlighting) style to use. | ||
686 | 102 | pygments_style = 'sphinx' | ||
687 | 103 | |||
688 | 104 | # A list of ignored prefixes for module index sorting. | ||
689 | 105 | modindex_common_prefix = ['burrow.'] | ||
690 | 106 | |||
691 | 107 | |||
692 | 108 | # -- Options for HTML output --------------------------------------------------- | ||
693 | 109 | |||
694 | 110 | # The theme to use for HTML and HTML Help pages. Major themes that come with | ||
695 | 111 | # Sphinx are currently 'default' and 'sphinxdoc'. | ||
696 | 112 | html_theme = '_theme' | ||
697 | 113 | |||
698 | 114 | # Theme options are theme-specific and customize the look and feel of a theme | ||
699 | 115 | # further. For a list of options available for each theme, see the | ||
700 | 116 | # documentation. | ||
701 | 117 | #html_theme_options = {} | ||
702 | 118 | |||
703 | 119 | # Add any paths that contain custom themes here, relative to this directory. | ||
704 | 120 | html_theme_path = ['.'] | ||
705 | 121 | |||
706 | 122 | # The name for this set of Sphinx documents. If None, it defaults to | ||
707 | 123 | # "<project> v<release> documentation". | ||
708 | 124 | #html_title = None | ||
709 | 125 | |||
710 | 126 | # A shorter title for the navigation bar. Default is the same as html_title. | ||
711 | 127 | #html_short_title = None | ||
712 | 128 | |||
713 | 129 | # The name of an image file (relative to this directory) to place at the top | ||
714 | 130 | # of the sidebar. | ||
715 | 131 | #html_logo = None | ||
716 | 132 | |||
717 | 133 | # The name of an image file (within the static path) to use as favicon of the | ||
718 | 134 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 | ||
719 | 135 | # pixels large. | ||
720 | 136 | #html_favicon = None | ||
721 | 137 | |||
722 | 138 | # Add any paths that contain custom static files (such as style sheets) here, | ||
723 | 139 | # relative to this directory. They are copied after the builtin static files, | ||
724 | 140 | # so a file named "default.css" will overwrite the builtin "default.css". | ||
725 | 141 | html_static_path = ['_static'] | ||
726 | 142 | |||
727 | 143 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, | ||
728 | 144 | # using the given strftime format. | ||
729 | 145 | #html_last_updated_fmt = '%b %d, %Y' | ||
730 | 146 | |||
731 | 147 | # If true, SmartyPants will be used to convert quotes and dashes to | ||
732 | 148 | # typographically correct entities. | ||
733 | 149 | #html_use_smartypants = True | ||
734 | 150 | |||
735 | 151 | # Custom sidebar templates, maps document names to template names. | ||
736 | 152 | #html_sidebars = {} | ||
737 | 153 | |||
738 | 154 | # Additional templates that should be rendered to pages, maps page names to | ||
739 | 155 | # template names. | ||
740 | 156 | #html_additional_pages = {} | ||
741 | 157 | |||
742 | 158 | # If false, no module index is generated. | ||
743 | 159 | #html_use_modindex = True | ||
744 | 160 | |||
745 | 161 | # If false, no index is generated. | ||
746 | 162 | #html_use_index = True | ||
747 | 163 | |||
748 | 164 | # If true, the index is split into individual pages for each letter. | ||
749 | 165 | #html_split_index = False | ||
750 | 166 | |||
751 | 167 | # If true, links to the reST sources are added to the pages. | ||
752 | 168 | #html_show_sourcelink = True | ||
753 | 169 | |||
754 | 170 | # If true, an OpenSearch description file will be output, and all pages will | ||
755 | 171 | # contain a <link> tag referring to it. The value of this option must be the | ||
756 | 172 | # base URL from which the finished HTML is served. | ||
757 | 173 | #html_use_opensearch = '' | ||
758 | 174 | |||
759 | 175 | # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | ||
760 | 176 | #html_file_suffix = '' | ||
761 | 177 | |||
762 | 178 | # Output file base name for HTML help builder. | ||
763 | 179 | htmlhelp_basename = 'burrowdoc' | ||
764 | 180 | |||
765 | 181 | |||
766 | 182 | # -- Options for LaTeX output -------------------------------------------------- | ||
767 | 183 | |||
768 | 184 | # The paper size ('letter' or 'a4'). | ||
769 | 185 | #latex_paper_size = 'letter' | ||
770 | 186 | |||
771 | 187 | # The font size ('10pt', '11pt' or '12pt'). | ||
772 | 188 | #latex_font_size = '10pt' | ||
773 | 189 | |||
774 | 190 | # Grouping the document tree into LaTeX files. List of tuples | ||
775 | 191 | # (source start file, target name, title, author, documentclass [howto/manual]). | ||
776 | 192 | latex_documents = [ | ||
777 | 193 | ('index', 'Burrow.tex', u'Burrow Documentation', | ||
778 | 194 | u'OpenStack, LLC', 'manual'), | ||
779 | 195 | ] | ||
780 | 196 | |||
781 | 197 | # The name of an image file (relative to this directory) to place at the top of | ||
782 | 198 | # the title page. | ||
783 | 199 | #latex_logo = None | ||
784 | 200 | |||
785 | 201 | # For "manual" documents, if this is true, then toplevel headings are parts, | ||
786 | 202 | # not chapters. | ||
787 | 203 | #latex_use_parts = False | ||
788 | 204 | |||
789 | 205 | # Additional stuff for the LaTeX preamble. | ||
790 | 206 | #latex_preamble = '' | ||
791 | 207 | |||
792 | 208 | # Documents to append as an appendix to all manuals. | ||
793 | 209 | #latex_appendices = [] | ||
794 | 210 | |||
795 | 211 | # If false, no module index is generated. | ||
796 | 212 | #latex_use_modindex = True | ||
797 | 213 | |||
798 | 214 | # Example configuration for intersphinx: refer to the Python standard library. | ||
799 | 215 | intersphinx_mapping = {'python': ('http://docs.python.org/', None), | ||
800 | 216 | 'glance': ('http://glance.openstack.org', None), | ||
801 | 217 | 'nova': ('http://nova.openstack.org', None), | ||
802 | 218 | 'swift': ('http://swift.openstack.org', None)} | ||
803 | 0 | 219 | ||
804 | === added file 'doc/source/index.rst' | |||
805 | --- doc/source/index.rst 1970-01-01 00:00:00 +0000 | |||
806 | +++ doc/source/index.rst 2011-04-07 00:17:24 +0000 | |||
807 | @@ -0,0 +1,38 @@ | |||
808 | 1 | .. | ||
809 | 2 | Copyright (C) 2011 OpenStack LLC. | ||
810 | 3 | |||
811 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); | ||
812 | 5 | you may not use this file except in compliance with the License. | ||
813 | 6 | You may obtain a copy of the License at | ||
814 | 7 | |||
815 | 8 | http://www.apache.org/licenses/LICENSE-2.0 | ||
816 | 9 | |||
817 | 10 | Unless required by applicable law or agreed to in writing, software | ||
818 | 11 | distributed under the License is distributed on an "AS IS" BASIS, | ||
819 | 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
820 | 13 | See the License for the specific language governing permissions and | ||
821 | 14 | limitations under the License. | ||
822 | 15 | |||
823 | 16 | Welcome to Burrow's documentation! | ||
824 | 17 | ================================== | ||
825 | 18 | |||
826 | 19 | Burrow is a highly available, distributed, multi-tenant message | ||
827 | 20 | queue. Burrow can be used in a variety of environments, from simple | ||
828 | 21 | in-process queues to cloud-based message queue services. | ||
829 | 22 | |||
830 | 23 | This documentation is generated by the Sphinx toolkit and lives in the | ||
831 | 24 | source tree. Additional documentation on Swift and other components | ||
832 | 25 | of OpenStack can be found on the `OpenStack wiki`_. | ||
833 | 26 | |||
834 | 27 | .. _`OpenStack wiki`: http://wiki.openstack.org | ||
835 | 28 | |||
836 | 29 | .. toctree:: | ||
837 | 30 | :maxdepth: 1 | ||
838 | 31 | |||
839 | 32 | Indices and tables | ||
840 | 33 | ================== | ||
841 | 34 | |||
842 | 35 | * :ref:`genindex` | ||
843 | 36 | * :ref:`modindex` | ||
844 | 37 | * :ref:`search` | ||
845 | 38 |