Skip to content

Commit 12ae1d4

Browse files
committed
DOC: update development documentation 07bdfc6
0 parents  commit 12ae1d4

File tree

3,526 files changed

+746097
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

3,526 files changed

+746097
-0
lines changed

.nojekyll

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
visualization.fluent.docs.pyansys.com

dev/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 89d95b3bcb21d5a0eaf6d521890ec557
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

dev/.nojekyll

Whitespace-only changes.

dev/404.html

Lines changed: 351 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,351 @@
1+
2+
<!DOCTYPE html>
3+
4+
<html lang="en">
5+
<head>
6+
<meta charset="utf-8" />
7+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8+
<title>Page not found &#8212; PyFluent-Visualization</title>
9+
10+
<script>
11+
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
12+
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light"
13+
</script>
14+
15+
<!-- Loaded before other Sphinx assets -->
16+
<link href="/en/latest/_static/styles/theme.css?digest=92025949c220c2e29695" rel="stylesheet">
17+
<link href="/en/latest/_static/styles/pydata-sphinx-theme.css?digest=92025949c220c2e29695" rel="stylesheet">
18+
19+
20+
<link rel="stylesheet"
21+
href="/en/latest/_static/vendor/fontawesome/5.13.0/css/all.min.css">
22+
<link rel="preload" as="font" type="font/woff2" crossorigin
23+
href="/en/latest/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2">
24+
<link rel="preload" as="font" type="font/woff2" crossorigin
25+
href="/en/latest/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2">
26+
27+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/pygments.css" />
28+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/jupyter-sphinx.css" />
29+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/thebelab.css" />
30+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/copybutton.css" />
31+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/css/ansys_sphinx_theme.css" />
32+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery.css" />
33+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-binder.css" />
34+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-dataframe.css" />
35+
<link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-rendered-html.css" />
36+
37+
<!-- Pre-loaded scripts that we'll load fully later -->
38+
<link rel="preload" as="script" href="/en/latest/_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695">
39+
40+
41+
<link href="/en/latest/_static/css/breadcrumbs.css" rel="stylesheet">
42+
43+
<script data-url_root="#" id="documentation_options" src="/en/latest/_static/documentation_options.js"></script>
44+
<script src="/en/latest/_static/jquery.js"></script>
45+
<script src="/en/latest/_static/underscore.js"></script>
46+
<script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js"></script>
47+
<script src="/en/latest/_static/doctools.js"></script>
48+
<script src="/en/latest/_static/sphinx_highlight.js"></script>
49+
<script src="/en/latest/_static/thebelab-helper.js"></script>
50+
<script src="/en/latest/_static/clipboard.min.js"></script>
51+
<script src="/en/latest/_static/copybutton.js"></script>
52+
<script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
53+
<script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script>
54+
<link rel="shortcut icon" href="/en/latest/_static/ansys-favicon.png"/>
55+
<link rel="index" title="Index" href="/en/latest/genindex.html" />
56+
<link rel="search" title="Search" href="/en/latest/search.html" />
57+
<meta name="viewport" content="width=device-width, initial-scale=1" />
58+
<meta name="docsearch:language" content="en">
59+
</head>
60+
61+
62+
<body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode="">
63+
<div class="bd-header-announcement container-fluid" id="banner">
64+
65+
66+
</div>
67+
68+
69+
70+
<nav class="bd-header navbar navbar-light navbar-expand-lg bg-light fixed-top bd-navbar" id="navbar-main"><div class="bd-header__inner container-xl">
71+
72+
<div id="navbar-start">
73+
74+
75+
76+
77+
78+
<a class="navbar-brand logo" href="/en/latest/index.html">
79+
80+
81+
82+
83+
<img src="/en/latest/_static/pyansys-logo-black-cropped.png" class="logo__image only-light" alt="Logo image">
84+
<img src="/en/latest/_static/pyansys-logo-black-cropped.png" class="logo__image only-dark" alt="Logo image">
85+
86+
87+
</a>
88+
89+
</div>
90+
91+
<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation">
92+
<span class="fas fa-bars"></span>
93+
</button>
94+
95+
96+
<div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse">
97+
<div id="navbar-center" class="mr-auto">
98+
99+
<div class="navbar-center-item">
100+
<ul id="navbar-main-elements" class="navbar-nav">
101+
<li class="toctree-l1 nav-item">
102+
<a class="reference internal nav-link" href="/en/latest/getting_started/index.html">
103+
Getting started
104+
</a>
105+
</li>
106+
107+
<li class="toctree-l1 nav-item">
108+
<a class="reference internal nav-link" href="/en/latest/users_guide/index.html">
109+
User guide
110+
</a>
111+
</li>
112+
113+
<li class="toctree-l1 nav-item">
114+
<a class="reference internal nav-link" href="/en/latest/api/index.html">
115+
API reference
116+
</a>
117+
</li>
118+
119+
<li class="toctree-l1 nav-item">
120+
<a class="reference internal nav-link" href="/en/latest/examples/index.html">
121+
Examples
122+
</a>
123+
</li>
124+
125+
<li class="toctree-l1 nav-item">
126+
<a class="reference internal nav-link" href="/en/latest/contributing.html">
127+
Contribute
128+
</a>
129+
</li>
130+
131+
132+
</ul>
133+
</div>
134+
135+
</div>
136+
137+
<div id="navbar-end">
138+
139+
<div class="navbar-end-item">
140+
<div class="dropdown" id="version_switcher">
141+
<button type="button" class="btn btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown">
142+
dev <!-- this text may get changed later by javascript -->
143+
<span class="caret"></span>
144+
</button>
145+
<div id="version_switcher_menu" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button">
146+
<!-- dropdown will be populated by javascript on page load -->
147+
</div>
148+
</div>
149+
150+
<!-- NOTE: this JS must live here (not in our global JS file) because it relies
151+
on being processed by Jinja before it is run (specifically for replacing
152+
variables 404 and {'json_url': 'https://visualization.fluent.docs.pyansys.com/release/versions.json', 'version_match': 'dev'}.
153+
-->
154+
155+
<script type="text/javascript">
156+
// Check if corresponding page path exists in other version of docs
157+
// and, if so, go there instead of the homepage of the other docs version
158+
function checkPageExistsAndRedirect(event) {
159+
const currentFilePath = "404.html",
160+
tryUrl = event.target.getAttribute("href");
161+
let otherDocsHomepage = tryUrl.replace(currentFilePath, "");
162+
$.ajax({
163+
type: 'HEAD',
164+
url: tryUrl,
165+
// if the page exists, go there
166+
success: function() {
167+
location.href = tryUrl;
168+
}
169+
}).fail(function() {
170+
location.href = otherDocsHomepage;
171+
});
172+
// this prevents the browser from following the href of the clicked node
173+
// (which is fine because this function takes care of redirecting)
174+
return false;
175+
}
176+
177+
// Populate the version switcher from the JSON config file
178+
(function () {
179+
$.getJSON("https://visualization.fluent.docs.pyansys.com/release/versions.json", function(data, textStatus, jqXHR) {
180+
const currentFilePath = "404.html";
181+
let btn = document.getElementById("version_switcher_button");
182+
// Set empty strings by default so that these attributes exist and can be used in CSS selectors
183+
btn.dataset["activeVersionName"] = "";
184+
btn.dataset["activeVersion"] = "";
185+
// create links to the corresponding page in the other docs versions
186+
$.each(data, function(index, entry) {
187+
// if no custom name specified (e.g., "latest"), use version string
188+
if (!("name" in entry)) {
189+
entry.name = entry.version;
190+
}
191+
// create the node
192+
const node = document.createElement("a");
193+
node.setAttribute("class", "list-group-item list-group-item-action py-1");
194+
node.textContent = `${entry.name}`;
195+
node.setAttribute("href", `${entry.url}${currentFilePath}`);
196+
// on click, AJAX calls will check if the linked page exists before
197+
// trying to redirect, and if not, will redirect to the homepage
198+
// for that version of the docs.
199+
node.onclick = checkPageExistsAndRedirect;
200+
// Add dataset values for the version and name in case people want
201+
// to apply CSS styling based on this information.
202+
node.dataset["versionName"] = entry.name;
203+
node.dataset["version"] = entry.version;
204+
205+
$("#version_switcher_menu").append(node);
206+
// replace dropdown button text with the preferred display name of
207+
// this version, rather than using sphinx's 0.8.dev0 variable.
208+
// also highlight the dropdown entry for the currently-viewed
209+
// version's entry
210+
if (entry.version == "dev") {
211+
node.classList.add("active");
212+
btn.innerText = btn.dataset["activeVersionName"] = entry.name;
213+
btn.dataset["activeVersion"] = entry.version;
214+
}
215+
});
216+
});
217+
})();
218+
</script>
219+
</div>
220+
221+
<div class="navbar-end-item">
222+
<span id="theme-switch" class="btn btn-sm btn-outline-primary navbar-btn rounded-circle">
223+
<a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a>
224+
<a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a>
225+
<a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a>
226+
</span>
227+
</div>
228+
229+
<div class="navbar-end-item">
230+
<ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links">
231+
<li class="nav-item">
232+
<a class="nav-link" href="https://github.com/pyansys/pyfluent-visualization" rel="noopener" target="_blank" title="GitHub"><span><i class="fab fa-github-square"></i></span>
233+
<label class="sr-only">GitHub</label></a>
234+
</li>
235+
</ul>
236+
</div>
237+
238+
</div>
239+
</div>
240+
</div>
241+
</nav>
242+
243+
244+
<div id="announcement_msg"></div>
245+
<script>
246+
fetch("announcement.html")
247+
.then((response) => {
248+
if (!response.ok) {
249+
throw new Error(`HTTP error: ${response.status}`);
250+
}
251+
return response.text();
252+
})
253+
.then(text => document.getElementById("announcement_msg").innerHTML = text)
254+
.catch((error) => console.error(`Fetch problem: ${error.message}`));
255+
</script>
256+
257+
258+
<div class="container-xl">
259+
<div class="row">
260+
<div class="col-12 col-md-3" id="breadcrumbs-spacer"></div>
261+
<div class="col-12 col-md-11 col-xl-9" id="breadcrumbs">
262+
263+
<div class="related" role="navigation" aria-label="related navigation">
264+
<h3>Navigation</h3>
265+
<ul>
266+
267+
<li class="nav-item nav-item-additional-breadcrumb"><a href="https://docs.pyansys.com/">PyAnsys</a> » </li>
268+
269+
270+
<li class="nav-item nav-item-0"><a href="/en/latest/index.html">PyFluent-Visualization</a> » </li>
271+
272+
273+
<li class="nav-item nav-item-this"><a href="">Page not found</a></li>
274+
</ul>
275+
</div>
276+
</div>
277+
</div>
278+
</div>
279+
280+
281+
282+
<div class="bd-container container-xl">
283+
<div class="bd-container__inner row">
284+
285+
286+
<!-- Only show if we have sidebars configured, else just a small margin -->
287+
<div class="bd-sidebar-primary col-12 col-md-3 bd-sidebar">
288+
<div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="/en/latest/search.html" method="get">
289+
<i class="icon fas fa-search"></i>
290+
<input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" >
291+
</form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation">
292+
<div class="bd-toc-item active">
293+
294+
</div>
295+
</nav>
296+
</div>
297+
<div class="sidebar-end-items">
298+
</div>
299+
</div>
300+
301+
302+
303+
304+
305+
<div class="bd-sidebar-secondary d-none d-xl-block col-xl-2 bd-toc">
306+
307+
</div>
308+
309+
310+
311+
312+
<div class="bd-content col-12 col-md-9 col-xl-7">
313+
314+
<article class="bd-article" role="main">
315+
316+
<h1>Page not found</h1>
317+
318+
Unfortunately we couldn't find the content you were looking for.
319+
320+
</article>
321+
322+
323+
324+
</div>
325+
326+
</div>
327+
</div>
328+
329+
330+
331+
<!-- Scripts loaded after <body> so the DOM is not blocked -->
332+
<script src="/en/latest/_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695"></script>
333+
334+
<footer class="bd-footer"><div class="bd-footer__inner container">
335+
336+
<div class="footer-item">
337+
<p class="copyright">
338+
&copy; Copyright (c) 2023 ANSYS, Inc. All rights reserved.<br>
339+
</p>
340+
</div>
341+
342+
<div class="footer-item">
343+
<p class="sphinx-version">
344+
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br>
345+
</p>
346+
</div>
347+
348+
</div>
349+
</footer>
350+
</body>
351+
</html>

dev/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+

0 commit comments

Comments
 (0)