Skip to content

Commit a94560d

Browse files
danquackdanquack
committed
added puppet string docs
1 parent eac8ea6 commit a94560d

26 files changed

+7468
-2
lines changed

‎Gemfile

+1
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,7 @@ group :release do
6666
gem 'puppet-blacksmith', :require => false
6767
gem 'voxpupuli-release', :require => false, :git => 'https://github.com/voxpupuli/voxpupuli-release-gem'
6868
gem 'puppet-strings', '>= 1.0', :require => false
69+
gem 'yard', :require => false
6970
end
7071

7172

‎docs/_index.html

+176
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
<!DOCTYPE html>
2+
<html>
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>
7+
Documentation by YARD 0.9.16
8+
9+
</title>
10+
11+
<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
12+
13+
<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
14+
15+
<script type="text/javascript" charset="utf-8">
16+
pathId = null;
17+
relpath = '';
18+
</script>
19+
20+
21+
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
22+
23+
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
24+
25+
26+
</head>
27+
<body>
28+
<div class="nav_wrap">
29+
<iframe id="nav" src="puppet_class_list.html?1"></iframe>
30+
<div id="resizer"></div>
31+
</div>
32+
33+
<div id="main" tabindex="-1">
34+
<div id="header">
35+
<div id="menu">
36+
37+
</div>
38+
39+
<div id="search">
40+
41+
<a class="full_list_link" id="puppet_class_list_link"
42+
href="puppet_class_list.html">
43+
44+
<svg width="24" height="24">
45+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
46+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
47+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
48+
</svg>
49+
</a>
50+
51+
</div>
52+
<div class="clear"></div>
53+
</div>
54+
55+
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.16</h1>
56+
<div id="listing">
57+
<h1 class="alphaindex">Alphabetic Index</h1>
58+
59+
<h2>Puppet Class Listing A-Z</h2>
60+
61+
62+
<table>
63+
<tr>
64+
<td valign='top' width="33%">
65+
66+
67+
<ul id="alpha_P" class="alpha">
68+
<li class="letter">P</li>
69+
<ul>
70+
71+
<li>
72+
<span class='object_link'><a href="puppet_classes/python.html" title="puppet_classes::python (puppet_class)">python</a></span>
73+
74+
</li>
75+
76+
<li>
77+
<span class='object_link'><a href="puppet_classes/python_3A_3Aconfig.html" title="puppet_classes::python::config (puppet_class)">python::config</a></span>
78+
79+
</li>
80+
81+
<li>
82+
<span class='object_link'><a href="puppet_classes/python_3A_3Ainstall.html" title="puppet_classes::python::install (puppet_class)">python::install</a></span>
83+
84+
</li>
85+
86+
<li>
87+
<span class='object_link'><a href="puppet_classes/python_3A_3Aparams.html" title="puppet_classes::python::params (puppet_class)">python::params</a></span>
88+
89+
</li>
90+
91+
</ul>
92+
</ul>
93+
94+
</td>
95+
</tr>
96+
</table>
97+
98+
99+
<h2>Defined Type Listing A-Z</h2>
100+
101+
102+
<table>
103+
<tr>
104+
<td valign='top' width="33%">
105+
106+
107+
<ul id="alpha_P" class="alpha">
108+
<li class="letter">P</li>
109+
<ul>
110+
111+
<li>
112+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Adotfile.html" title="puppet_defined_types::python::dotfile (puppet_defined_type)">python::dotfile</a></span>
113+
114+
</li>
115+
116+
<li>
117+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Agunicorn.html" title="puppet_defined_types::python::gunicorn (puppet_defined_type)">python::gunicorn</a></span>
118+
119+
</li>
120+
121+
<li>
122+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Apip.html" title="puppet_defined_types::python::pip (puppet_defined_type)">python::pip</a></span>
123+
124+
</li>
125+
126+
<li>
127+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Apyvenv.html" title="puppet_defined_types::python::pyvenv (puppet_defined_type)">python::pyvenv</a></span>
128+
129+
</li>
130+
131+
<li>
132+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Arequirements.html" title="puppet_defined_types::python::requirements (puppet_defined_type)">python::requirements</a></span>
133+
134+
</li>
135+
136+
<li>
137+
<span class='object_link'><a href="puppet_defined_types/python_3A_3Avirtualenv.html" title="puppet_defined_types::python::virtualenv (puppet_defined_type)">python::virtualenv</a></span>
138+
139+
</li>
140+
141+
</ul>
142+
</ul>
143+
144+
</td>
145+
</tr>
146+
</table>
147+
148+
149+
150+
151+
152+
153+
154+
<h2>File Listing</h2>
155+
<ul id="files" class="index_inline_list">
156+
157+
158+
<li class="r1"><a href="index.html" title="README">README</a></li>
159+
160+
161+
</ul>
162+
163+
<div class="clear"></div>
164+
165+
166+
</div>
167+
168+
</div>
169+
170+
<div id="footer">
171+
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
172+
</div>
173+
174+
</div>
175+
</body>
176+
</html>

