summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorricolin <rico.lin@easystack.cn>2017-07-20 13:54:10 +0800
committerricolin <rico.lin@easystack.cn>2017-07-21 12:28:14 +0800
commit341d07e29882476fde8f8f1e075ada3bbae9611a (patch)
tree26b616c3c318c53f12292b152f2698727ae6eac1
parent407f8a5b00e1ee8a92a7e05012a3677fa741103b (diff)
downloadheat-cfntools-341d07e29882476fde8f8f1e075ada3bbae9611a.tar.gz
Add OpenStack doc support for heat cfntools
This allow build docs with new OpenStack doc format. Change-Id: I4ed880ee5c03de40793ebdb4662cbaf3eeca12fa
-rw-r--r--doc/source/_static/basic.css416
-rw-r--r--doc/source/_static/default.css230
-rw-r--r--doc/source/_static/header-line.gifbin48 -> 0 bytes
-rw-r--r--doc/source/_static/header_bg.jpgbin3738 -> 0 bytes
-rw-r--r--doc/source/_static/jquery.tweet.js154
-rw-r--r--doc/source/_static/nature.css245
-rw-r--r--doc/source/_static/openstack_logo.pngbin3670 -> 0 bytes
-rw-r--r--doc/source/_static/tweaks.css94
-rw-r--r--doc/source/_theme/layout.html83
-rw-r--r--doc/source/_theme/theme.conf4
-rw-r--r--doc/source/cfn-create-aws-symlinks.rst (renamed from doc/source/man/cfn-create-aws-symlinks.rst)0
-rw-r--r--doc/source/cfn-get-metadata.rst (renamed from doc/source/man/cfn-get-metadata.rst)0
-rw-r--r--doc/source/cfn-hup.rst (renamed from doc/source/man/cfn-hup.rst)0
-rw-r--r--doc/source/cfn-init.rst (renamed from doc/source/man/cfn-init.rst)0
-rw-r--r--doc/source/cfn-push-stats.rst (renamed from doc/source/man/cfn-push-stats.rst)0
-rw-r--r--doc/source/cfn-signal.rst (renamed from doc/source/man/cfn-signal.rst)0
-rw-r--r--doc/source/conf.py270
-rw-r--r--doc/source/index.rst (renamed from doc/source/man/index.rst)2
-rw-r--r--setup.cfg8
-rw-r--r--test-requirements.txt2
-rw-r--r--tox.ini6
21 files changed, 115 insertions, 1399 deletions
diff --git a/doc/source/_static/basic.css b/doc/source/_static/basic.css
deleted file mode 100644
index d909ce3..0000000
--- a/doc/source/_static/basic.css
+++ /dev/null
@@ -1,416 +0,0 @@
-/**
- * Sphinx stylesheet -- basic theme
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- */
-
-/* -- main layout ----------------------------------------------------------- */
-
-div.clearer {
- clear: both;
-}
-
-/* -- relbar ---------------------------------------------------------------- */
-
-div.related {
- width: 100%;
- font-size: 90%;
-}
-
-div.related h3 {
- display: none;
-}
-
-div.related ul {
- margin: 0;
- padding: 0 0 0 10px;
- list-style: none;
-}
-
-div.related li {
- display: inline;
-}
-
-div.related li.right {
- float: right;
- margin-right: 5px;
-}
-
-/* -- sidebar --------------------------------------------------------------- */
-
-div.sphinxsidebarwrapper {
- padding: 10px 5px 0 10px;
-}
-
-div.sphinxsidebar {
- float: left;
- width: 230px;
- margin-left: -100%;
- font-size: 90%;
-}
-
-div.sphinxsidebar ul {
- list-style: none;
-}
-
-div.sphinxsidebar ul ul,
-div.sphinxsidebar ul.want-points {
- margin-left: 20px;
- list-style: square;
-}
-
-div.sphinxsidebar ul ul {
- margin-top: 0;
- margin-bottom: 0;
-}
-
-div.sphinxsidebar form {
- margin-top: 10px;
-}
-
-div.sphinxsidebar input {
- border: 1px solid #98dbcc;
- font-family: sans-serif;
- font-size: 1em;
-}
-
-img {
- border: 0;
-}
-
-/* -- search page ----------------------------------------------------------- */
-
-ul.search {
- margin: 10px 0 0 20px;
- padding: 0;
-}
-
-ul.search li {
- padding: 5px 0 5px 20px;
- background-image: url(file.png);
- background-repeat: no-repeat;
- background-position: 0 7px;
-}
-
-ul.search li a {
- font-weight: bold;
-}
-
-ul.search li div.context {
- color: #888;
- margin: 2px 0 0 30px;
- text-align: left;
-}
-
-ul.keywordmatches li.goodmatch a {
- font-weight: bold;
-}
-
-/* -- index page ------------------------------------------------------------ */
-
-table.contentstable {
- width: 90%;
-}
-
-table.contentstable p.biglink {
- line-height: 150%;
-}
-
-a.biglink {
- font-size: 1.3em;
-}
-
-span.linkdescr {
- font-style: italic;
- padding-top: 5px;
- font-size: 90%;
-}
-
-/* -- general index --------------------------------------------------------- */
-
-table.indextable td {
- text-align: left;
- vertical-align: top;
-}
-
-table.indextable dl, table.indextable dd {
- margin-top: 0;
- margin-bottom: 0;
-}
-
-table.indextable tr.pcap {
- height: 10px;
-}
-
-table.indextable tr.cap {
- margin-top: 10px;
- background-color: #f2f2f2;
-}
-
-img.toggler {
- margin-right: 3px;
- margin-top: 3px;
- cursor: pointer;
-}
-
-/* -- general body styles --------------------------------------------------- */
-
-a.headerlink {
- visibility: hidden;
-}
-
-h1:hover > a.headerlink,
-h2:hover > a.headerlink,
-h3:hover > a.headerlink,
-h4:hover > a.headerlink,
-h5:hover > a.headerlink,
-h6:hover > a.headerlink,
-dt:hover > a.headerlink {
- visibility: visible;
-}
-
-div.body p.caption {
- text-align: inherit;
-}
-
-div.body td {
- text-align: left;
-}
-
-.field-list ul {
- padding-left: 1em;
-}
-
-.first {
-}
-
-p.rubric {
- margin-top: 30px;
- font-weight: bold;
-}
-
-/* -- sidebars -------------------------------------------------------------- */
-
-div.sidebar {
- margin: 0 0 0.5em 1em;
- border: 1px solid #ddb;
- padding: 7px 7px 0 7px;
- background-color: #ffe;
- width: 40%;
- float: right;
-}
-
-p.sidebar-title {
- font-weight: bold;
-}
-
-/* -- topics ---------------------------------------------------------------- */
-
-div.topic {
- border: 1px solid #ccc;
- padding: 7px 7px 0 7px;
- margin: 10px 0 10px 0;
-}
-
-p.topic-title {
- font-size: 1.1em;
- font-weight: bold;
- margin-top: 10px;
-}
-
-/* -- admonitions ----------------------------------------------------------- */
-
-div.admonition {
- margin-top: 10px;
- margin-bottom: 10px;
- padding: 7px;
-}
-
-div.admonition dt {
- font-weight: bold;
-}
-
-div.admonition dl {
- margin-bottom: 0;
-}
-
-p.admonition-title {
- margin: 0px 10px 5px 0px;
- font-weight: bold;
-}
-
-div.body p.centered {
- text-align: center;
- margin-top: 25px;
-}
-
-/* -- tables ---------------------------------------------------------------- */
-
-table.docutils {
- border: 0;
- border-collapse: collapse;
-}
-
-table.docutils td, table.docutils th {
- padding: 1px 8px 1px 0;
- border-top: 0;
- border-left: 0;
- border-right: 0;
- border-bottom: 1px solid #aaa;
-}
-
-table.field-list td, table.field-list th {
- border: 0 !important;
-}
-
-table.footnote td, table.footnote th {
- border: 0 !important;
-}
-
-th {
- text-align: left;
- padding-right: 5px;
-}
-
-/* -- other body styles ----------------------------------------------------- */
-
-dl {
- margin-bottom: 15px;
-}
-
-dd p {
- margin-top: 0px;
-}
-
-dd ul, dd table {
- margin-bottom: 10px;
-}
-
-dd {
- margin-top: 3px;
- margin-bottom: 10px;
- margin-left: 30px;
-}
-
-dt:target, .highlight {
- background-color: #fbe54e;
-}
-
-dl.glossary dt {
- font-weight: bold;
- font-size: 1.1em;
-}
-
-.field-list ul {
- margin: 0;
- padding-left: 1em;
-}
-
-.field-list p {
- margin: 0;
-}
-
-.refcount {
- color: #060;
-}
-
-.optional {
- font-size: 1.3em;
-}
-
-.versionmodified {
- font-style: italic;
-}
-
-.system-message {
- background-color: #fda;
- padding: 5px;
- border: 3px solid red;
-}
-
-.footnote:target {
- background-color: #ffa
-}
-
-.line-block {
- display: block;
- margin-top: 1em;
- margin-bottom: 1em;
-}
-
-.line-block .line-block {
- margin-top: 0;
- margin-bottom: 0;
- margin-left: 1.5em;
-}
-
-/* -- code displays --------------------------------------------------------- */
-
-pre {
- overflow: auto;
-}
-
-td.linenos pre {
- padding: 5px 0px;
- border: 0;
- background-color: transparent;
- color: #aaa;
-}
-
-table.highlighttable {
- margin-left: 0.5em;
-}
-
-table.highlighttable td {
- padding: 0 0.5em 0 0.5em;
-}
-
-tt.descname {
- background-color: transparent;
- font-weight: bold;
- font-size: 1.2em;
-}
-
-tt.descclassname {
- background-color: transparent;
-}
-
-tt.xref, a tt {
- background-color: transparent;
- font-weight: bold;
-}
-
-h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt {
- background-color: transparent;
-}
-
-/* -- math display ---------------------------------------------------------- */
-
-img.math {
- vertical-align: middle;
-}
-
-div.body div.math p {
- text-align: center;
-}
-
-span.eqno {
- float: right;
-}
-
-/* -- printout stylesheet --------------------------------------------------- */
-
-@media print {
- div.document,
- div.documentwrapper,
- div.bodywrapper {
- margin: 0 !important;
- width: 100%;
- }
-
- div.sphinxsidebar,
- div.related,
- div.footer,
- #top-link {
- display: none;
- }
-}
diff --git a/doc/source/_static/default.css b/doc/source/_static/default.css
deleted file mode 100644
index c8091ec..0000000
--- a/doc/source/_static/default.css
+++ /dev/null
@@ -1,230 +0,0 @@
-/**
- * Sphinx stylesheet -- default theme
- * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- */
-
-@import url("basic.css");
-
-/* -- page layout ----------------------------------------------------------- */
-
-body {
- font-family: sans-serif;
- font-size: 100%;
- background-color: #11303d;
- color: #000;
- margin: 0;
- padding: 0;
-}
-
-div.document {
- background-color: #1c4e63;
-}
-
-div.documentwrapper {
- float: left;
- width: 100%;
-}
-
-div.bodywrapper {
- margin: 0 0 0 230px;
-}
-
-div.body {
- background-color: #ffffff;
- color: #000000;
- padding: 0 20px 30px 20px;
-}
-
-div.footer {
- color: #ffffff;
- width: 100%;
- padding: 9px 0 9px 0;
- text-align: center;
- font-size: 75%;
-}
-
-div.footer a {
- color: #ffffff;
- text-decoration: underline;
-}
-
-div.related {
- background-color: #133f52;
- line-height: 30px;
- color: #ffffff;
-}
-
-div.related a {
- color: #ffffff;
-}
-
-div.sphinxsidebar {
-}
-
-div.sphinxsidebar h3 {
- font-family: 'Trebuchet MS', sans-serif;
- color: #ffffff;
- font-size: 1.4em;
- font-weight: normal;
- margin: 0;
- padding: 0;
-}
-
-div.sphinxsidebar h3 a {
- color: #ffffff;
-}
-
-div.sphinxsidebar h4 {
- font-family: 'Trebuchet MS', sans-serif;
- color: #ffffff;
- font-size: 1.3em;
- font-weight: normal;
- margin: 5px 0 0 0;
- padding: 0;
-}
-
-div.sphinxsidebar p {
- color: #ffffff;
-}
-
-div.sphinxsidebar p.topless {
- margin: 5px 10px 10px 10px;
-}
-
-div.sphinxsidebar ul {
- margin: 10px;
- padding: 0;
- color: #ffffff;
-}
-
-div.sphinxsidebar a {
- color: #98dbcc;
-}
-
-div.sphinxsidebar input {
- border: 1px solid #98dbcc;
- font-family: sans-serif;
- font-size: 1em;
-}
-
-/* -- body styles ----------------------------------------------------------- */
-
-a {
- color: #355f7c;
- text-decoration: none;
-}
-
-a:hover {
- text-decoration: underline;
-}
-
-div.body p, div.body dd, div.body li {
- text-align: left;
- line-height: 130%;
-}
-
-div.body h1,
-div.body h2,
-div.body h3,
-div.body h4,
-div.body h5,
-div.body h6 {
- font-family: 'Trebuchet MS', sans-serif;
- background-color: #f2f2f2;
- font-weight: normal;
- color: #20435c;
- border-bottom: 1px solid #ccc;
- margin: 20px -20px 10px -20px;
- padding: 3px 0 3px 10px;
-}
-
-div.body h1 { margin-top: 0; font-size: 200%; }
-div.body h2 { font-size: 160%; }
-div.body h3 { font-size: 140%; }
-div.body h4 { font-size: 120%; }
-div.body h5 { font-size: 110%; }
-div.body h6 { font-size: 100%; }
-
-a.headerlink {
- color: #c60f0f;
- font-size: 0.8em;
- padding: 0 4px 0 4px;
- text-decoration: none;
-}
-
-a.headerlink:hover {
- background-color: #c60f0f;
- color: white;
-}
-
-div.body p, div.body dd, div.body li {
- text-align: left;
- line-height: 130%;
-}
-
-div.admonition p.admonition-title + p {
- display: inline;
-}
-
-div.admonition p {
- margin-bottom: 5px;
-}
-
-div.admonition pre {
- margin-bottom: 5px;
-}
-
-div.admonition ul, div.admonition ol {
- margin-bottom: 5px;
-}
-
-div.note {
- background-color: #eee;
- border: 1px solid #ccc;
-}
-
-div.seealso {
- background-color: #ffc;
- border: 1px solid #ff6;
-}
-
-div.topic {
- background-color: #eee;
-}
-
-div.warning {
- background-color: #ffe4e4;
- border: 1px solid #f66;
-}
-
-p.admonition-title {
- display: inline;
-}
-
-p.admonition-title:after {
- content: ":";
-}
-
-pre {
- padding: 5px;
- background-color: #eeffcc;
- color: #333333;
- line-height: 120%;
- border: 1px solid #ac9;
- border-left: none;
- border-right: none;
-}
-
-tt {
- background-color: #ecf0f3;
- padding: 0 1px 0 1px;
- font-size: 0.95em;
-}
-
-.warning tt {
- background: #efc2c2;
-}
-
-.note tt {
- background: #d6d6d6;
-}
diff --git a/doc/source/_static/header-line.gif b/doc/source/_static/header-line.gif
deleted file mode 100644
index 3601730..0000000
--- a/doc/source/_static/header-line.gif
+++ /dev/null
Binary files differ
diff --git a/doc/source/_static/header_bg.jpg b/doc/source/_static/header_bg.jpg
deleted file mode 100644
index f788c41..0000000
--- a/doc/source/_static/header_bg.jpg
+++ /dev/null
Binary files differ
diff --git a/doc/source/_static/jquery.tweet.js b/doc/source/_static/jquery.tweet.js
deleted file mode 100644
index 79bf0bd..0000000
--- a/doc/source/_static/jquery.tweet.js
+++ /dev/null
@@ -1,154 +0,0 @@
-(function($) {
-
- $.fn.tweet = function(o){
- var s = {
- username: ["seaofclouds"], // [string] required, unless you want to display our tweets. :) it can be an array, just do ["username1","username2","etc"]
- list: null, //[string] optional name of list belonging to username
- avatar_size: null, // [integer] height and width of avatar if displayed (48px max)
- count: 3, // [integer] how many tweets to display?
- intro_text: null, // [string] do you want text BEFORE your your tweets?
- outro_text: null, // [string] do you want text AFTER your tweets?
- join_text: null, // [string] optional text in between date and tweet, try setting to "auto"
- auto_join_text_default: "i said,", // [string] auto text for non verb: "i said" bullocks
- auto_join_text_ed: "i", // [string] auto text for past tense: "i" surfed
- auto_join_text_ing: "i am", // [string] auto tense for present tense: "i was" surfing
- auto_join_text_reply: "i replied to", // [string] auto tense for replies: "i replied to" @someone "with"
- auto_join_text_url: "i was looking at", // [string] auto tense for urls: "i was looking at" http:...
- loading_text: null, // [string] optional loading text, displayed while tweets load
- query: null // [string] optional search query
- };
-
- if(o) $.extend(s, o);
-
- $.fn.extend({
- linkUrl: function() {
- var returning = [];
- var regexp = /((ftp|http|https):\/\/(\w+:{0,1}\w*@)?(\S+)(:[0-9]+)?(\/|\/([\w#!:.?+=&%@!\-\/]))?)/gi;
- this.each(function() {
- returning.push(this.replace(regexp,"<a href=\"$1\">$1</a>"));
- });
- return $(returning);
- },
- linkUser: function() {
- var returning = [];
- var regexp = /[\@]+([A-Za-z0-9-_]+)/gi;
- this.each(function() {
- returning.push(this.replace(regexp,"<a href=\"http://twitter.com/$1\">@$1</a>"));
- });
- return $(returning);
- },
- linkHash: function() {
- var returning = [];
- var regexp = / [\#]+([A-Za-z0-9-_]+)/gi;
- this.each(function() {
- 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>'));
- });
- return $(returning);
- },
- capAwesome: function() {
- var returning = [];
- this.each(function() {
- returning.push(this.replace(/\b(awesome)\b/gi, '<span class="awesome">$1</span>'));
- });
- return $(returning);
- },
- capEpic: function() {
- var returning = [];
- this.each(function() {
- returning.push(this.replace(/\b(epic)\b/gi, '<span class="epic">$1</span>'));
- });
- return $(returning);
- },
- makeHeart: function() {
- var returning = [];
- this.each(function() {
- returning.push(this.replace(/(&lt;)+[3]/gi, "<tt class='heart'>&#x2665;</tt>"));
- });
- return $(returning);
- }
- });
-
- function relative_time(time_value) {
- var parsed_date = Date.parse(time_value);
- var relative_to = (arguments.length > 1) ? arguments[1] : new Date();
- var delta = parseInt((relative_to.getTime() - parsed_date) / 1000);
- var pluralize = function (singular, n) {
- return '' + n + ' ' + singular + (n == 1 ? '' : 's');
- };
- if(delta < 60) {
- return 'less than a minute ago';
- } else if(delta < (45*60)) {
- return 'about ' + pluralize("minute", parseInt(delta / 60)) + ' ago';
- } else if(delta < (24*60*60)) {
- return 'about ' + pluralize("hour", parseInt(delta / 3600)) + ' ago';
- } else {
- return 'about ' + pluralize("day", parseInt(delta / 86400)) + ' ago';
- }
- }
-
- function build_url() {
- var proto = ('https:' == document.location.protocol ? 'https:' : 'http:');
- if (s.list) {
- return proto+"//api.twitter.com/1/"+s.username[0]+"/lists/"+s.list+"/statuses.json?per_page="+s.count+"&callback=?";
- } else if (s.query == null && s.username.length == 1) {
- return proto+'//twitter.com/status/user_timeline/'+s.username[0]+'.json?count='+s.count+'&callback=?';
- } else {
- var query = (s.query || 'from:'+s.username.join('%20OR%20from:'));
- return proto+'//search.twitter.com/search.json?&q='+query+'&rpp='+s.count+'&callback=?';
- }
- }
-
- return this.each(function(){
- var list = $('<ul class="tweet_list">').appendTo(this);
- var intro = '<p class="tweet_intro">'+s.intro_text+'</p>';
- var outro = '<p class="tweet_outro">'+s.outro_text+'</p>';
- var loading = $('<p class="loading">'+s.loading_text+'</p>');
-
- if(typeof(s.username) == "string"){
- s.username = [s.username];
- }
-
- if (s.loading_text) $(this).append(loading);
- $.getJSON(build_url(), function(data){
- if (s.loading_text) loading.remove();
- if (s.intro_text) list.before(intro);
- $.each((data.results || data), function(i,item){
- // auto join text based on verb tense and content
- if (s.join_text == "auto") {
- if (item.text.match(/^(@([A-Za-z0-9-_]+)) .*/i)) {
- var join_text = s.auto_join_text_reply;
- } else if (item.text.match(/(^\w+:\/\/[A-Za-z0-9-_]+\.[A-Za-z0-9-_:%&\?\/.=]+) .*/i)) {
- var join_text = s.auto_join_text_url;
- } else if (item.text.match(/^((\w+ed)|just) .*/im)) {
- var join_text = s.auto_join_text_ed;
- } else if (item.text.match(/^(\w*ing) .*/i)) {
- var join_text = s.auto_join_text_ing;
- } else {
- var join_text = s.auto_join_text_default;
- }
- } else {
- var join_text = s.join_text;
- };
-
- var from_user = item.from_user || item.user.screen_name;
- var profile_image_url = item.profile_image_url || item.user.profile_image_url;
- var join_template = '<span class="tweet_join"> '+join_text+' </span>';
- var join = ((s.join_text) ? join_template : ' ');
- 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>';
- var avatar = (s.avatar_size ? avatar_template : '');
- var date = '<a href="http://twitter.com/'+from_user+'/statuses/'+item.id+'" title="view tweet on twitter">'+relative_time(item.created_at)+'</a>';
- var text = '<span class="tweet_text">' +$([item.text]).linkUrl().linkUser().linkHash().makeHeart().capAwesome().capEpic()[0]+ '</span>';
-
- // until we create a template option, arrange the items below to alter a tweet's display.
- list.append('<li>' + avatar + date + join + text + '</li>');
-
- list.children('li:first').addClass('tweet_first');
- list.children('li:odd').addClass('tweet_even');
- list.children('li:even').addClass('tweet_odd');
- });
- if (s.outro_text) list.after(outro);
- });
-
- });
- };
-})(jQuery); \ No newline at end of file
diff --git a/doc/source/_static/nature.css b/doc/source/_static/nature.css
deleted file mode 100644
index 060ced8..0000000
--- a/doc/source/_static/nature.css
+++ /dev/null
@@ -1,245 +0,0 @@
-/*
- * nature.css_t
- * ~~~~~~~~~~~~
- *
- * Sphinx stylesheet -- nature theme.
- *
- * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS.
- * :license: BSD, see LICENSE for details.
- *
- */
-
-@import url("basic.css");
-
-/* -- page layout ----------------------------------------------------------- */
-
-body {
- font-family: Arial, sans-serif;
- font-size: 100%;
- background-color: #111;
- color: #555;
- margin: 0;
- padding: 0;
-}
-
-div.documentwrapper {
- float: left;
- width: 100%;
-}
-
-div.bodywrapper {
- margin: 0 0 0 {{ theme_sidebarwidth|toint }}px;
-}
-
-hr {
- border: 1px solid #B1B4B6;
-}
-
-div.document {
- background-color: #eee;
-}
-
-div.body {
- background-color: #ffffff;
- color: #3E4349;
- padding: 0 30px 30px 30px;
- font-size: 0.9em;
-}
-
-div.footer {
- color: #555;
- width: 100%;
- padding: 13px 0;
- text-align: center;
- font-size: 75%;
-}
-
-div.footer a {
- color: #444;
- text-decoration: underline;
-}
-
-div.related {
- background-color: #6BA81E;
- line-height: 32px;
- color: #fff;
- text-shadow: 0px 1px 0 #444;
- font-size: 0.9em;
-}
-
-div.related a {
- color: #E2F3CC;
-}
-
-div.sphinxsidebar {
- font-size: 0.75em;
- line-height: 1.5em;
-}
-
-div.sphinxsidebarwrapper{
- padding: 20px 0;
-}
-
-div.sphinxsidebar h3,
-div.sphinxsidebar h4 {
- font-family: Arial, sans-serif;
- color: #222;
- font-size: 1.2em;
- font-weight: normal;
- margin: 0;
- padding: 5px 10px;
- background-color: #ddd;
- text-shadow: 1px 1px 0 white
-}
-
-div.sphinxsidebar h4{
- font-size: 1.1em;
-}
-
-div.sphinxsidebar h3 a {
- color: #444;
-}
-
-
-div.sphinxsidebar p {
- color: #888;
- padding: 5px 20px;
-}
-
-div.sphinxsidebar p.topless {
-}
-
-div.sphinxsidebar ul {
- margin: 10px 20px;
- padding: 0;
- color: #000;
-}
-
-div.sphinxsidebar a {
- color: #444;
-}
-
-div.sphinxsidebar input {
- border: 1px solid #ccc;
- font-family: sans-serif;
- font-size: 1em;
-}
-
-div.sphinxsidebar input[type=text]{
- margin-left: 20px;
-}
-
-/* -- body styles ----------------------------------------------------------- */
-
-a {
- color: #005B81;
- text-decoration: none;
-}
-
-a:hover {
- color: #E32E00;
- text-decoration: underline;
-}
-
-div.body h1,
-div.body h2,
-div.body h3,
-div.body h4,
-div.body h5,
-div.body h6 {
- font-family: Arial, sans-serif;
- background-color: #BED4EB;
- font-weight: normal;
- color: #212224;
- margin: 30px 0px 10px 0px;
- padding: 5px 0 5px 10px;
- text-shadow: 0px 1px 0 white
-}
-
-div.body h1 { border-top: 20px solid white; margin-top: 0; font-size: 200%; }
-div.body h2 { font-size: 150%; background-color: #C8D5E3; }
-div.body h3 { font-size: 120%; background-color: #D8DEE3; }
-div.body h4 { font-size: 110%; background-color: #D8DEE3; }
-div.body h5 { font-size: 100%; background-color: #D8DEE3; }
-div.body h6 { font-size: 100%; background-color: #D8DEE3; }
-
-a.headerlink {
- color: #c60f0f;
- font-size: 0.8em;
- padding: 0 4px 0 4px;
- text-decoration: none;
-}
-
-a.headerlink:hover {
- background-color: #c60f0f;
- color: white;
-}
-
-div.body p, div.body dd, div.body li {
- line-height: 1.5em;
-}
-
-div.admonition p.admonition-title + p {
- display: inline;
-}
-
-div.highlight{
- background-color: white;
-}
-
-div.note {
- background-color: #eee;
- border: 1px solid #ccc;
-}
-
-div.seealso {
- background-color: #ffc;
- border: 1px solid #ff6;
-}
-
-div.topic {
- background-color: #eee;
-}
-
-div.warning {
- background-color: #ffe4e4;
- border: 1px solid #f66;
-}
-
-p.admonition-title {
- display: inline;
-}
-
-p.admonition-title:after {
- content: ":";
-}
-
-pre {
- padding: 10px;
- background-color: White;
- color: #222;
- line-height: 1.2em;
- border: 1px solid #C6C9CB;
- font-size: 1.1em;
- margin: 1.5em 0 1.5em 0;
- -webkit-box-shadow: 1px 1px 1px #d8d8d8;
- -moz-box-shadow: 1px 1px 1px #d8d8d8;
-}
-
-tt {
- background-color: #ecf0f3;
- color: #222;
- /* padding: 1px 2px; */
- font-size: 1.1em;
- font-family: monospace;
-}
-
-.viewcode-back {
- font-family: Arial, sans-serif;
-}
-
-div.viewcode-block:target {
- background-color: #f4debf;
- border-top: 1px solid #ac9;
- border-bottom: 1px solid #ac9;
-}
diff --git a/doc/source/_static/openstack_logo.png b/doc/source/_static/openstack_logo.png
deleted file mode 100644
index 146faec..0000000
--- a/doc/source/_static/openstack_logo.png
+++ /dev/null
Binary files differ
diff --git a/doc/source/_static/tweaks.css b/doc/source/_static/tweaks.css
deleted file mode 100644
index 3f3fb3f..0000000
--- a/doc/source/_static/tweaks.css
+++ /dev/null
@@ -1,94 +0,0 @@
-body {
- background: #fff url(../_static/header_bg.jpg) top left no-repeat;
-}
-
-#header {
- width: 950px;
- margin: 0 auto;
- height: 102px;
-}
-
-#header h1#logo {
- background: url(../_static/openstack_logo.png) top left no-repeat;
- display: block;
- float: left;
- text-indent: -9999px;
- width: 175px;
- height: 55px;
-}
-
-#navigation {
- background: url(../_static/header-line.gif) repeat-x 0 bottom;
- display: block;
- float: left;
- margin: 27px 0 0 25px;
- padding: 0;
-}
-
-#navigation li{
- float: left;
- display: block;
- margin-right: 25px;
-}
-
-#navigation li a {
- display: block;
- font-weight: normal;
- text-decoration: none;
- background-position: 50% 0;
- padding: 20px 0 5px;
- color: #353535;
- font-size: 14px;
-}
-
-#navigation li a.current, #navigation li a.section {
- border-bottom: 3px solid #cf2f19;
- color: #cf2f19;
-}
-
-div.related {
- background-color: #cde2f8;
- border: 1px solid #b0d3f8;
-}
-
-div.related a {
- color: #4078ba;
- text-shadow: none;
-}
-
-div.sphinxsidebarwrapper {
- padding-top: 0;
-}
-
-pre {
- color: #555;
-}
-
-div.documentwrapper h1, div.documentwrapper h2, div.documentwrapper h3, div.documentwrapper h4, div.documentwrapper h5, div.documentwrapper h6 {
- font-family: 'PT Sans', sans-serif !important;
- color: #264D69;
- border-bottom: 1px dotted #C5E2EA;
- padding: 0;
- background: none;
- padding-bottom: 5px;
-}
-
-div.documentwrapper h3 {
- color: #CF2F19;
-}
-
-a.headerlink {
- color: #fff !important;
- margin-left: 5px;
- background: #CF2F19 !important;
-}
-
-div.body {
- margin-top: -25px;
- margin-left: 230px;
-}
-
-div.document {
- width: 960px;
- margin: 0 auto;
-} \ No newline at end of file
diff --git a/doc/source/_theme/layout.html b/doc/source/_theme/layout.html
deleted file mode 100644
index 750b782..0000000
--- a/doc/source/_theme/layout.html
+++ /dev/null
@@ -1,83 +0,0 @@
-{% extends "basic/layout.html" %}
-{% set css_files = css_files + ['_static/tweaks.css'] %}
-{% set script_files = script_files + ['_static/jquery.tweet.js'] %}
-
-{%- macro sidebar() %}
- {%- if not embedded %}{% if not theme_nosidebar|tobool %}
- <div class="sphinxsidebar">
- <div class="sphinxsidebarwrapper">
- {%- block sidebarlogo %}
- {%- if logo %}
- <p class="logo"><a href="{{ pathto(master_doc) }}">
- <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
- </a></p>
- {%- endif %}
- {%- endblock %}
- {%- block sidebartoc %}
- {%- if display_toc %}
- <h3><a href="{{ pathto(master_doc) }}">{{ _('Table Of Contents') }}</a></h3>
- {{ toc }}
- {%- endif %}
- {%- endblock %}
- {%- block sidebarrel %}
- {%- if prev %}
- <h4>{{ _('Previous topic') }}</h4>
- <p class="topless"><a href="{{ prev.link|e }}"
- title="{{ _('previous chapter') }}">{{ prev.title }}</a></p>
- {%- endif %}
- {%- if next %}
- <h4>{{ _('Next topic') }}</h4>
- <p class="topless"><a href="{{ next.link|e }}"
- title="{{ _('next chapter') }}">{{ next.title }}</a></p>
- {%- endif %}
- {%- endblock %}
- {%- block sidebarsourcelink %}
- {%- if show_source and has_source and sourcename %}
- <h3>{{ _('This Page') }}</h3>
- <ul class="this-page-menu">
- <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}"
- rel="nofollow">{{ _('Show Source') }}</a></li>
- </ul>
- {%- endif %}
- {%- endblock %}
- {%- if customsidebar %}
- {% include customsidebar %}
- {%- endif %}
- {%- block sidebarsearch %}
- {%- if pagename != "search" %}
- <div id="searchbox" style="display: none">
- <h3>{{ _('Quick search') }}</h3>
- <form class="search" action="{{ pathto('search') }}" method="get">
- <input type="text" name="q" size="18" />
- <input type="submit" value="{{ _('Go') }}" />
- <input type="hidden" name="check_keywords" value="yes" />
- <input type="hidden" name="area" value="default" />
- </form>
- <p class="searchtip" style="font-size: 90%">
- {{ _('Enter search terms or a module, class or function name.') }}
- </p>
- </div>
- <script type="text/javascript">$('#searchbox').show(0);</script>
- {%- endif %}
- {%- endblock %}
- </div>
- </div>
- {%- endif %}{% endif %}
-{%- endmacro %}
-
-{% block relbar1 %}{% endblock relbar1 %}
-
-{% block header %}
- <div id="header">
- <h1 id="logo"><a href="http://www.openstack.org/">OpenStack</a></h1>
- <ul id="navigation">
- <li><a href="http://www.openstack.org/" title="Go to the Home page" class="link">Home</a></li>
- <li><a href="http://www.openstack.org/projects/" title="Go to the OpenStack Projects page">Projects</a></li>
- <li><a href="http://www.openstack.org/user-stories/" title="Go to the User Stories page" class="link">User Stories</a></li>
- <li><a href="http://www.openstack.org/community/" title="Go to the Community page" class="link">Community</a></li>
- <li><a href="http://www.openstack.org/blog/" title="Go to the OpenStack Blog">Blog</a></li>
- <li><a href="http://wiki.openstack.org/" title="Go to the OpenStack Wiki">Wiki</a></li>
- <li><a href="http://docs.openstack.org/" title="Go to OpenStack Documentation" class="current">Documentation</a></li>
- </ul>
- </div>
-{% endblock %} \ No newline at end of file
diff --git a/doc/source/_theme/theme.conf b/doc/source/_theme/theme.conf
deleted file mode 100644
index 1cc4004..0000000
--- a/doc/source/_theme/theme.conf
+++ /dev/null
@@ -1,4 +0,0 @@
-[theme]
-inherit = basic
-stylesheet = nature.css
-pygments_style = tango
diff --git a/doc/source/man/cfn-create-aws-symlinks.rst b/doc/source/cfn-create-aws-symlinks.rst
index 308ef3b..308ef3b 100644
--- a/doc/source/man/cfn-create-aws-symlinks.rst
+++ b/doc/source/cfn-create-aws-symlinks.rst
diff --git a/doc/source/man/cfn-get-metadata.rst b/doc/source/cfn-get-metadata.rst
index 9752d1f..9752d1f 100644
--- a/doc/source/man/cfn-get-metadata.rst
+++ b/doc/source/cfn-get-metadata.rst
diff --git a/doc/source/man/cfn-hup.rst b/doc/source/cfn-hup.rst
index 5f338d2..5f338d2 100644
--- a/doc/source/man/cfn-hup.rst
+++ b/doc/source/cfn-hup.rst
diff --git a/doc/source/man/cfn-init.rst b/doc/source/cfn-init.rst
index a336559..a336559 100644
--- a/doc/source/man/cfn-init.rst
+++ b/doc/source/cfn-init.rst
diff --git a/doc/source/man/cfn-push-stats.rst b/doc/source/cfn-push-stats.rst
index 5b872c5..5b872c5 100644
--- a/doc/source/man/cfn-push-stats.rst
+++ b/doc/source/cfn-push-stats.rst
diff --git a/doc/source/man/cfn-signal.rst b/doc/source/cfn-signal.rst
index 327ac35..327ac35 100644
--- a/doc/source/man/cfn-signal.rst
+++ b/doc/source/cfn-signal.rst
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 50918d5..567b444 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -1,10 +1,21 @@
# -*- coding: utf-8 -*-
+# Licensed under the Apache License, Version 2.0 (the "License"); you may
+# not use this file except in compliance with the License. You may obtain
+# a copy of the License at
#
-# Heat documentation build configuration file, created by
-# sphinx-quickstart on Thu Dec 13 11:23:35 2012.
+# http://www.apache.org/licenses/LICENSE-2.0
#
-# This file is execfile()d with the current directory set to its containing
-# dir.
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+# License for the specific language governing permissions and limitations
+# under the License.
+#
+# heat-cfntools documentation build configuration file, created by
+# sphinx-quickstart on Thu Jul 20 09:19:39 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
@@ -12,256 +23,171 @@
# All configuration values have a default; values that are commented out
# serve to show the default.
-import os
-import sys
-
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
-sys.path.insert(0, os.path.abspath('../../'))
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
-# -- General configuration ----------------------------------------------------
+# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+#
+# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
extensions = ['sphinx.ext.autodoc',
- 'sphinx.ext.ifconfig',
- 'sphinx.ext.viewcode']
+ 'openstackdocstheme']
# Add any paths that contain templates here, relative to this directory.
-#templates_path = ['_templates']
+templates_path = ['_templates']
-# The suffix of source filenames.
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
-# The encoding of source files.
-#source_encoding = 'utf-8-sig'
-
# The master toctree document.
-master_doc = 'man/index'
+master_doc = 'index'
# General information about the project.
-project = u'Heat cfntools'
-copyright = u'2012,2013 Heat Developers'
+project = 'heat-cfntools'
+copyright = 'OpenStack Foundation'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-
-#from heat import version as heat_version
+#
+# The short X.Y version.
+version = ''
# The full version, including alpha/beta/rc tags.
-#release = heat_version.version_info.release_string()
-# The short X.Y version
-#version = heat_version.version_info.version_string()
+release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
-#language = None
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-#today = ''
-# Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = []
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-#default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-#add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-#show_authors = False
-
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
-# A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+# todo_include_todos = False
-# -- Options for HTML output --------------------------------------------------
+# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme_path = ['.']
-html_theme = '_theme'
+#
+html_theme = 'openstackdocs'
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
-html_theme_options = {
- "nosidebar": "false"
-}
-
-# Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
-
-# The name for this set of Sphinx documents. If None, it defaults to
-# "<project> v<release> documentation".
-#html_title = None
-
-# A shorter title for the navigation bar. Default is the same as html_title.
-#html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-#html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-#html_favicon = None
+#
+# html_theme_options = {}
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+# html_static_path = ['_static']
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-#html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-#html_additional_pages = {}
-
-# If false, no module index is generated.
-#html_domain_indices = True
-
-# If false, no index is generated.
-#html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-#html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
+# html_sidebars = {}
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it. The value of this option must be the
-# base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# -- Options for openstackdocstheme --------------------------------------
+repository_name = 'openstack/heat-cfntools'
+bug_project = 'heat-cfntools'
+bug_tag = ''
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = 'Heatdoc'
+htmlhelp_basename = 'heat-cfntoolsdoc'
-# -- Options for LaTeX output -------------------------------------------------
+# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+ # The paper size ('letterpaper' or 'a4paper').
+ #
+ # 'papersize': 'letterpaper',
+
+ # The font size ('10pt', '11pt' or '12pt').
+ #
+ # 'pointsize': '10pt',
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+ # Additional stuff for the LaTeX preamble.
+ #
+ # 'preamble': '',
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+ # Latex figure (float) alignment
+ #
+ # 'figure_align': 'htbp',
}
# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title, author, documentclass [howto/manual])
-#latex_documents = [
-# ('index', 'Heat.tex', u'Heat Documentation',
-# u'Heat Developers', 'manual'),
-#]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-#latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-#latex_use_parts = False
-
-# If true, show page references after internal links.
-#latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-#latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-#latex_appendices = []
-
-# If false, no module index is generated.
-#latex_domain_indices = True
+# (source start file, target name, title,
+# author, documentclass [howto, manual, or own class]).
+latex_documents = [
+ (master_doc, 'heat-cfntools.tex', 'heat-cfntools Documentation',
+ 'OpenStack Foundation', 'manual'),
+]
-# -- Options for manual page output -------------------------------------------
+# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
- ('man/cfn-create-aws-symlinks', 'cfn-create-aws-symlinks',
+ (master_doc, 'heat-cfntools', 'heat-cfntools Documentation',
+ ['Heat Developers'], 1),
+ ('cfn-create-aws-symlinks', 'cfn-create-aws-symlinks',
u'Creates symlinks for the cfn-* scripts in this directory to /opt/aws/bin',
[u'Heat Developers'], 1),
- ('man/cfn-get-metadata', 'cfn-get-metadata',
+ ('cfn-get-metadata', 'cfn-get-metadata',
u'Implements cfn-get-metadata CloudFormation functionality',
[u'Heat Developers'], 1),
- ('man/cfn-hup', 'cfn-hup',
+ ('cfn-hup', 'cfn-hup',
u'Implements cfn-hup CloudFormation functionality',
[u'Heat Developers'], 1),
- ('man/cfn-init', 'cfn-init',
+ ('cfn-init', 'cfn-init',
u'Implements cfn-init CloudFormation functionality',
[u'Heat Developers'], 1),
- ('man/cfn-push-stats', 'cfn-push-stats',
+ ('cfn-push-stats', 'cfn-push-stats',
u'Implements cfn-push-stats CloudFormation functionality',
[u'Heat Developers'], 1),
- ('man/cfn-signal', 'cfn-signal',
+ ('cfn-signal', 'cfn-signal',
u'Implements cfn-signal CloudFormation functionality',
[u'Heat Developers'], 1),
]
-# If true, show URL addresses after external links.
-#man_show_urls = False
-
-# -- Options for Texinfo output -----------------------------------------------
+# -- Options for Texinfo output -------------------------------------------
# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
-#texinfo_documents = [
-# ('index', 'Heat', u'Heat Documentation',
-# u'Heat Developers', 'Heat', 'One line description of project.',
-# 'Miscellaneous'),
-#]
-
-# Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
-
-# If false, no module index is generated.
-#texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+texinfo_documents = [
+ (master_doc, 'heat-cfntools', 'heat-cfntools Documentation',
+ 'Heat Developers', 'heat-cfntools', 'One line description of project.',
+ 'Miscellaneous'),
+]
diff --git a/doc/source/man/index.rst b/doc/source/index.rst
index 45d7165..54479b1 100644
--- a/doc/source/man/index.rst
+++ b/doc/source/index.rst
@@ -7,7 +7,7 @@ Heat cfntools
-------------
.. toctree::
- :maxdepth: 2
+ :maxdepth: 1
cfn-create-aws-symlinks
cfn-get-metadata
diff --git a/setup.cfg b/setup.cfg
index 23690c3..64195d8 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -33,3 +33,11 @@ setup-hooks =
[wheel]
universal = 1
+
+[build_sphinx]
+source-dir = doc/source
+build-dir = doc/build
+all_files = 1
+
+[upload_sphinx]
+upload-dir = doc/build/html
diff --git a/test-requirements.txt b/test-requirements.txt
index 5d3b372..9a2e1ea 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -3,5 +3,7 @@ hacking>=0.8.0,<0.9
mock>=1.0
discover
+openstackdocstheme>=1.11.0 # Apache-2.0
+sphinx>=1.6.2 # BSD
testrepository>=0.0.18
testtools>=0.9.34
diff --git a/tox.ini b/tox.ini
index 9e3ea73..f974f36 100644
--- a/tox.ini
+++ b/tox.ini
@@ -27,3 +27,9 @@ commands = {posargs}
[flake8]
show-source = true
exclude=.venv,.git,.tox,dist,doc,*lib/python*,*egg,tools
+
+[testenv:docs]
+deps = -r{toxinidir}/requirements.txt
+ -r{toxinidir}/test-requirements.txt
+ sphinxcontrib-httpdomain
+commands = python setup.py build_sphinx