Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added puppet string docs
Browse files Browse the repository at this point in the history
danquack committed Oct 21, 2018

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent eac8ea6 commit a94560d
Showing 26 changed files with 7,468 additions and 2 deletions.
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -66,6 +66,7 @@ group :release do
gem 'puppet-blacksmith', :require => false
gem 'voxpupuli-release', :require => false, :git => 'https://github.com/voxpupuli/voxpupuli-release-gem'
gem 'puppet-strings', '>= 1.0', :require => false
gem 'yard', :require => false
end


176 changes: 176 additions & 0 deletions docs/_index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,176 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = null;
relpath = '';
</script>


<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.16</h1>
<div id="listing">
<h1 class="alphaindex">Alphabetic Index</h1>

<h2>Puppet Class Listing A-Z</h2>


<table>
<tr>
<td valign='top' width="33%">


<ul id="alpha_P" class="alpha">
<li class="letter">P</li>
<ul>

<li>
<span class='object_link'><a href="puppet_classes/python.html" title="puppet_classes::python (puppet_class)">python</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_classes/python_3A_3Aconfig.html" title="puppet_classes::python::config (puppet_class)">python::config</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_classes/python_3A_3Ainstall.html" title="puppet_classes::python::install (puppet_class)">python::install</a></span>

</li>

<li>
<span class='object_link'><a href="puppet_classes/python_3A_3Aparams.html" title="puppet_classes::python::params (puppet_class)">python::params</a></span>

</li>

</ul>
</ul>

</td>
</tr>
</table>


<h2>Defined Type Listing A-Z</h2>


<table>
<tr>
<td valign='top' width="33%">


<ul id="alpha_P" class="alpha">
<li class="letter">P</li>
<ul>

<li>
<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>

</li>

<li>
<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>

</li>

<li>
<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>

</li>

<li>
<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>

</li>

<li>
<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>

</li>

<li>
<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>

</li>

</ul>
</ul>

</td>
</tr>
</table>







<h2>File Listing</h2>
<ul id="files" class="index_inline_list">


<li class="r1"><a href="index.html" title="README">README</a></li>


</ul>

<div class="clear"></div>


</div>

</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
8 changes: 8 additions & 0 deletions docs/css/common.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/* Ensure the search bar doesn't overlap with links */
.fixed_header {
padding-bottom: 25px;
}

#full_list {
padding-top: 15px;
}
58 changes: 58 additions & 0 deletions docs/css/full_list.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
body {
margin: 0;
font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
font-size: 13px;
height: 101%;
overflow-x: hidden;
background: #fafafa;
}

