Skip to content

Commit 73d7c7d

Browse files
authored
Strip broken icon in python docs (#8801)
Sphinx is now emitting a private unicode character ("\F0C1") corresponding to a FontAwesome chain icon next to headers, which renders as an empty box on our site. Strip this character out of the generated docs in the same way we stripped the character sphinx used to use.
1 parent 9dc4e1f commit 73d7c7d

File tree

27 files changed

+14232
-591
lines changed

27 files changed

+14232
-591
lines changed

content/docs/reference/pkg/python/pulumi/_index.md

+159-159
Large diffs are not rendered by default.

content/docs/reference/pkg/python/pulumi_policy/_index.md

+107-107
Large diffs are not rendered by default.

content/docs/reference/pkg/python/pulumi_terraform/_index.md

+25-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ notitle: true
88
{{< resource-docs-alert "terraform" >}}
99

1010
<section id="pulumi-terraform">
11-
<h1>Pulumi Terraform<a class="headerlink" href="#pulumi-terraform" title="Permalink to this headline"></a></h1>
11+
<h1>Pulumi Terraform<a class="headerlink" href="#pulumi-terraform" title="Permalink to this heading"></a></h1>
1212
<blockquote>
1313
<div><p>This provider is a derived work of the <a class="reference external" href="https://github.com/terraform-providers/terraform-provider-terraform">Terraform Provider</a> distributed under
1414
<a class="reference external" href="https://www.mozilla.org/en-US/MPL/2.0/">MPL 2.0</a>. If you encounter a bug or missing feature, first check the
@@ -17,7 +17,30 @@ anything, please consult the source <a class="reference external" href="https://
1717
</div></blockquote>
1818
<div class="toctree-wrapper compound">
1919
<ul>
20-
<li class="toctree-l1"><a class="reference internal" href="state/">state</a></li>
20+
<li class="toctree-l1"><a class="reference internal" href="state/">state</a><ul>
21+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.ArtifactoryBackendArgs"><code class="docutils literal notranslate"><span class="pre">ArtifactoryBackendArgs</span></code></a></li>
22+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.AzureRMBackendArgs"><code class="docutils literal notranslate"><span class="pre">AzureRMBackendArgs</span></code></a></li>
23+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.ConsulBackendArgs"><code class="docutils literal notranslate"><span class="pre">ConsulBackendArgs</span></code></a></li>
24+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.EtcdV2BackendArgs"><code class="docutils literal notranslate"><span class="pre">EtcdV2BackendArgs</span></code></a></li>
25+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.EtcdV3BackendArgs"><code class="docutils literal notranslate"><span class="pre">EtcdV3BackendArgs</span></code></a></li>
26+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.GcsBackendArgs"><code class="docutils literal notranslate"><span class="pre">GcsBackendArgs</span></code></a></li>
27+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.HttpBackendArgs"><code class="docutils literal notranslate"><span class="pre">HttpBackendArgs</span></code></a></li>
28+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.LocalBackendArgs"><code class="docutils literal notranslate"><span class="pre">LocalBackendArgs</span></code></a></li>
29+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.MantaBackendArgs"><code class="docutils literal notranslate"><span class="pre">MantaBackendArgs</span></code></a></li>
30+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.OssBackendArgs"><code class="docutils literal notranslate"><span class="pre">OssBackendArgs</span></code></a></li>
31+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.PostgresBackendArgs"><code class="docutils literal notranslate"><span class="pre">PostgresBackendArgs</span></code></a></li>
32+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteBackendArgs"><code class="docutils literal notranslate"><span class="pre">RemoteBackendArgs</span></code></a></li>
33+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteStateReference"><code class="docutils literal notranslate"><span class="pre">RemoteStateReference</span></code></a><ul>
34+
<li class="toctree-l3"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteStateReference.outputs"><code class="docutils literal notranslate"><span class="pre">RemoteStateReference.outputs</span></code></a></li>
35+
<li class="toctree-l3"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteStateReference.get_output"><code class="docutils literal notranslate"><span class="pre">RemoteStateReference.get_output()</span></code></a></li>
36+
<li class="toctree-l3"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteStateReference.translate_output_property"><code class="docutils literal notranslate"><span class="pre">RemoteStateReference.translate_output_property()</span></code></a></li>
37+
<li class="toctree-l3"><a class="reference internal" href="state/#pulumi_terraform.state.RemoteStateReference.translate_input_property"><code class="docutils literal notranslate"><span class="pre">RemoteStateReference.translate_input_property()</span></code></a></li>
38+
</ul>
39+
</li>
40+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.S3BackendArgs"><code class="docutils literal notranslate"><span class="pre">S3BackendArgs</span></code></a></li>
41+
<li class="toctree-l2"><a class="reference internal" href="state/#pulumi_terraform.state.SwiftBackendArgs"><code class="docutils literal notranslate"><span class="pre">SwiftBackendArgs</span></code></a></li>
42+
</ul>
43+
</li>
2144
</ul>
2245
</div>
2346
</section>

content/docs/reference/pkg/python/pulumi_terraform/state/_index.md

+67-67
Large diffs are not rendered by default.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
11
.. toctree::
22
providers/pulumi
3+
4+
providers/pulumi_policy
5+
6+
providers/pulumi_terraform
37

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
/*
2+
* _sphinx_javascript_frameworks_compat.js
3+
* ~~~~~~~~~~
4+
*
5+
* Compatability shim for jQuery and underscores.js.
6+
*
7+
* WILL BE REMOVED IN Sphinx 6.0
8+
* xref RemovedInSphinx60Warning
9+
*
10+
*/
11+
12+
/**
13+
* select a different prefix for underscore
14+
*/
15+
$u = _.noConflict();
16+
17+
18+
/**
19+
* small helper function to urldecode strings
20+
*
21+
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
22+
*/
23+
jQuery.urldecode = function(x) {
24+
if (!x) {
25+
return x
26+
}
27+
return decodeURIComponent(x.replace(/\+/g, ' '));
28+
};
29+
30+
/**
31+
* small helper function to urlencode strings
32+
*/
33+
jQuery.urlencode = encodeURIComponent;
34+
35+
/**
36+
* This function returns the parsed url parameters of the
37+
* current request. Multiple values per key are supported,
38+
* it will always return arrays of strings for the value parts.
39+
*/
40+
jQuery.getQueryParameters = function(s) {
41+
if (typeof s === 'undefined')
42+
s = document.location.search;
43+
var parts = s.substr(s.indexOf('?') + 1).split('&');
44+
var result = {};
45+
for (var i = 0; i < parts.length; i++) {
46+
var tmp = parts[i].split('=', 2);
47+
var key = jQuery.urldecode(tmp[0]);
48+
var value = jQuery.urldecode(tmp[1]);
49+
if (key in result)
50+
result[key].push(value);
51+
else
52+
result[key] = [value];
53+
}
54+
return result;
55+
};
56+
57+
/**
58+
* highlight a given string on a jquery object by wrapping it in
59+
* span elements with the given class name.
60+
*/
61+
jQuery.fn.highlightText = function(text, className) {
62+
function highlight(node, addItems) {
63+
if (node.nodeType === 3) {
64+
var val = node.nodeValue;
65+
var pos = val.toLowerCase().indexOf(text);
66+
if (pos >= 0 &&
67+
!jQuery(node.parentNode).hasClass(className) &&
68+
!jQuery(node.parentNode).hasClass("nohighlight")) {
69+
var span;
70+
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
71+
if (isInSVG) {
72+
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
73+
} else {
74+
span = document.createElement("span");
75+
span.className = className;
76+
}
77+
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
78+
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
79+
document.createTextNode(val.substr(pos + text.length)),
80+
node.nextSibling));
81+
node.nodeValue = val.substr(0, pos);
82+
if (isInSVG) {
83+
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
84+
var bbox = node.parentElement.getBBox();
85+
rect.x.baseVal.value = bbox.x;
86+
rect.y.baseVal.value = bbox.y;
87+
rect.width.baseVal.value = bbox.width;
88+
rect.height.baseVal.value = bbox.height;
89+
rect.setAttribute('class', className);
90+
addItems.push({
91+
"parent": node.parentNode,
92+
"target": rect});
93+
}
94+
}
95+
}
96+
else if (!jQuery(node).is("button, select, textarea")) {
97+
jQuery.each(node.childNodes, function() {
98+
highlight(this, addItems);
99+
});
100+
}
101+
}
102+
var addItems = [];
103+
var result = this.each(function() {
104+
highlight(this, addItems);
105+
});
106+
for (var i = 0; i < addItems.length; ++i) {
107+
jQuery(addItems[i].parent).before(addItems[i].target);
108+
}
109+
return result;
110+
};
111+
112+
/*
113+
* backward compatibility for jQuery.browser
114+
* This will be supported until firefox bug is fixed.
115+
*/
116+
if (!jQuery.browser) {
117+
jQuery.uaMatch = function(ua) {
118+
ua = ua.toLowerCase();
119+
120+
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
121+
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
122+
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
123+
/(msie) ([\w.]+)/.exec(ua) ||
124+
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
125+
[];
126+
127+
return {
128+
browser: match[ 1 ] || "",
129+
version: match[ 2 ] || "0"
130+
};
131+
};
132+
jQuery.browser = {};
133+
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
134+
}

0 commit comments

Comments
 (0)