‎docs/css/common.css

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/* Ensure the search bar doesn't overlap with links */
2+
.fixed_header {
3+
padding-bottom: 25px;
4+
}
5+
6+
#full_list {
7+
padding-top: 15px;
8+
}

‎docs/css/full_list.css

+58
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
body {
2+
margin: 0;
3+
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
4+
font-size: 13px;
5+
height: 101%;
6+
overflow-x: hidden;
7+
background: #fafafa;
8+
}
9+
10+
h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
11+
.clear { clear: both; }
12+
.fixed_header { position: fixed; background: #fff; width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; height: 70px; }
13+
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
14+
#content.insearch #search, #content.insearch #noresults { background: url(data:image/gif;base64,R0lGODlhEAAQAPYAAP///wAAAPr6+pKSkoiIiO7u7sjIyNjY2J6engAAAI6OjsbGxjIyMlJSUuzs7KamppSUlPLy8oKCghwcHLKysqSkpJqamvT09Pj4+KioqM7OzkRERAwMDGBgYN7e3ujo6Ly8vCoqKjY2NkZGRtTU1MTExDw8PE5OTj4+PkhISNDQ0MrKylpaWrS0tOrq6nBwcKysrLi4uLq6ul5eXlxcXGJiYoaGhuDg4H5+fvz8/KKiohgYGCwsLFZWVgQEBFBQUMzMzDg4OFhYWBoaGvDw8NbW1pycnOLi4ubm5kBAQKqqqiQkJCAgIK6urnJyckpKSjQ0NGpqatLS0sDAwCYmJnx8fEJCQlRUVAoKCggICLCwsOTk5ExMTPb29ra2tmZmZmhoaNzc3KCgoBISEiIiIgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAACH/C05FVFNDQVBFMi4wAwEAAAAh/hpDcmVhdGVkIHdpdGggYWpheGxvYWQuaW5mbwAh+QQJCAAAACwAAAAAEAAQAAAHaIAAgoMgIiYlg4kACxIaACEJCSiKggYMCRselwkpghGJBJEcFgsjJyoAGBmfggcNEx0flBiKDhQFlIoCCA+5lAORFb4AJIihCRbDxQAFChAXw9HSqb60iREZ1omqrIPdJCTe0SWI09GBACH5BAkIAAAALAAAAAAQABAAAAdrgACCgwc0NTeDiYozCQkvOTo9GTmDKy8aFy+NOBA7CTswgywJDTIuEjYFIY0JNYMtKTEFiRU8Pjwygy4ws4owPyCKwsMAJSTEgiQlgsbIAMrO0dKDGMTViREZ14kYGRGK38nHguHEJcvTyIEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDAggPg4iJAAMJCRUAJRIqiRGCBI0WQEEJJkWDERkYAAUKEBc4Po1GiKKJHkJDNEeKig4URLS0ICImJZAkuQAhjSi/wQyNKcGDCyMnk8u5rYrTgqDVghgZlYjcACTA1sslvtHRgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCQARAtOUoQRGRiFD0kJUYWZhUhKT1OLhR8wBaaFBzQ1NwAlkIszCQkvsbOHL7Y4q4IuEjaqq0ZQD5+GEEsJTDCMmIUhtgk1lo6QFUwJVDKLiYJNUd6/hoEAIfkECQgAAAAsAAAAABAAEAAAB2iAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4uen4ICCA+IkIsDCQkVACWmhwSpFqAABQoQF6ALTkWFnYMrVlhWvIKTlSAiJiVVPqlGhJkhqShHV1lCW4cMqSkAR1ofiwsjJyqGgQAh+QQJCAAAACwAAAAAEAAQAAAHZ4AAgoOEhYaCJSWHgxGDJCSMhREZGIYYGY2ElYebi56fhyWQniSKAKKfpaCLFlAPhl0gXYNGEwkhGYREUywag1wJwSkHNDU3D0kJYIMZQwk8MjPBLx9eXwuETVEyAC/BOKsuEjYFhoEAIfkECQgAAAAsAAAAABAAEAAAB2eAAIKDhIWGgiUlh4MRgyQkjIURGRiGGBmNhJWHm4ueICImip6CIQkJKJ4kigynKaqKCyMnKqSEK05StgAGQRxPYZaENqccFgIID4KXmQBhXFkzDgOnFYLNgltaSAAEpxa7BQoQF4aBACH5BAkIAAAALAAAAAAQABAAAAdogACCg4SFggJiPUqCJSWGgkZjCUwZACQkgxGEXAmdT4UYGZqCGWQ+IjKGGIUwPzGPhAc0NTewhDOdL7Ykji+dOLuOLhI2BbaFETICx4MlQitdqoUsCQ2vhKGjglNfU0SWmILaj43M5oEAOwAAAAAAAAAAAA==) no-repeat center left; }
15+
#full_list { padding: 0; list-style: none; margin-left: 0; margin-top: 80px; font-size: 1.1em; }
16+
#full_list ul { padding: 0; }
17+
#full_list li { padding: 0; margin: 0; list-style: none; }
18+
#full_list li .item { padding: 5px 5px 5px 12px; }
19+
#noresults { padding: 7px 12px; background: #fff; }
20+
#content.insearch #noresults { margin-left: 7px; }
21+
li.collapsed ul { display: none; }
22+
li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
23+
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
24+
li { color: #888; cursor: pointer; }
25+
li.deprecated { text-decoration: line-through; font-style: italic; }
26+
li.odd { background: #f0f0f0; }
27+
li.even { background: #fafafa; }
28+
.item:hover { background: #ddd; }
29+
li small:before { content: "("; }
30+
li small:after { content: ")"; }
31+
li small.search_info { display: none; }
32+
a, a:visited { text-decoration: none; color: #05a; }
33+
li.clicked > .item { background: #05a; color: #ccc; }
34+
li.clicked > .item a, li.clicked > .item a:visited { color: #eee; }
35+
li.clicked > .item a.toggle { opacity: 0.5; background-position: bottom right; }
36+
li.collapsed.clicked a.toggle { background-position: top right; }
37+
#search input { border: 1px solid #bbb; border-radius: 3px; }
38+
#full_list_nav { margin-left: 10px; font-size: 0.9em; display: block; color: #aaa; }
39+
#full_list_nav a, #nav a:visited { color: #358; }
40+
#full_list_nav a:hover { background: transparent; color: #5af; }
41+
#full_list_nav span:after { content: ' | '; }
42+
#full_list_nav span:last-child:after { content: ''; }
43+
44+
#content h1 { margin-top: 0; }
45+
li { white-space: nowrap; cursor: normal; }
46+
li small { display: block; font-size: 0.8em; }
47+
li small:before { content: ""; }
48+
li small:after { content: ""; }
49+
li small.search_info { display: none; }
50+
#search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
51+
#content.insearch #search { background-position: center right; }
52+
#search input { width: 110px; }
53+
54+
#full_list.insearch ul { display: block; }
55+
#full_list.insearch .item { display: none; }
56+
#full_list.insearch .found { display: block; padding-left: 11px !important; }
57+
#full_list.insearch li a.toggle { display: none; }
58+
#full_list.insearch li small.search_info { display: block; }

0 commit comments

Comments
 (0)