h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
.clear { clear: both; }
.fixed_header { position: fixed; background: #fff; width: 100%; padding-bottom: 10px; margin-top: 0; top: 0; z-index: 9999; height: 70px; }
#search { position: absolute; right: 5px; top: 9px; padding-left: 24px; }
#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; }
#full_list { padding: 0; list-style: none; margin-left: 0; margin-top: 80px; font-size: 1.1em; }
#full_list ul { padding: 0; }
#full_list li { padding: 0; margin: 0; list-style: none; }
#full_list li .item { padding: 5px 5px 5px 12px; }
#noresults { padding: 7px 12px; background: #fff; }
#content.insearch #noresults { margin-left: 7px; }
li.collapsed ul { display: none; }
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; }
li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
li { color: #888; cursor: pointer; }
li.deprecated { text-decoration: line-through; font-style: italic; }
li.odd { background: #f0f0f0; }
li.even { background: #fafafa; }
.item:hover { background: #ddd; }
li small:before { content: "("; }
li small:after { content: ")"; }
li small.search_info { display: none; }
a, a:visited { text-decoration: none; color: #05a; }
li.clicked > .item { background: #05a; color: #ccc; }
li.clicked > .item a, li.clicked > .item a:visited { color: #eee; }
li.clicked > .item a.toggle { opacity: 0.5; background-position: bottom right; }
li.collapsed.clicked a.toggle { background-position: top right; }
#search input { border: 1px solid #bbb; border-radius: 3px; }
#full_list_nav { margin-left: 10px; font-size: 0.9em; display: block; color: #aaa; }
#full_list_nav a, #nav a:visited { color: #358; }
#full_list_nav a:hover { background: transparent; color: #5af; }
#full_list_nav span:after { content: ' | '; }
#full_list_nav span:last-child:after { content: ''; }

#content h1 { margin-top: 0; }
li { white-space: nowrap; cursor: normal; }
li small { display: block; font-size: 0.8em; }
li small:before { content: ""; }
li small:after { content: ""; }
li small.search_info { display: none; }
#search { width: 170px; position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; padding-left: 0; padding-right: 24px; }
#content.insearch #search { background-position: center right; }
#search input { width: 110px; }

#full_list.insearch ul { display: block; }
#full_list.insearch .item { display: none; }
#full_list.insearch .found { display: block; padding-left: 11px !important; }
#full_list.insearch li a.toggle { display: none; }
#full_list.insearch li small.search_info { display: block; }
496 changes: 496 additions & 0 deletions docs/css/style.css

Large diffs are not rendered by default.

443 changes: 443 additions & 0 deletions docs/file.README.html

Large diffs are not rendered by default.

17 changes: 17 additions & 0 deletions docs/frames.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Documentation by YARD 0.9.16</title>
</head>
<script type="text/javascript" charset="utf-8">
var match = unescape(window.location.hash).match(/^#!(.+)/);
var name = match ? match[1] : 'index.html';
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
window.top.location = name;
</script>
<noscript>
<h1>Oops!</h1>
<h2>YARD requires JavaScript!</h2>
</noscript>
</html>
443 changes: 443 additions & 0 deletions docs/index.html

Large diffs are not rendered by default.

292 changes: 292 additions & 0 deletions docs/js/app.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,292 @@
(function() {

var localStorage = {}, sessionStorage = {};
try { localStorage = window.localStorage; } catch (e) { }
try { sessionStorage = window.sessionStorage; } catch (e) { }

function createSourceLinks() {
$('.method_details_list .source_code').
before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
$('.toggleSource').toggle(function() {
$(this).parent().nextAll('.source_code').slideDown(100);
$(this).text("Hide source");
},
function() {
$(this).parent().nextAll('.source_code').slideUp(100);
$(this).text("View source");
});
}

function createDefineLinks() {
var tHeight = 0;
$('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
$('.toggleDefines').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).prev().css('display', 'inline');
$(this).parent().prev().height($(this).parent().height());
$(this).text("(less)");
},
function() {
$(this).prev().hide();
$(this).parent().prev().height(tHeight);
$(this).text("more...");
});
}

function createFullTreeLinks() {
var tHeight = 0;
$('.inheritanceTree').toggle(function() {
tHeight = $(this).parent().prev().height();
$(this).parent().toggleClass('showAll');
$(this).text("(hide)");
$(this).parent().prev().height($(this).parent().height());
},
function() {
$(this).parent().toggleClass('showAll');
$(this).parent().prev().height(tHeight);
$(this).text("show all");
});
}

function searchFrameButtons() {
$('.full_list_link').click(function() {
toggleSearchFrame(this, $(this).attr('href'));
return false;
});
window.addEventListener('message', function(e) {
if (e.data === 'navEscape') {
$('#nav').slideUp(100);
$('#search a').removeClass('active inactive');
$(window).focus();
}
});

$(window).resize(function() {
if ($('#search:visible').length === 0) {
$('#nav').removeAttr('style');
$('#search a').removeClass('active inactive');
$(window).focus();
}
});
}

function toggleSearchFrame(id, link) {
var frame = $('#nav');
$('#search a').removeClass('active').addClass('inactive');
if (frame.attr('src') === link && frame.css('display') !== "none") {
frame.slideUp(100);
$('#search a').removeClass('active inactive');
}
else {
$(id).addClass('active').removeClass('inactive');
if (frame.attr('src') !== link) frame.attr('src', link);
frame.slideDown(100);
}
}

function linkSummaries() {
$('.summary_signature').click(function() {
document.location = $(this).find('a').attr('href');
});
}

function summaryToggle() {
$('.summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.summary_toggle').each(function() {
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
var next = $(this).parent().parent().nextAll('ul.summary').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('ul.summary').first().toggle();
}
else if (next.hasClass('summary')) {
var list = $('<ul class="summary compact" />');
list.html(next.html());
list.find('.summary_desc, .note').remove();
list.find('a').each(function() {
$(this).html($(this).find('strong').html());
$(this).parent().html($(this)[0].outerHTML);
});
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == "collapse") {
$('.summary_toggle').first().click();
} else { localStorage.summaryCollapsed = "expand"; }
}

function constantSummaryToggle() {
$('.constants_summary_toggle').click(function(e) {
e.preventDefault();
localStorage.summaryCollapsed = $(this).text();
$('.constants_summary_toggle').each(function() {
$(this).text($(this).text() == "collapse" ? "expand" : "collapse");
var next = $(this).parent().parent().nextAll('dl.constants').first();
if (next.hasClass('compact')) {
next.toggle();
next.nextAll('dl.constants').first().toggle();
}
else if (next.hasClass('constants')) {
var list = $('<dl class="constants compact" />');
list.html(next.html());
list.find('dt').each(function() {
$(this).addClass('summary_signature');
$(this).text( $(this).text().split('=')[0]);
if ($(this).has(".deprecated").length) {
$(this).addClass('deprecated');
};
});
// Add the value of the constant as "Tooltip" to the summary object
list.find('pre.code').each(function() {
console.log($(this).parent());
var dt_element = $(this).parent().prev();
var tooltip = $(this).text();
if (dt_element.hasClass("deprecated")) {
tooltip = 'Deprecated. ' + tooltip;
};
dt_element.attr('title', tooltip);
});
list.find('.docstring, .tags, dd').remove();
next.before(list);
next.toggle();
}
});
return false;
});
if (localStorage.summaryCollapsed == "collapse") {
$('.constants_summary_toggle').first().click();
} else { localStorage.summaryCollapsed = "expand"; }
}

function generateTOC() {
if ($('#filecontents').length === 0) return;
var _toc = $('<ol class="top"></ol>');
var show = false;
var toc = _toc;
var counter = 0;
var tags = ['h2', 'h3', 'h4', 'h5', 'h6'];
var i;
if ($('#filecontents h1').length > 1) tags.unshift('h1');
for (i = 0; i < tags.length; i++) { tags[i] = '#filecontents ' + tags[i]; }
var lastTag = parseInt(tags[0][1], 10);
$(tags.join(', ')).each(function() {
if ($(this).parents('.method_details .docstring').length != 0) return;
if (this.id == "filecontents") return;
show = true;
var thisTag = parseInt(this.tagName[1], 10);
if (this.id.length === 0) {
var proposedId = $(this).attr('toc-id');
if (typeof(proposedId) != "undefined") this.id = proposedId;
else {
var proposedId = $(this).text().replace(/[^a-z0-9-]/ig, '_');
if ($('#' + proposedId).length > 0) { proposedId += counter; counter++; }
this.id = proposedId;
}
}
if (thisTag > lastTag) {
for (i = 0; i < thisTag - lastTag; i++) {
var tmp = $('<ol/>'); toc.append(tmp); toc = tmp;
}
}
if (thisTag < lastTag) {
for (i = 0; i < lastTag - thisTag; i++) toc = toc.parent();
}
var title = $(this).attr('toc-title');
if (typeof(title) == "undefined") title = $(this).text();
toc.append('<li><a href="#' + this.id + '">' + title + '</a></li>');
lastTag = thisTag;
});
if (!show) return;
html = '<div id="toc"><p class="title hide_toc"><a href="#"><strong>Table of Contents</strong></a></p></div>';
$('#content').prepend(html);
$('#toc').append(_toc);
$('#toc .hide_toc').toggle(function() {
$('#toc .top').slideUp('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
}, function() {
$('#toc .top').slideDown('fast');
$('#toc').toggleClass('hidden');
$('#toc .title small').toggle();
});
}

function navResizeFn(e) {
if (e.which !== 1) {
navResizeFnStop();
return;
}

sessionStorage.navWidth = e.pageX.toString();
$('.nav_wrap').css('width', e.pageX);
$('.nav_wrap').css('-ms-flex', 'inherit');
}

function navResizeFnStop() {
$(window).unbind('mousemove', navResizeFn);
window.removeEventListener('message', navMessageFn, false);
}

function navMessageFn(e) {
if (e.data.action === 'mousemove') navResizeFn(e.data.event);
if (e.data.action === 'mouseup') navResizeFnStop();
}

function navResizer() {
$('#resizer').mousedown(function(e) {
e.preventDefault();
$(window).mousemove(navResizeFn);
window.addEventListener('message', navMessageFn, false);
});
$(window).mouseup(navResizeFnStop);

if (sessionStorage.navWidth) {
navResizeFn({which: 1, pageX: parseInt(sessionStorage.navWidth, 10)});
}
}

function navExpander() {
var done = false, timer = setTimeout(postMessage, 500);
function postMessage() {
if (done) return;
clearTimeout(timer);
var opts = { action: 'expand', path: pathId };
document.getElementById('nav').contentWindow.postMessage(opts, '*');
done = true;
}

window.addEventListener('message', function(event) {
if (event.data === 'navReady') postMessage();
return false;
}, false);
}

function mainFocus() {
var hash = window.location.hash;
if (hash !== '' && $(hash)[0]) {
$(hash)[0].scrollIntoView();
}

setTimeout(function() { $('#main').focus(); }, 10);
}

$(document).ready(function() {
navResizer();
navExpander();
createSourceLinks();
createDefineLinks();
createFullTreeLinks();
searchFrameButtons();
linkSummaries();
summaryToggle();
constantSummaryToggle();
generateTOC();
mainFocus();
});

})();
216 changes: 216 additions & 0 deletions docs/js/full_list.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,216 @@
(function() {

var $clicked = $(null);
var searchTimeout = null;
var searchCache = [];
var caseSensitiveMatch = false;
var ignoreKeyCodeMin = 8;
var ignoreKeyCodeMax = 46;
var commandKey = 91;

RegExp.escape = function(text) {
return text.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
}

function escapeShortcut() {
$(document).keydown(function(evt) {
if (evt.which == 27) {
window.parent.postMessage('navEscape', '*');
}
});
}

function navResizer() {
$(window).mousemove(function(e) {
window.parent.postMessage({
action: 'mousemove', event: {pageX: e.pageX, which: e.which}
}, '*');
}).mouseup(function(e) {
window.parent.postMessage({action: 'mouseup'}, '*');
});
window.parent.postMessage("navReady", "*");
}

function clearSearchTimeout() {
clearTimeout(searchTimeout);
searchTimeout = null;
}

function enableLinks() {
// load the target page in the parent window
$('#full_list li').on('click', function(evt) {
$('#full_list li').removeClass('clicked');
$clicked = $(this);
$clicked.addClass('clicked');
evt.stopPropagation();

if (evt.target.tagName === 'A') return true;

var elem = $clicked.find('> .item .object_link a')[0];
var e = evt.originalEvent;
var newEvent = new MouseEvent(evt.originalEvent.type);
newEvent.initMouseEvent(e.type, e.canBubble, e.cancelable, e.view, e.detail, e.screenX, e.screenY, e.clientX, e.clientY, e.ctrlKey, e.altKey, e.shiftKey, e.metaKey, e.button, e.relatedTarget);
elem.dispatchEvent(newEvent);
evt.preventDefault();
return false;
});
}

function enableToggles() {
// show/hide nested classes on toggle click
$('#full_list a.toggle').on('click', function(evt) {
evt.stopPropagation();
evt.preventDefault();
$(this).parent().parent().toggleClass('collapsed');
highlight();
});
}

function populateSearchCache() {
$('#full_list li .item').each(function() {
var $node = $(this);
var $link = $node.find('.object_link a');
if ($link.length > 0) {
searchCache.push({
node: $node,
link: $link,
name: $link.text(),
fullName: $link.attr('title').split(' ')[0]
});
}
});
}

function enableSearch() {
$('#search input').keyup(function(event) {
if (ignoredKeyPress(event)) return;
if (this.value === "") {
clearSearch();
} else {
performSearch(this.value);
}
});

$('#full_list').after("<div id='noresults' style='display:none'></div>");
}

function ignoredKeyPress(event) {
if (
(event.keyCode > ignoreKeyCodeMin && event.keyCode < ignoreKeyCodeMax) ||
(event.keyCode == commandKey)
) {
return true;
} else {
return false;
}
}

function clearSearch() {
clearSearchTimeout();
$('#full_list .found').removeClass('found').each(function() {
var $link = $(this).find('.object_link a');
$link.text($link.text());
});
$('#full_list, #content').removeClass('insearch');
$clicked.parents().removeClass('collapsed');
highlight();
}

function performSearch(searchString) {
clearSearchTimeout();
$('#full_list, #content').addClass('insearch');
$('#noresults').text('').hide();
partialSearch(searchString, 0);
}

function partialSearch(searchString, offset) {
var lastRowClass = '';
var i = null;
for (i = offset; i < Math.min(offset + 50, searchCache.length); i++) {
var item = searchCache[i];
var searchName = (searchString.indexOf('::') != -1 ? item.fullName : item.name);
var matchString = buildMatchString(searchString);
var matchRegexp = new RegExp(matchString, caseSensitiveMatch ? "" : "i");
if (searchName.match(matchRegexp) == null) {
item.node.removeClass('found');
item.link.text(item.link.text());
}
else {
item.node.addClass('found');
item.node.removeClass(lastRowClass).addClass(lastRowClass == 'r1' ? 'r2' : 'r1');
lastRowClass = item.node.hasClass('r1') ? 'r1' : 'r2';
item.link.html(item.name.replace(matchRegexp, "<strong>$&</strong>"));
}
}
if(i == searchCache.length) {
searchDone();
} else {
searchTimeout = setTimeout(function() {
partialSearch(searchString, i);
}, 0);
}
}

function searchDone() {
searchTimeout = null;
highlight();
if ($('#full_list li:visible').size() === 0) {
$('#noresults').text('No results were found.').hide().fadeIn();
} else {
$('#noresults').text('').hide();
}
$('#content').removeClass('insearch');
}

function buildMatchString(searchString, event) {
caseSensitiveMatch = searchString.match(/[A-Z]/) != null;
var regexSearchString = RegExp.escape(searchString);
if (caseSensitiveMatch) {
regexSearchString += "|" +
$.map(searchString.split(''), function(e) { return RegExp.escape(e); }).
join('.+?');
}
return regexSearchString;
}

function highlight() {
$('#full_list li:visible').each(function(n) {
$(this).removeClass('even odd').addClass(n % 2 == 0 ? 'odd' : 'even');
});
}

/**
* Expands the tree to the target element and its immediate
* children.
*/
function expandTo(path) {
var $target = $(document.getElementById('object_' + path));
$target.addClass('clicked');
$target.removeClass('collapsed');
$target.parentsUntil('#full_list', 'li').removeClass('collapsed');
if($target[0]) {
window.scrollTo(window.scrollX, $target.offset().top - 250);
highlight();
}
}

function windowEvents(event) {
var msg = event.data;
if (msg.action === "expand") {
expandTo(msg.path);
}
return false;
}

window.addEventListener("message", windowEvents, false);

$(document).ready(function() {
escapeShortcut();
navResizer();
enableLinks();
enableToggles();
populateSearchCache();
enableSearch();
});

})();
4 changes: 4 additions & 0 deletions docs/js/jquery.js

Large diffs are not rendered by default.

67 changes: 67 additions & 0 deletions docs/method_list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8" />

<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />

<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />



<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>


<title>Ruby Method List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">Ruby Method List</h1>
<div id="full_list_nav">

<span><a target="_self" href="puppet_class_list.html">
Puppet Classes
</a></span>

<span><a target="_self" href="puppet_defined_type_list.html">
Defined Types
</a></span>

<span><a target="_self" href="method_list.html">
Ruby Methods
</a></span>

</div>

<div id="search">Search: <input type="text" /></div>
</div>

<ul id="full_list" class="method">


<li class="odd ">
<div class="item">
<span class='object_link'><a href="top-level-namespace.html#get_python_release-instance_method" title="#get_python_release (method)">#get_python_release</a></span>
<small>Top Level Namespace</small>
</div>
</li>


<li class="even ">
<div class="item">
<span class='object_link'><a href="top-level-namespace.html#get_python_version-instance_method" title="#get_python_version (method)">#get_python_version</a></span>
<small>Top Level Namespace</small>
</div>
</li>



</ul>
</div>
</body>
</html>
79 changes: 79 additions & 0 deletions docs/puppet_class_list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8" />

<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />

<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />



<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>


<title>Puppet Class List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">Puppet Class List</h1>
<div id="full_list_nav">

<span><a target="_self" href="puppet_class_list.html">
Puppet Classes
</a></span>

<span><a target="_self" href="puppet_defined_type_list.html">
Defined Types
</a></span>

<span><a target="_self" href="method_list.html">
Ruby Methods
</a></span>

</div>

<div id="search">Search: <input type="text" /></div>
</div>

<ul id="full_list" class="puppet_class">


<li id="object_puppet_classes::python" class="odd">
<div class="item">
<span class='object_link'><a href="puppet_classes/python.html" title="puppet_classes::python (puppet_class)">python</a></span>
</div>
</li>


<li id="object_puppet_classes::python::config" class="even">
<div class="item">
<span class='object_link'><a href="puppet_classes/python_3A_3Aconfig.html" title="puppet_classes::python::config (puppet_class)">python::config</a></span>
</div>
</li>


<li id="object_puppet_classes::python::install" class="odd">
<div class="item">
<span class='object_link'><a href="puppet_classes/python_3A_3Ainstall.html" title="puppet_classes::python::install (puppet_class)">python::install</a></span>
</div>
</li>


<li id="object_puppet_classes::python::params" class="even">
<div class="item">
<span class='object_link'><a href="puppet_classes/python_3A_3Aparams.html" title="puppet_classes::python::params (puppet_class)">python::params</a></span>
</div>
</li>



</ul>
</div>
</body>
</html>
472 changes: 472 additions & 0 deletions docs/puppet_classes/python.html

Large diffs are not rendered by default.

158 changes: 158 additions & 0 deletions docs/puppet_classes/python_3A_3Aconfig.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,158 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: python::config

&mdash; Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "puppet_classes::python::config";
relpath = '../';
</script>


<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (p)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">python::config</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Puppet Class: python::config</h1>
<div class="box_info">


<dl>
<dt>Defined in:</dt>
<dd>
manifests/config.pp
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">

</div>
</div>


<div class="tags">


</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">


16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/config.pp', line 16</span>

class python::config {

Class[&#39;python::install&#39;] -&gt; Python::Pip &lt;| |&gt;
Class[&#39;python::install&#39;] -&gt; Python::Requirements &lt;| |&gt;
Class[&#39;python::install&#39;] -&gt; Python::Virtualenv &lt;| |&gt;

Python::Virtualenv &lt;| |&gt; -&gt; Python::Pip &lt;| |&gt;

if $python::manage_gunicorn {
if $python::gunicorn != &#39;absent&#39; {
Class[&#39;python::install&#39;] -&gt; Python::Gunicorn &lt;| |&gt;

Python::Gunicorn &lt;| |&gt; ~&gt; Service[&#39;gunicorn&#39;]

service { &#39;gunicorn&#39;:
ensure =&gt; running,
enable =&gt; true,
hasrestart =&gt; true,
hasstatus =&gt; false,
pattern =&gt; &#39;/usr/bin/gunicorn&#39;,
}
}
}

}</pre>
</td>
</tr>
</table>
</div>
</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
656 changes: 656 additions & 0 deletions docs/puppet_classes/python_3A_3Ainstall.html

Large diffs are not rendered by default.

192 changes: 192 additions & 0 deletions docs/puppet_classes/python_3A_3Aparams.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,192 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: python::params

&mdash; Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "puppet_classes::python::params";
relpath = '../';
</script>


<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (p)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">python::params</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Puppet Class: python::params</h1>
<div class="box_info">


<dl>
<dt>Inherited by:</dt>
<dd>

<span class='object_link'><a href="python.html" title="puppet_classes::python (puppet_class)">python</a></span><br/>

</dd>
</dl>

<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>== Class: python::params</p>

<p>The python Module default configuration settings.</p>

</div>
</div>


<div class="tags">


</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 5</span>

class python::params {
$ensure = &#39;present&#39;
$version = &#39;system&#39;
$pip = &#39;present&#39;
$dev = &#39;absent&#39;
$virtualenv = &#39;absent&#39;
$gunicorn = &#39;absent&#39;
$manage_gunicorn = true
$provider = undef
$valid_versions = $::osfamily ? {
&#39;RedHat&#39; =&gt; [&#39;3&#39;,&#39;27&#39;,&#39;33&#39;],
&#39;Debian&#39; =&gt; [&#39;3&#39;, &#39;3.3&#39;, &#39;2.7&#39;],
&#39;Suse&#39; =&gt; [],
&#39;Gentoo&#39; =&gt; [&#39;2.7&#39;, &#39;3.3&#39;, &#39;3.4&#39;, &#39;3.5&#39;]
}

if $::osfamily == &#39;RedHat&#39; {
if $::operatingsystem != &#39;Fedora&#39; {
$use_epel = true
} else {
$use_epel = false
}
} else {
$use_epel = false
}

$gunicorn_package_name = $::osfamily ? {
&#39;RedHat&#39; =&gt; &#39;python-gunicorn&#39;,
default =&gt; &#39;gunicorn&#39;,
}

$rhscl_use_public_repository = true

$anaconda_installer_url = &#39;https://repo.anaconda.com/archive/Anaconda3-5.2.0-Linux-x86_64.sh&#39;
$anaconda_install_path = &#39;/opt/python&#39;
}</pre>
</td>
</tr>
</table>
</div>
</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
93 changes: 93 additions & 0 deletions docs/puppet_defined_type_list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta charset="utf-8" />

<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />

<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />



<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>


<title>Defined Type List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">Defined Type List</h1>
<div id="full_list_nav">

<span><a target="_self" href="puppet_class_list.html">
Puppet Classes
</a></span>

<span><a target="_self" href="puppet_defined_type_list.html">
Defined Types
</a></span>

<span><a target="_self" href="method_list.html">
Ruby Methods
</a></span>

</div>

<div id="search">Search: <input type="text" /></div>
</div>

<ul id="full_list" class="puppet_defined_type">


<li id="object_puppet_defined_types::python::dotfile" class="odd">
<div class="item">
<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>
</div>
</li>


<li id="object_puppet_defined_types::python::gunicorn" class="even">
<div class="item">
<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>
</div>
</li>


<li id="object_puppet_defined_types::python::pip" class="odd">
<div class="item">
<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>
</div>
</li>


<li id="object_puppet_defined_types::python::pyvenv" class="even">
<div class="item">
<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>
</div>
</li>


<li id="object_puppet_defined_types::python::requirements" class="odd">
<div class="item">
<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>
</div>
</li>


<li id="object_puppet_defined_types::python::virtualenv" class="even">
<div class="item">
<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>
</div>
</li>



</ul>
</div>
</body>
</html>
273 changes: 273 additions & 0 deletions docs/puppet_defined_types/python_3A_3Adotfile.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,273 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Defined Type: python::dotfile

&mdash; Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "puppet_defined_types::python::dotfile";
relpath = '../';
</script>


<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_defined_type_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (p)</a> &raquo;
<span class='title'><span class='object_link'>Defined Types</span></span>
&raquo;
<span class="title">python::dotfile</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Defined Type: python::dotfile</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>
manifests/dotfile.pp
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>== Define: python::dotfile</p>

<p>Manages any python dotfiles with a simple config hash.</p>

<p>=== Parameters</p>

<p>[<em>ensure</em>]
present|absent. Default: present</p>

<p>[<em>filename</em>]
Filename. Default: $title</p>

<p>[<em>mode</em>]
File mode. Default: 0644</p>

<p>[<em>owner</em>]
[<em>group</em>]
Owner/group. Default: <code>root</code>/<code>root</code></p>

<p>[<em>config</em>]
Config hash. This will be expanded to an ini-file. Default: {}</p>

<p>=== Examples</p>

<p>python::dotfile { &#39;/var/lib/jenkins/.pip/pip.conf&#39;:
ensure =&gt; present,
owner =&gt; &#39;jenkins&#39;,
group =&gt; &#39;jenkins&#39;,
config =&gt; {
&#39;global&#39; =&gt; {
&#39;index-url =&gt; &#39;<a href="https://mypypi.acme.com/simple/">https://mypypi.acme.com/simple/</a>&#39;
&#39;extra-index-url =&gt; <a href="https://pypi.risedev.at/simple/">https://pypi.risedev.at/simple/</a>
}
}
}</p>

</div>
</div>


<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>ensure</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>


</li>

<li>

<span class='name'>filename</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>$title</tt>)</em>


</li>

<li>

<span class='name'>owner</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>


</li>

<li>

<span class='name'>group</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>


</li>

<li>

<span class='name'>mode</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;0644&#39;</tt>)</em>


</li>

<li>

<span class='name'>config</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>{}</tt>)</em>


</li>

</ul>


</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/dotfile.pp', line 38</span>

define python::dotfile (
$ensure = &#39;present&#39;,
$filename = $title,
$owner = &#39;root&#39;,
$group = &#39;root&#39;,
$mode = &#39;0644&#39;,
$config = {},
) {
$parent_dir = dirname($filename)

exec { &quot;create ${title}&#39;s parent dir&quot;:
command =&gt; &quot;install -o ${owner} -g ${group} -d ${parent_dir}&quot;,
path =&gt; [ &#39;/usr/bin&#39;, &#39;/bin&#39;, &#39;/usr/local/bin&#39;, ],
creates =&gt; $parent_dir,
}

file { $filename:
ensure =&gt; $ensure,
owner =&gt; $owner,
group =&gt; $group,
mode =&gt; $mode,
content =&gt; template(&quot;${module_name}/inifile.erb&quot;),
require =&gt; Exec[&quot;create ${title}&#39;s parent dir&quot;],
}
}</pre>
</td>
</tr>
</table>
</div>
</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
557 changes: 557 additions & 0 deletions docs/puppet_defined_types/python_3A_3Agunicorn.html

Large diffs are not rendered by default.

891 changes: 891 additions & 0 deletions docs/puppet_defined_types/python_3A_3Apip.html

Large diffs are not rendered by default.

365 changes: 365 additions & 0 deletions docs/puppet_defined_types/python_3A_3Apyvenv.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,365 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Defined Type: python::pyvenv

&mdash; Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "puppet_defined_types::python::pyvenv";
relpath = '../';
</script>


<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_defined_type_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="../_index.html">Index (p)</a> &raquo;
<span class='title'><span class='object_link'>Defined Types</span></span>
&raquo;
<span class="title">python::pyvenv</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Defined Type: python::pyvenv</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>
manifests/pyvenv.pp
</dd>
</dl>
</div>

<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>[<em>environment</em>]
Optionally specify environment variables for pyvenv</p>

<p>=== Examples</p>

<p>python::venv { &#39;/var/www/project1&#39;:
ensure =&gt; present,
version =&gt; &#39;system&#39;,
systempkgs =&gt; true,
}</p>

<p>=== Authors</p>

<p>Sergey Stankevich
Ashley Penney
Marc Fournier
Fotis Gimian
Seth Cleveland</p>

</div>
</div>


<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>ensure</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>present</tt>)</em>


</li>

<li>

<span class='name'>version</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;system&#39;</tt>)</em>


</li>

<li>

<span class='name'>systempkgs</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>false</tt>)</em>


</li>

<li>

<span class='name'>venv_dir</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>$name</tt>)</em>


</li>

<li>

<span class='name'>owner</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>


</li>

<li>

<span class='name'>group</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;root&#39;</tt>)</em>


</li>

<li>

<span class='name'>mode</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>&#39;0755&#39;</tt>)</em>


</li>

<li>

<span class='name'>path</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>[ &#39;/bin&#39;, &#39;/usr/bin&#39;, &#39;/usr/sbin&#39;, &#39;/usr/local/bin&#39; ]</tt>)</em>


</li>

<li>

<span class='name'>environment</span>


<span class='type'>(<tt>Any</tt>)</span>


<em class="default">(defaults to: <tt>[]</tt>)</em>


</li>

</ul>


</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/pyvenv.pp', line 50</span>

define python::pyvenv (
$ensure = present,
$version = &#39;system&#39;,
$systempkgs = false,
$venv_dir = $name,
$owner = &#39;root&#39;,
$group = &#39;root&#39;,
$mode = &#39;0755&#39;,
$path = [ &#39;/bin&#39;, &#39;/usr/bin&#39;, &#39;/usr/sbin&#39;, &#39;/usr/local/bin&#39; ],
$environment = [],
) {

include ::python

if $ensure == &#39;present&#39; {

$virtualenv_cmd = $version ? {
&#39;system&#39; =&gt; &quot;${python::exec_prefix}pyvenv&quot;,
default =&gt; &quot;${python::exec_prefix}pyvenv-${version}&quot;,
}

$_path = $::python::provider ? {
&#39;anaconda&#39; =&gt; concat([&quot;${::python::anaconda_install_path}/bin&quot;], $path),
default =&gt; $path,
}

if ( $systempkgs == true ) {
$system_pkgs_flag = &#39;--system-site-packages&#39;
} else {
$system_pkgs_flag = &#39;&#39;
}

file { $venv_dir:
ensure =&gt; directory,
owner =&gt; $owner,
group =&gt; $group,
mode =&gt; $mode,
}

exec { &quot;python_virtualenv_${venv_dir}&quot;:
command =&gt; &quot;${virtualenv_cmd} --clear ${system_pkgs_flag} ${venv_dir}&quot;,
user =&gt; $owner,
creates =&gt; &quot;${venv_dir}/bin/activate&quot;,
path =&gt; $_path,
cwd =&gt; &#39;/tmp&#39;,
environment =&gt; $environment,
unless =&gt; &quot;grep &#39;^[\\t ]*VIRTUAL_ENV=[\\\\&#39;\\\&quot;]*${venv_dir}[\\\&quot;\\\\&#39;][\\t ]*$&#39; ${venv_dir}/bin/activate&quot;, #Unless activate exists and VIRTUAL_ENV is correct we re-create the virtualenv
require =&gt; File[$venv_dir],
}
} elsif $ensure == &#39;absent&#39; {
file { $venv_dir:
ensure =&gt; absent,
force =&gt; true,
recurse =&gt; true,
purge =&gt; true,
}
} else {
fail( &quot;Illegal ensure value: ${ensure}. Expected (present or absent)&quot;)
}
}</pre>
</td>
</tr>
</table>
</div>
</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
533 changes: 533 additions & 0 deletions docs/puppet_defined_types/python_3A_3Arequirements.html

Large diffs are not rendered by default.

723 changes: 723 additions & 0 deletions docs/puppet_defined_types/python_3A_3Avirtualenv.html

Large diffs are not rendered by default.

253 changes: 253 additions & 0 deletions docs/top-level-namespace.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,253 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Top Level Namespace

&mdash; Documentation by YARD 0.9.16

</title>

<link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />

<link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />

<script type="text/javascript" charset="utf-8">
pathId = "";
relpath = '';
</script>


<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>

<script type="text/javascript" charset="utf-8" src="js/app.js"></script>


</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>

<div id="main" tabindex="-1">
<div id="header">
<div id="menu">

<a href="_index.html">Index</a> &raquo;


<span class="title">Top Level Namespace</span>

</div>

<div id="search">

<a class="full_list_link" id="puppet_class_list_link"
href="puppet_class_list.html">

<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>

</div>
<div class="clear"></div>
</div>

<div id="content"><h1>Top Level Namespace



</h1>
<div class="box_info">











</div>









<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>

<ul class="summary">

<li class="public ">
<span class="summary_signature">

<a href="top-level-namespace.html#get_python_release-instance_method" title="#get_python_release (instance method)">#<strong>get_python_release</strong>(executable) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'><p>Make python release available as facts.</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="top-level-namespace.html#get_python_version-instance_method" title="#get_python_version (instance method)">#<strong>get_python_version</strong>(executable) &#x21d2; Object </a>



</span>









<span class="summary_desc"><div class='inline'><p>Make python versions available as facts.</p>
</div></span>

</li>


</ul>




<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>


<div class="method_details first">
<h3 class="signature first" id="get_python_release-instance_method">

#<strong>get_python_release</strong>(executable) &#x21d2; <tt>Object</tt>





</h3><div class="docstring">
<div class="discussion">
<p>Make python release available as facts</p>


</div>
</div>
<div class="tags">


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


3
4
5
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/facter/python_release.rb', line 3</span>

<span class='kw'>def</span> <span class='id identifier rubyid_get_python_release'>get_python_release</span><span class='lparen'>(</span><span class='id identifier rubyid_executable'>executable</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'>Facter</span><span class='op'>::</span><span class='const'>Util</span><span class='op'>::</span><span class='const'>Resolution</span><span class='period'>.</span><span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='id identifier rubyid_executable'>executable</span><span class='rparen'>)</span> <span class='comment'># rubocop:disable Style/GuardClause
</span> <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>Facter</span><span class='op'>::</span><span class='const'>Util</span><span class='op'>::</span><span class='const'>Resolution</span><span class='period'>.</span><span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_executable'>executable</span><span class='embexpr_end'>}</span><span class='tstring_content'> -V 2&gt;&amp;1</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^.*(\d+\.\d+)\.\d+\+?$</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_results'>results</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="get_python_version-instance_method">

#<strong>get_python_version</strong>(executable) &#x21d2; <tt>Object</tt>





</h3><div class="docstring">
<div class="discussion">
<p>Make python versions available as facts</p>


</div>
</div>
<div class="tags">


</div><table class="source_code">
<tr>
<td>
<pre class="lines">


3
4
5
6
7
8</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/facter/python_version.rb', line 3</span>

<span class='kw'>def</span> <span class='id identifier rubyid_get_python_version'>get_python_version</span><span class='lparen'>(</span><span class='id identifier rubyid_executable'>executable</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='const'>Facter</span><span class='op'>::</span><span class='const'>Util</span><span class='op'>::</span><span class='const'>Resolution</span><span class='period'>.</span><span class='id identifier rubyid_which'>which</span><span class='lparen'>(</span><span class='id identifier rubyid_executable'>executable</span><span class='rparen'>)</span> <span class='comment'># rubocop:disable Style/GuardClause
</span> <span class='id identifier rubyid_results'>results</span> <span class='op'>=</span> <span class='const'>Facter</span><span class='op'>::</span><span class='const'>Util</span><span class='op'>::</span><span class='const'>Resolution</span><span class='period'>.</span><span class='id identifier rubyid_exec'>exec</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_executable'>executable</span><span class='embexpr_end'>}</span><span class='tstring_content'> -V 2&gt;&amp;1</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_match'>match</span><span class='lparen'>(</span><span class='tstring'><span class='regexp_beg'>%r{</span><span class='tstring_content'>^.*(\d+\.\d+\.\d+\+?)$</span><span class='regexp_end'>}</span></span><span class='rparen'>)</span>
<span class='id identifier rubyid_results'>results</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span> <span class='kw'>if</span> <span class='id identifier rubyid_results'>results</span>
<span class='kw'>end</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>

</div>

</div>

<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>

</div>
</body>
</html>
4 changes: 2 additions & 2 deletions manifests/pip.pp
Original file line number Diff line number Diff line change
@@ -4,10 +4,10 @@
#
# === Parameters
#
# [*name]
# [*name*]
# must be unique
#
# [*pkgname]
# [*pkgname*]
# name of the package. If pkgname is not specified, use name (title) instead.
#
# [*ensure*]

0 comments on commit a94560d

Please sign in to comment.