Merge "Update RPM-specs to 2013.2 version" into openstack-ci/build/havana
[openstack-build/cinder-build.git] / rpm / SOURCES / 0004-Revert-Use-oslo.sphinx-and-remove-local-copy-of-doc-.patch
1 From bd1bfd86fbeacd893ff5d9abb969c7b0c994fbf4 Mon Sep 17 00:00:00 2001
2 From: =?UTF-8?q?P=C3=A1draig=20Brady?= <P@draigBrady.com>
3 Date: Mon, 22 Jul 2013 03:14:27 +0100
4 Subject: [PATCH] Revert "Use oslo.sphinx and remove local copy of doc theme"
5
6 This reverts commit 8b1ae18ba95f04fedc04592b419401d75d448543.
7
8 Conflicts:
9
10         test-requirements.txt
11 ---
12  doc/source/_static/.gitignore      |   0
13  doc/source/_static/.placeholder    |   0
14  doc/source/_static/basic.css       | 416 +++++++++++++++++++++++++++++++++++++
15  doc/source/_static/default.css     | 230 ++++++++++++++++++++
16  doc/source/_static/jquery.tweet.js | 154 ++++++++++++++
17  doc/source/_static/tweaks.css      | 218 +++++++++++++++++++
18  doc/source/_templates/.gitignore   |   0
19  doc/source/_templates/.placeholder |   0
20  doc/source/_theme/layout.html      |  95 +++++++++
21  doc/source/_theme/theme.conf       |   5 +
22  doc/source/conf.py                 |   8 +-
23  test-requirements.txt              |   1 -
24  12 files changed, 1121 insertions(+), 6 deletions(-)
25  create mode 100644 doc/source/_static/.gitignore
26  create mode 100644 doc/source/_static/.placeholder
27  create mode 100644 doc/source/_static/basic.css
28  create mode 100644 doc/source/_static/default.css
29  create mode 100644 doc/source/_static/jquery.tweet.js
30  create mode 100644 doc/source/_static/tweaks.css
31  create mode 100644 doc/source/_templates/.gitignore
32  create mode 100644 doc/source/_templates/.placeholder
33  create mode 100644 doc/source/_theme/layout.html
34  create mode 100644 doc/source/_theme/theme.conf
35
36 diff --git a/doc/source/_static/.gitignore b/doc/source/_static/.gitignore
37 new file mode 100644
38 index 0000000..e69de29
39 diff --git a/doc/source/_static/.placeholder b/doc/source/_static/.placeholder
40 new file mode 100644
41 index 0000000..e69de29
42 diff --git a/doc/source/_static/basic.css b/doc/source/_static/basic.css
43 new file mode 100644
44 index 0000000..d909ce3
45 --- /dev/null
46 +++ b/doc/source/_static/basic.css
47 @@ -0,0 +1,416 @@
48 +/**
49 + * Sphinx stylesheet -- basic theme
50 + * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51 + */
52 +
53 +/* -- main layout ----------------------------------------------------------- */
54 +
55 +div.clearer {
56 +    clear: both;
57 +}
58 +
59 +/* -- relbar ---------------------------------------------------------------- */
60 +
61 +div.related {
62 +    width: 100%;
63 +    font-size: 90%;
64 +}
65 +
66 +div.related h3 {
67 +    display: none;
68 +}
69 +
70 +div.related ul {
71 +    margin: 0;
72 +    padding: 0 0 0 10px;
73 +    list-style: none;
74 +}
75 +
76 +div.related li {
77 +    display: inline;
78 +}
79 +
80 +div.related li.right {
81 +    float: right;
82 +    margin-right: 5px;
83 +}
84 +
85 +/* -- sidebar --------------------------------------------------------------- */
86 +
87 +div.sphinxsidebarwrapper {
88 +    padding: 10px 5px 0 10px;
89 +}
90 +
91 +div.sphinxsidebar {
92 +    float: left;
93 +    width: 230px;
94 +    margin-left: -100%;
95 +    font-size: 90%;
96 +}
97 +
98 +div.sphinxsidebar ul {
99 +    list-style: none;
100 +}
101 +
102 +div.sphinxsidebar ul ul,
103 +div.sphinxsidebar ul.want-points {
104 +    margin-left: 20px;
105 +    list-style: square;
106 +}
107 +
108 +div.sphinxsidebar ul ul {
109 +    margin-top: 0;
110 +    margin-bottom: 0;
111 +}
112 +
113 +div.sphinxsidebar form {
114 +    margin-top: 10px;
115 +}
116 +
117 +div.sphinxsidebar input {
118 +    border: 1px solid #98dbcc;
119 +    font-family: sans-serif;
120 +    font-size: 1em;
121 +}
122 +
123 +img {
124 +    border: 0;
125 +}
126 +
127 +/* -- search page ----------------------------------------------------------- */
128 +
129 +ul.search {
130 +    margin: 10px 0 0 20px;
131 +    padding: 0;
132 +}
133 +
134 +ul.search li {
135 +    padding: 5px 0 5px 20px;
136 +    background-image: url(file.png);
137 +    background-repeat: no-repeat;
138 +    background-position: 0 7px;
139 +}
140 +
141 +ul.search li a {
142 +    font-weight: bold;
143 +}
144 +
145 +ul.search li div.context {
146 +    color: #888;
147 +    margin: 2px 0 0 30px;
148 +    text-align: left;
149 +}
150 +
151 +ul.keywordmatches li.goodmatch a {
152 +    font-weight: bold;
153 +}
154 +
155 +/* -- index page ------------------------------------------------------------ */
156 +
157 +table.contentstable {
158 +    width: 90%;
159 +}
160 +
161 +table.contentstable p.biglink {
162 +    line-height: 150%;
163 +}
164 +
165 +a.biglink {
166 +    font-size: 1.3em;
167 +}
168 +
169 +span.linkdescr {
170 +    font-style: italic;
171 +    padding-top: 5px;
172 +    font-size: 90%;
173 +}
174 +
175 +/* -- general index --------------------------------------------------------- */
176 +
177 +table.indextable td {
178 +    text-align: left;
179 +    vertical-align: top;
180 +}
181 +
182 +table.indextable dl, table.indextable dd {
183 +    margin-top: 0;
184 +    margin-bottom: 0;
185 +}
186 +
187 +table.indextable tr.pcap {
188 +    height: 10px;
189 +}
190 +
191 +table.indextable tr.cap {
192 +    margin-top: 10px;
193 +    background-color: #f2f2f2;
194 +}
195 +
196 +img.toggler {
197 +    margin-right: 3px;
198 +    margin-top: 3px;
199 +    cursor: pointer;
200 +}
201 +
202 +/* -- general body styles --------------------------------------------------- */
203 +
204 +a.headerlink {
205 +    visibility: hidden;
206 +}
207 +
208 +h1:hover > a.headerlink,
209 +h2:hover > a.headerlink,
210 +h3:hover > a.headerlink,
211 +h4:hover > a.headerlink,
212 +h5:hover > a.headerlink,
213 +h6:hover > a.headerlink,
214 +dt:hover > a.headerlink {
215 +    visibility: visible;
216 +}
217 +
218 +div.body p.caption {
219 +    text-align: inherit;
220 +}
221 +
222 +div.body td {
223 +    text-align: left;
224 +}
225 +
226 +.field-list ul {
227 +    padding-left: 1em;
228 +}
229 +
230 +.first {
231 +}
232 +
233 +p.rubric {
234 +    margin-top: 30px;
235 +    font-weight: bold;
236 +}
237 +
238 +/* -- sidebars -------------------------------------------------------------- */
239 +
240 +div.sidebar {
241 +    margin: 0 0 0.5em 1em;
242 +    border: 1px solid #ddb;
243 +    padding: 7px 7px 0 7px;
244 +    background-color: #ffe;
245 +    width: 40%;
246 +    float: right;
247 +}
248 +
249 +p.sidebar-title {
250 +    font-weight: bold;
251 +}
252 +
253 +/* -- topics ---------------------------------------------------------------- */
254 +
255 +div.topic {
256 +    border: 1px solid #ccc;
257 +    padding: 7px 7px 0 7px;
258 +    margin: 10px 0 10px 0;
259 +}
260 +
261 +p.topic-title {
262 +    font-size: 1.1em;
263 +    font-weight: bold;
264 +    margin-top: 10px;
265 +}
266 +
267 +/* -- admonitions ----------------------------------------------------------- */
268 +
269 +div.admonition {
270 +    margin-top: 10px;
271 +    margin-bottom: 10px;
272 +    padding: 7px;
273 +}
274 +
275 +div.admonition dt {
276 +    font-weight: bold;
277 +}
278 +
279 +div.admonition dl {
280 +    margin-bottom: 0;
281 +}
282 +
283 +p.admonition-title {
284 +    margin: 0px 10px 5px 0px;
285 +    font-weight: bold;
286 +}
287 +
288 +div.body p.centered {
289 +    text-align: center;
290 +    margin-top: 25px;
291 +}
292 +
293 +/* -- tables ---------------------------------------------------------------- */
294 +
295 +table.docutils {
296 +    border: 0;
297 +    border-collapse: collapse;
298 +}
299 +
300 +table.docutils td, table.docutils th {
301 +    padding: 1px 8px 1px 0;
302 +    border-top: 0;
303 +    border-left: 0;
304 +    border-right: 0;
305 +    border-bottom: 1px solid #aaa;
306 +}
307 +
308 +table.field-list td, table.field-list th {
309 +    border: 0 !important;
310 +}
311 +
312 +table.footnote td, table.footnote th {
313 +    border: 0 !important;
314 +}
315 +
316 +th {
317 +    text-align: left;
318 +    padding-right: 5px;
319 +}
320 +
321 +/* -- other body styles ----------------------------------------------------- */
322 +
323 +dl {
324 +    margin-bottom: 15px;
325 +}
326 +
327 +dd p {
328 +    margin-top: 0px;
329 +}
330 +
331 +dd ul, dd table {
332 +    margin-bottom: 10px;
333 +}
334 +
335 +dd {
336 +    margin-top: 3px;
337 +    margin-bottom: 10px;
338 +    margin-left: 30px;
339 +}
340 +
341 +dt:target, .highlight {
342 +    background-color: #fbe54e;
343 +}
344 +
345 +dl.glossary dt {
346 +    font-weight: bold;
347 +    font-size: 1.1em;
348 +}
349 +
350 +.field-list ul {
351 +    margin: 0;
352 +    padding-left: 1em;
353 +}
354 +
355 +.field-list p {
356 +    margin: 0;
357 +}
358 +
359 +.refcount {
360 +    color: #060;
361 +}
362 +
363 +.optional {
364 +    font-size: 1.3em;
365 +}
366 +
367 +.versionmodified {
368 +    font-style: italic;
369 +}
370 +
371 +.system-message {
372 +    background-color: #fda;
373 +    padding: 5px;
374 +    border: 3px solid red;
375 +}
376 +
377 +.footnote:target  {
378 +    background-color: #ffa
379 +}
380 +
381 +.line-block {
382 +    display: block;
383 +    margin-top: 1em;
384 +    margin-bottom: 1em;
385 +}
386 +
387 +.line-block .line-block {
388 +    margin-top: 0;
389 +    margin-bottom: 0;
390 +    margin-left: 1.5em;
391 +}
392 +
393 +/* -- code displays --------------------------------------------------------- */
394 +
395 +pre {
396 +    overflow: auto;
397 +}
398 +
399 +td.linenos pre {
400 +    padding: 5px 0px;
401 +    border: 0;
402 +    background-color: transparent;
403 +    color: #aaa;
404 +}
405 +
406 +table.highlighttable {
407 +    margin-left: 0.5em;
408 +}
409 +
410 +table.highlighttable td {
411 +    padding: 0 0.5em 0 0.5em;
412 +}
413 +
414 +tt.descname {
415 +    background-color: transparent;
416 +    font-weight: bold;
417 +    font-size: 1.2em;
418 +}
419 +
420 +tt.descclassname {
421 +    background-color: transparent;
422 +}
423 +
424 +tt.xref, a tt {
425 +    background-color: transparent;
426 +    font-weight: bold;
427 +}
428 +
429 +h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
430 +    background-color: transparent;
431 +}
432 +
433 +/* -- math display ---------------------------------------------------------- */
434 +
435 +img.math {
436 +    vertical-align: middle;
437 +}
438 +
439 +div.body div.math p {
440 +    text-align: center;
441 +}
442 +
443 +span.eqno {
444 +    float: right;
445 +}
446 +
447 +/* -- printout stylesheet --------------------------------------------------- */
448 +
449 +@media print {
450 +    div.document,
451 +    div.documentwrapper,
452 +    div.bodywrapper {
453 +        margin: 0 !important;
454 +        width: 100%;
455 +    }
456 +
457 +    div.sphinxsidebar,
458 +    div.related,
459 +    div.footer,
460 +    #top-link {
461 +        display: none;
462 +    }
463 +}
464 diff --git a/doc/source/_static/default.css b/doc/source/_static/default.css
465 new file mode 100644
466 index 0000000..c8091ec
467 --- /dev/null
468 +++ b/doc/source/_static/default.css
469 @@ -0,0 +1,230 @@
470 +/**
471 + * Sphinx stylesheet -- default theme
472 + * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473 + */
474 +
475 +@import url("basic.css");
476 +
477 +/* -- page layout ----------------------------------------------------------- */
478 +
479 +body {
480 +    font-family: sans-serif;
481 +    font-size: 100%;
482 +    background-color: #11303d;
483 +    color: #000;
484 +    margin: 0;
485 +    padding: 0;
486 +}
487 +
488 +div.document {
489 +    background-color: #1c4e63;
490 +}
491 +
492 +div.documentwrapper {
493 +    float: left;
494 +    width: 100%;
495 +}
496 +
497 +div.bodywrapper {
498 +    margin: 0 0 0 230px;
499 +}
500 +
501 +div.body {
502 +    background-color: #ffffff;
503 +    color: #000000;
504 +    padding: 0 20px 30px 20px;
505 +}
506 +
507 +div.footer {
508 +    color: #ffffff;
509 +    width: 100%;
510 +    padding: 9px 0 9px 0;
511 +    text-align: center;
512 +    font-size: 75%;
513 +}
514 +
515 +div.footer a {
516 +    color: #ffffff;
517 +    text-decoration: underline;
518 +}
519 +
520 +div.related {
521 +    background-color: #133f52;
522 +    line-height: 30px;
523 +    color: #ffffff;
524 +}
525 +
526 +div.related a {
527 +    color: #ffffff;
528 +}
529 +
530 +div.sphinxsidebar {
531 +}
532 +
533 +div.sphinxsidebar h3 {
534 +    font-family: 'Trebuchet MS', sans-serif;
535 +    color: #ffffff;
536 +    font-size: 1.4em;
537 +    font-weight: normal;
538 +    margin: 0;
539 +    padding: 0;
540 +}
541 +
542 +div.sphinxsidebar h3 a {
543 +    color: #ffffff;
544 +}
545 +
546 +div.sphinxsidebar h4 {
547 +    font-family: 'Trebuchet MS', sans-serif;
548 +    color: #ffffff;
549 +    font-size: 1.3em;
550 +    font-weight: normal;
551 +    margin: 5px 0 0 0;
552 +    padding: 0;
553 +}
554 +
555 +div.sphinxsidebar p {
556 +    color: #ffffff;
557 +}
558 +
559 +div.sphinxsidebar p.topless {
560 +    margin: 5px 10px 10px 10px;
561 +}
562 +
563 +div.sphinxsidebar ul {
564 +    margin: 10px;
565 +    padding: 0;
566 +    color: #ffffff;
567 +}
568 +
569 +div.sphinxsidebar a {
570 +    color: #98dbcc;
571 +}
572 +
573 +div.sphinxsidebar input {
574 +    border: 1px solid #98dbcc;
575 +    font-family: sans-serif;
576 +    font-size: 1em;
577 +}
578 +
579 +/* -- body styles ----------------------------------------------------------- */
580 +
581 +a {
582 +    color: #355f7c;
583 +    text-decoration: none;
584 +}
585 +
586 +a:hover {
587 +    text-decoration: underline;
588 +}
589 +
590 +div.body p, div.body dd, div.body li {
591 +    text-align: left;
592 +    line-height: 130%;
593 +}
594 +
595 +div.body h1,
596 +div.body h2,
597 +div.body h3,
598 +div.body h4,
599 +div.body h5,
600 +div.body h6 {
601 +    font-family: 'Trebuchet MS', sans-serif;
602 +    background-color: #f2f2f2;
603 +    font-weight: normal;
604 +    color: #20435c;
605 +    border-bottom: 1px solid #ccc;
606 +    margin: 20px -20px 10px -20px;
607 +    padding: 3px 0 3px 10px;
608 +}
609 +
610 +div.body h1 { margin-top: 0; font-size: 200%; }
611 +div.body h2 { font-size: 160%; }
612 +div.body h3 { font-size: 140%; }
613 +div.body h4 { font-size: 120%; }
614 +div.body h5 { font-size: 110%; }
615 +div.body h6 { font-size: 100%; }
616 +
617 +a.headerlink {
618 +    color: #c60f0f;
619 +    font-size: 0.8em;
620 +    padding: 0 4px 0 4px;
621 +    text-decoration: none;
622 +}
623 +
624 +a.headerlink:hover {
625 +    background-color: #c60f0f;
626 +    color: white;
627 +}
628 +
629 +div.body p, div.body dd, div.body li {
630 +    text-align: left;
631 +    line-height: 130%;
632 +}
633 +
634 +div.admonition p.admonition-title + p {
635 +    display: inline;
636 +}
637 +
638 +div.admonition p {
639 +    margin-bottom: 5px;
640 +}
641 +
642 +div.admonition pre {
643 +    margin-bottom: 5px;
644 +}
645 +
646 +div.admonition ul, div.admonition ol {
647 +    margin-bottom: 5px;
648 +}
649 +
650 +div.note {
651 +    background-color: #eee;
652 +    border: 1px solid #ccc;
653 +}
654 +
655 +div.seealso {
656 +    background-color: #ffc;
657 +    border: 1px solid #ff6;
658 +}
659 +
660 +div.topic {
661 +    background-color: #eee;
662 +}
663 +
664 +div.warning {
665 +    background-color: #ffe4e4;
666 +    border: 1px solid #f66;
667 +}
668 +
669 +p.admonition-title {
670 +    display: inline;
671 +}
672 +
673 +p.admonition-title:after {
674 +    content: ":";
675 +}
676 +
677 +pre {
678 +    padding: 5px;
679 +    background-color: #eeffcc;
680 +    color: #333333;
681 +    line-height: 120%;
682 +    border: 1px solid #ac9;
683 +    border-left: none;
684 +    border-right: none;
685 +}
686 +
687 +tt {
688 +    background-color: #ecf0f3;
689 +    padding: 0 1px 0 1px;
690 +    font-size: 0.95em;
691 +}
692 +
693 +.warning tt {
694 +    background: #efc2c2;
695 +}
696 +
697 +.note tt {
698 +    background: #d6d6d6;
699 +}
700 diff --git a/doc/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js
701 new file mode 100644
702 index 0000000..79bf0bd
703 --- /dev/null
704 +++ b/doc/source/_static/jquery.tweet.js
705 @@ -0,0 +1,154 @@
706 +(function($) {
707 +
708 +  $.fn.tweet = function(o){
709 +    var s = {
710 +      username: ["seaofclouds"],              // [string]   required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"]
711 +      list: null,                              //[string]   optional name of list belonging to username
712 +      avatar_size: null,                      // [integer]  height and width of avatar if displayed (48px max)
713 +      count: 3,                               // [integer]  how many tweets to display?
714 +      intro_text: null,                       // [string]   do you want text BEFORE your your tweets?
715 +      outro_text: null,                       // [string]   do you want text AFTER your tweets?
716 +      join_text:  null,                       // [string]   optional text in between date and tweet, try setting to "auto"
717 +      auto_join_text_default: "i said,",      // [string]   auto text for non verb: "i said" bullocks
718 +      auto_join_text_ed: "i",                 // [string]   auto text for past tense: "i" surfed
719 +      auto_join_text_ing: "i am",             // [string]   auto tense for present tense: "i was" surfing
720 +      auto_join_text_reply: "i replied to",   // [string]   auto tense for replies: "i replied to" @someone "with"
721 +      auto_join_text_url: "i was looking at", // [string]   auto tense for urls: "i was looking at" http:...
722 +      loading_text: null,                     // [string]   optional loading text, displayed while tweets load
723 +      query: null                             // [string]   optional search query
724 +    };
725 +
726 +    if(o) $.extend(s, o);
727 +
728 +    $.fn.extend({
729 +      linkUrl: function() {
730 +        var returning = [];
731 +        var regexp = /((ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?)/gi;
732 +        this.each(function() {
733 +          returning.push(this.replace(regexp,"<a href=\"$1\">$1</a>"));
734 +        });
735 +        return $(returning);
736 +      },
737 +      linkUser: function() {
738 +        var returning = [];
739 +        var regexp = /[\@]+([A-Za-z0-9-_]+)/gi;
740 +        this.each(function() {
741 +          returning.push(this.replace(regexp,"<a href=\"http://twitter.com/$1\">@$1</a>"));
742 +        });
743 +        return $(returning);
744 +      },
745 +      linkHash: function() {
746 +        var returning = [];
747 +        var regexp = / [\#]+([A-Za-z0-9-_]+)/gi;
748 +        this.each(function() {
749 +          returning.push(this.replace(regexp, ' <a href="http://search.twitter.com/search?q=&tag=$1&lang=all&from='+s.username.join("%2BOR%2B")+'">#$1</a>'));
750 +        });
751 +        return $(returning);
752 +      },
753 +      capAwesome: function() {
754 +        var returning = [];
755 +        this.each(function() {
756 +          returning.push(this.replace(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'));
757 +        });
758 +        return $(returning);
759 +      },
760 +      capEpic: function() {
761 +        var returning = [];
762 +        this.each(function() {
763 +          returning.push(this.replace(/\b(epic)\b/gi, '<span class="epic">$1</span>'));
764 +        });
765 +        return $(returning);
766 +      },
767 +      makeHeart: function() {
768 +        var returning = [];
769 +        this.each(function() {
770 +          returning.push(this.replace(/(&lt;)+[3]/gi, "<tt class='heart'>&#x2665;</tt>"));
771 +        });
772 +        return $(returning);
773 +      }
774 +    });
775 +
776 +    function relative_time(time_value) {
777 +      var parsed_date = Date.parse(time_value);
778 +      var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
779 +      var delta = parseInt((relative_to.getTime() - parsed_date) / 1000);
780 +      var pluralize = function (singular, n) {
781 +        return '' + n + ' ' + singular + (n == 1 ? '' : 's');
782 +      };
783 +      if(delta < 60) {
784 +      return 'less than a minute ago';
785 +      } else if(delta < (45*60)) {
786 +      return 'about ' + pluralize("minute", parseInt(delta / 60)) + ' ago';
787 +      } else if(delta < (24*60*60)) {
788 +      return 'about ' + pluralize("hour", parseInt(delta / 3600)) + ' ago';
789 +      } else {
790 +      return 'about ' + pluralize("day", parseInt(delta / 86400)) + ' ago';
791 +      }
792 +    }
793 +
794 +    function build_url() {
795 +      var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
796 +      if (s.list) {
797 +        return proto+"//api.twitter.com/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?per_page="+s.count+"&callback=?";
798 +      } else if (s.query == null && s.username.length == 1) {
799 +        return proto+'//twitter.com/status/user_timeline/'+s.username[0]+'.json?count='+s.count+'&callback=?';
800 +      } else {
801 +        var query = (s.query || 'from:'+s.username.join('%20OR%20from:'));
802 +        return proto+'//search.twitter.com/search.json?&q='+query+'&rpp='+s.count+'&callback=?';
803 +      }
804 +    }
805 +
806 +    return this.each(function(){
807 +      var list = $('<ul class="tweet_list">').appendTo(this);
808 +      var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
809 +      var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
810 +      var loading = $('<p class="loading">'+s.loading_text+'</p>');
811 +
812 +      if(typeof(s.username) == "string"){
813 +        s.username = [s.username];
814 +      }
815 +
816 +      if (s.loading_text) $(this).append(loading);
817 +      $.getJSON(build_url(), function(data){
818 +        if (s.loading_text) loading.remove();
819 +        if (s.intro_text) list.before(intro);
820 +        $.each((data.results || data), function(i,item){
821 +          // auto join text based on verb tense and content
822 +          if (s.join_text == "auto") {
823 +            if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
824 +              var join_text = s.auto_join_text_reply;
825 +            } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) {
826 +              var join_text = s.auto_join_text_url;
827 +            } else if (item.text.match(/^((\w+ed)|just) .*/im)) {
828 +              var join_text = s.auto_join_text_ed;
829 +            } else if (item.text.match(/^(\w*ing) .*/i)) {
830 +              var join_text = s.auto_join_text_ing;
831 +            } else {
832 +              var join_text = s.auto_join_text_default;
833 +            }
834 +          } else {
835 +            var join_text = s.join_text;
836 +          };
837 +
838 +          var from_user = item.from_user || item.user.screen_name;
839 +          var profile_image_url = item.profile_image_url || item.user.profile_image_url;
840 +          var join_template = '<span class="tweet_join"> '+join_text+' </span>';
841 +          var join = ((s.join_text) ? join_template : ' ');
842 +          var avatar_template = '<a class="tweet_avatar" href="http://twitter.com/'+from_user+'"><img src="'+profile_image_url+'" height="'+s.avatar_size+'" width="'+s.avatar_size+'" alt="'+from_user+'\'s avatar" title="'+from_user+'\'s avatar" border="0"/></a>';
843 +          var avatar = (s.avatar_size ? avatar_template : '');
844 +          var date = '<a href="http://twitter.com/'+from_user+'/statuses/'+item.id+'" title="view tweet on twitter">'+relative_time(item.created_at)+'</a>';
845 +          var text = '<span class="tweet_text">' +$([item.text]).linkUrl().linkUser().linkHash().makeHeart().capAwesome().capEpic()[0]+ '</span>';
846 +
847 +          // until we create a template option, arrange the items below to alter a tweet's display.
848 +          list.append('<li>' + avatar + date + join + text + '</li>');
849 +
850 +          list.children('li:first').addClass('tweet_first');
851 +          list.children('li:odd').addClass('tweet_even');
852 +          list.children('li:even').addClass('tweet_odd');
853 +        });
854 +        if (s.outro_text) list.after(outro);
855 +      });
856 +
857 +    });
858 +  };
859 +})(jQuery);
860 \ No newline at end of file
861 diff --git a/doc/source/_static/tweaks.css b/doc/source/_static/tweaks.css
862 new file mode 100644
863 index 0000000..046ead8
864 --- /dev/null
865 +++ b/doc/source/_static/tweaks.css
866 @@ -0,0 +1,218 @@
867 +ul.todo_list {
868 +    list-style-type: none;
869 +    margin: 0;
870 +    padding: 0;
871 +}
872 +
873 +ul.todo_list li {
874 +    display: block;
875 +    margin: 0;
876 +    padding: 7px 0;
877 +    border-top: 1px solid #eee;
878 +}
879 +
880 +ul.todo_list li p {
881 +    display: inline;
882 +}
883 +
884 +ul.todo_list li p.link {
885 +    font-weight: bold;
886 +}
887 +
888 +ul.todo_list li p.details {
889 +    font-style: italic;
890 +}
891 +
892 +ul.todo_list li {
893 +}
894 +
895 +div.admonition {
896 +    border: 1px solid #8F1000;
897 +}
898 +
899 +div.admonition p.admonition-title {
900 +    background-color: #8F1000;
901 +    border-bottom: 1px solid #8E8E8E;
902 +}
903 +
904 +a {
905 +       color: #CF2F19;
906 +}
907 +
908 +div.related ul li a {
909 +       color: #CF2F19;
910 +}
911 +
912 +div.sphinxsidebar h4 {
913 +       background-color:#8E8E8E;
914 +       border:1px solid #255E6E;
915 +       color:white;
916 +       font-size:1em;
917 +       margin:1em 0 0.5em;
918 +       padding:0.1em 0 0.1em 0.5em;
919 +}
920 +
921 +em {
922 +    font-style: normal;
923 +}
924 +
925 +table.docutils {
926 +       font-size: 11px;
927 +}
928 +
929 +.tweet_list li {
930 +    font-size: 0.9em;
931 +    border-bottom: 1px solid #eee;
932 +    padding: 5px 0;
933 +}
934 +
935 +.tweet_list li .tweet_avatar {
936 +    float: left;
937 +}
938 +
939 +/* ------------------------------------------
940 +PURE CSS SPEECH BUBBLES
941 +by Nicolas Gallagher
942 +- http://nicolasgallagher.com/pure-css-speech-bubbles/
943 +
944 +http://nicolasgallagher.com
945 +http://twitter.com/necolas
946 +
947 +Created: 02 March 2010
948 +Version: 1.1 (21 October 2010)
949 +
950 +Dual licensed under MIT and GNU GPLv2 Â© Nicolas Gallagher
951 +------------------------------------------ */
952 +/* THE SPEECH BUBBLE
953 +------------------------------------------------------------------------------------------------------------------------------- */
954 +
955 +/* THE SPEECH BUBBLE
956 +------------------------------------------------------------------------------------------------------------------------------- */
957 +
958 +.triangle-border {
959 +       position:relative;
960 +       padding:15px;
961 +       margin:1em 0 3em;
962 +       border:5px solid #BC1518;
963 +       color:#333;
964 +       background:#fff;
965 +
966 +       /* css3 */
967 +       -moz-border-radius:10px;
968 +       -webkit-border-radius:10px;
969 +       border-radius:10px;
970 +}
971 +
972 +/* Variant : for left positioned triangle
973 +------------------------------------------ */
974 +
975 +.triangle-border.left {
976 +       margin-left:30px;
977 +}
978 +
979 +/* Variant : for right positioned triangle
980 +------------------------------------------ */
981 +
982 +.triangle-border.right {
983 +       margin-right:30px;
984 +}
985 +
986 +/* THE TRIANGLE
987 +------------------------------------------------------------------------------------------------------------------------------- */
988 +
989 +.triangle-border:before {
990 +       content:"";
991 +       display:block; /* reduce the damage in FF3.0 */
992 +       position:absolute;
993 +       bottom:-40px; /* value = - border-top-width - border-bottom-width */
994 +       left:40px; /* controls horizontal position */
995 +       width:0;
996 +       height:0;
997 +       border:20px solid transparent;
998 +       border-top-color:#BC1518;
999 +}
1000 +
1001 +/* creates the smaller  triangle */
1002 +.triangle-border:after {
1003 +       content:"";
1004 +       display:block; /* reduce the damage in FF3.0 */
1005 +       position:absolute;
1006 +       bottom:-26px; /* value = - border-top-width - border-bottom-width */
1007 +       left:47px; /* value = (:before left) + (:before border-left) - (:after border-left) */
1008 +       width:0;
1009 +       height:0;
1010 +       border:13px solid transparent;
1011 +       border-top-color:#fff;
1012 +}
1013 +
1014 +/* Variant : top
1015 +------------------------------------------ */
1016 +
1017 +/* creates the larger triangle */
1018 +.triangle-border.top:before {
1019 +       top:-40px; /* value = - border-top-width - border-bottom-width */
1020 +       right:40px; /* controls horizontal position */
1021 +       bottom:auto;
1022 +       left:auto;
1023 +       border:20px solid transparent;
1024 +       border-bottom-color:#BC1518;
1025 +}
1026 +
1027 +/* creates the smaller  triangle */
1028 +.triangle-border.top:after {
1029 +       top:-26px; /* value = - border-top-width - border-bottom-width */
1030 +       right:47px; /* value = (:before right) + (:before border-right) - (:after border-right) */
1031 +       bottom:auto;
1032 +       left:auto;
1033 +       border:13px solid transparent;
1034 +       border-bottom-color:#fff;
1035 +}
1036 +
1037 +/* Variant : left
1038 +------------------------------------------ */
1039 +
1040 +/* creates the larger triangle */
1041 +.triangle-border.left:before {
1042 +       top:10px; /* controls vertical position */
1043 +       left:-30px; /* value = - border-left-width - border-right-width */
1044 +       bottom:auto;
1045 +       border-width:15px 30px 15px 0;
1046 +       border-style:solid;
1047 +       border-color:transparent #BC1518;
1048 +}
1049 +
1050 +/* creates the smaller  triangle */
1051 +.triangle-border.left:after {
1052 +       top:16px; /* value = (:before top) + (:before border-top) - (:after border-top) */
1053 +       left:-21px; /* value = - border-left-width - border-right-width */
1054 +       bottom:auto;
1055 +       border-width:9px 21px 9px 0;
1056 +       border-style:solid;
1057 +       border-color:transparent #fff;
1058 +}
1059 +
1060 +/* Variant : right
1061 +------------------------------------------ */
1062 +
1063 +/* creates the larger triangle */
1064 +.triangle-border.right:before {
1065 +       top:10px; /* controls vertical position */
1066 +       right:-30px; /* value = - border-left-width - border-right-width */
1067 +       bottom:auto;
1068 +    left:auto;
1069 +       border-width:15px 0 15px 30px;
1070 +       border-style:solid;
1071 +       border-color:transparent #BC1518;
1072 +}
1073 +
1074 +/* creates the smaller  triangle */
1075 +.triangle-border.right:after {
1076 +       top:16px; /* value = (:before top) + (:before border-top) - (:after border-top) */
1077 +       right:-21px; /* value = - border-left-width - border-right-width */
1078 +       bottom:auto;
1079 +    left:auto;
1080 +       border-width:9px 0 9px 21px;
1081 +       border-style:solid;
1082 +       border-color:transparent #fff;
1083 +}
1084 +
1085 diff --git a/doc/source/_templates/.gitignore b/doc/source/_templates/.gitignore
1086 new file mode 100644
1087 index 0000000..e69de29
1088 diff --git a/doc/source/_templates/.placeholder b/doc/source/_templates/.placeholder
1089 new file mode 100644
1090 index 0000000..e69de29
1091 diff --git a/doc/source/_theme/layout.html b/doc/source/_theme/layout.html
1092 new file mode 100644
1093 index 0000000..f5b388c
1094 --- /dev/null
1095 +++ b/doc/source/_theme/layout.html
1096 @@ -0,0 +1,95 @@
1097 +{% extends "sphinxdoc/layout.html" %}
1098 +{% set css_files = css_files + ['_static/tweaks.css'] %}
1099 +{% set script_files = script_files + ['_static/jquery.tweet.js'] %}
1100 +{% block extrahead %}
1101 +    <script type='text/javascript'>
1102 +        $(document).ready(function(){
1103 +            $("#twitter_feed").tweet({
1104 +                username: "openstack",
1105 +                query: "from:openstack",
1106 +                avatar_size: 32,
1107 +                count: 10,
1108 +                loading_text: "loading tweets..."
1109 +            });
1110 +        });
1111 +    </script>
1112 +{% endblock %}
1113 +
1114 +{%- macro sidebar() %}
1115 +      {%- if not embedded %}{% if not theme_nosidebar|tobool %}
1116 +      <div class="sphinxsidebar">
1117 +        <div class="sphinxsidebarwrapper">
1118 +          {%- block sidebarlogo %}
1119 +          {%- if logo %}
1120 +            <p class="logo"><a href="{{ pathto(master_doc) }}">
1121 +              <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
1122 +            </a></p>
1123 +          {%- endif %}
1124 +          {%- endblock %}
1125 +          {%- block sidebartoc %}
1126 +          {%- if display_toc %}
1127 +            <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
1128 +            {{ toc }}
1129 +          {%- endif %}
1130 +          {%- endblock %}
1131 +          {%- block sidebarrel %}
1132 +          {%- if prev %}
1133 +            <h4>{{ _('Previous topic') }}</h4>
1134 +            <p class="topless"><a href="{{ prev.link|e }}"
1135 +                                  title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
1136 +          {%- endif %}
1137 +          {%- if next %}
1138 +            <h4>{{ _('Next topic') }}</h4>
1139 +            <p class="topless"><a href="{{ next.link|e }}"
1140 +                                  title="{{ _('next chapter') }}">{{ next.title }}</a></p>
1141 +          {%- endif %}
1142 +          {%- endblock %}
1143 +          {%- block sidebarsourcelink %}
1144 +          {%- if show_source and has_source and sourcename %}
1145 +            <h3>{{ _('This Page') }}</h3>
1146 +            <ul class="this-page-menu">
1147 +              <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
1148 +                     rel="nofollow">{{ _('Show Source') }}</a></li>
1149 +            </ul>
1150 +          {%- endif %}
1151 +          {%- endblock %}
1152 +          {%- if customsidebar %}
1153 +          {% include customsidebar %}
1154 +          {%- endif %}
1155 +          {%- block sidebarsearch %}
1156 +          {%- if pagename != "search" %}
1157 +          <div id="searchbox" style="display: none">
1158 +            <h3>{{ _('Quick search') }}</h3>
1159 +              <form class="search" action="{{ pathto('search') }}" method="get">
1160 +                <input type="text" name="q" size="18" />
1161 +                <input type="submit" value="{{ _('Go') }}" />
1162 +                <input type="hidden" name="check_keywords" value="yes" />
1163 +                <input type="hidden" name="area" value="default" />
1164 +              </form>
1165 +              <p class="searchtip" style="font-size: 90%">
1166 +              {{ _('Enter search terms or a module, class or function name.') }}
1167 +              </p>
1168 +          </div>
1169 +          <script type="text/javascript">$('#searchbox').show(0);</script>
1170 +          
1171 +          <p class="triangle-border right">
1172 +                               Psst... hey. You're reading the latest content, but it's for the Block Storage project only. You can read <a href="http://docs.openstack.org">all OpenStack docs</a> too.
1173 +                       </p>
1174 +          
1175 +          {%- endif %}
1176 +
1177 +          {%- if pagename == "index" %}
1178 +          
1179 +          
1180 +          <h3>{{ _('Twitter Feed') }}</h3>
1181 +                <div id="twitter_feed" class='twitter_feed'></div>
1182 +          {%- endif %}
1183 +          
1184 +          
1185 +
1186 +
1187 +          {%- endblock %}
1188 +        </div>
1189 +      </div>
1190 +      {%- endif %}{% endif %}
1191 +{%- endmacro %}
1192 diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf
1193 new file mode 100644
1194 index 0000000..e039fe0
1195 --- /dev/null
1196 +++ b/doc/source/_theme/theme.conf
1197 @@ -0,0 +1,5 @@
1198 +[theme]
1199 +inherit = sphinxdoc
1200 +stylesheet = sphinxdoc.css
1201 +pygments_style = friendly
1202 +
1203 diff --git a/doc/source/conf.py b/doc/source/conf.py
1204 index 7a2bf1a..01bd3b4 100644
1205 --- a/doc/source/conf.py
1206 +++ b/doc/source/conf.py
1207 @@ -33,9 +33,7 @@ extensions = ['sphinx.ext.autodoc',
1208                'sphinx.ext.coverage',
1209                'sphinx.ext.pngmath',
1210                'sphinx.ext.ifconfig',
1211 -              'sphinx.ext.graphviz',
1212 -              'oslo.sphinx',
1213 -              ]
1214 +              'sphinx.ext.graphviz']
1215  
1216  # autodoc generation is a bit aggressive and a nuisance
1217  # when doing heavy text edit cycles. Execute "export SPHINX_DEBUG=1"
1218 @@ -133,8 +131,8 @@ man_pages = [
1219  
1220  # The theme to use for HTML and HTML Help pages.  Major themes that come with
1221  # Sphinx are currently 'default' and 'sphinxdoc'.
1222 -# html_theme_path = ["."]
1223 -# html_theme = '_theme'
1224 +html_theme_path = ["."]
1225 +html_theme = '_theme'
1226  
1227  # Theme options are theme-specific and customize the look and feel of a theme
1228  # further.  For a list of options available for each theme, see the
1229 diff --git a/test-requirements.txt b/test-requirements.txt
1230 index 3d8e9bf..f83b20b 100644
1231 --- a/test-requirements.txt
1232 +++ b/test-requirements.txt
1233 @@ -12,5 +12,4 @@
1234  sphinx>=1.1.2
1235  python-subunit
1236  testtools>=0.9.32
1237  testrepository>=0.0.17
1238 -oslo.sphinx