-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: update development documentation ec8df87
- Loading branch information
0 parents
commit 1f368d9
Showing
1,438 changed files
with
401,952 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| visualization.fluent.docs.pyansys.com |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| # Sphinx build info version 1 | ||
| # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. | ||
| config: 89d95b3bcb21d5a0eaf6d521890ec557 | ||
| tags: 645f666f9bcd5a90fca523b33c5a78b7 |
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,351 @@ | ||
|
|
||
| <!DOCTYPE html> | ||
|
|
||
| <html lang="en"> | ||
| <head> | ||
| <meta charset="utf-8" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1.0" /> | ||
| <title>Page not found — PyFluent-Visualization</title> | ||
|
|
||
| <script> | ||
| document.documentElement.dataset.mode = localStorage.getItem("mode") || ""; | ||
| document.documentElement.dataset.theme = localStorage.getItem("theme") || "light" | ||
| </script> | ||
|
|
||
| <!-- Loaded before other Sphinx assets --> | ||
| <link href="/en/latest/_static/styles/theme.css?digest=92025949c220c2e29695" rel="stylesheet"> | ||
| <link href="/en/latest/_static/styles/pydata-sphinx-theme.css?digest=92025949c220c2e29695" rel="stylesheet"> | ||
|
|
||
|
|
||
| <link rel="stylesheet" | ||
| href="/en/latest/_static/vendor/fontawesome/5.13.0/css/all.min.css"> | ||
| <link rel="preload" as="font" type="font/woff2" crossorigin | ||
| href="/en/latest/_static/vendor/fontawesome/5.13.0/webfonts/fa-solid-900.woff2"> | ||
| <link rel="preload" as="font" type="font/woff2" crossorigin | ||
| href="/en/latest/_static/vendor/fontawesome/5.13.0/webfonts/fa-brands-400.woff2"> | ||
|
|
||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/pygments.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/jupyter-sphinx.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/thebelab.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/copybutton.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/css/ansys_sphinx_theme.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-binder.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-dataframe.css" /> | ||
| <link rel="stylesheet" type="text/css" href="/en/latest/_static/sg_gallery-rendered-html.css" /> | ||
|
|
||
| <!-- Pre-loaded scripts that we'll load fully later --> | ||
| <link rel="preload" as="script" href="/en/latest/_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695"> | ||
|
|
||
|
|
||
| <link href="/en/latest/_static/css/breadcrumbs.css" rel="stylesheet"> | ||
|
|
||
| <script data-url_root="#" id="documentation_options" src="/en/latest/_static/documentation_options.js"></script> | ||
| <script src="/en/latest/_static/jquery.js"></script> | ||
| <script src="/en/latest/_static/underscore.js"></script> | ||
| <script src="/en/latest/_static/_sphinx_javascript_frameworks_compat.js"></script> | ||
| <script src="/en/latest/_static/doctools.js"></script> | ||
| <script src="/en/latest/_static/sphinx_highlight.js"></script> | ||
| <script src="/en/latest/_static/thebelab-helper.js"></script> | ||
| <script src="/en/latest/_static/clipboard.min.js"></script> | ||
| <script src="/en/latest/_static/copybutton.js"></script> | ||
| <script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script> | ||
| <script src="https://cdn.jsdelivr.net/npm/@jupyter-widgets/html-manager@^1.0.1/dist/embed-amd.js"></script> | ||
| <link rel="shortcut icon" href="/en/latest/_static/ansys-favicon.png"/> | ||
| <link rel="index" title="Index" href="/en/latest/genindex.html" /> | ||
| <link rel="search" title="Search" href="/en/latest/search.html" /> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1" /> | ||
| <meta name="docsearch:language" content="en"> | ||
| </head> | ||
|
|
||
|
|
||
| <body data-spy="scroll" data-target="#bd-toc-nav" data-offset="180" data-default-mode=""> | ||
| <div class="bd-header-announcement container-fluid" id="banner"> | ||
|
|
||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <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"> | ||
|
|
||
| <div id="navbar-start"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <a class="navbar-brand logo" href="/en/latest/index.html"> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <img src="/en/latest/_static/pyansys-logo-black-cropped.png" class="logo__image only-light" alt="Logo image"> | ||
| <img src="/en/latest/_static/pyansys-logo-black-cropped.png" class="logo__image only-dark" alt="Logo image"> | ||
|
|
||
|
|
||
| </a> | ||
|
|
||
| </div> | ||
|
|
||
| <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbar-collapsible" aria-controls="navbar-collapsible" aria-expanded="false" aria-label="Toggle navigation"> | ||
| <span class="fas fa-bars"></span> | ||
| </button> | ||
|
|
||
|
|
||
| <div id="navbar-collapsible" class="col-lg-9 collapse navbar-collapse"> | ||
| <div id="navbar-center" class="mr-auto"> | ||
|
|
||
| <div class="navbar-center-item"> | ||
| <ul id="navbar-main-elements" class="navbar-nav"> | ||
| <li class="toctree-l1 nav-item"> | ||
| <a class="reference internal nav-link" href="/en/latest/getting_started/index.html"> | ||
| Getting started | ||
| </a> | ||
| </li> | ||
|
|
||
| <li class="toctree-l1 nav-item"> | ||
| <a class="reference internal nav-link" href="/en/latest/users_guide/index.html"> | ||
| User guide | ||
| </a> | ||
| </li> | ||
|
|
||
| <li class="toctree-l1 nav-item"> | ||
| <a class="reference internal nav-link" href="/en/latest/api/index.html"> | ||
| API reference | ||
| </a> | ||
| </li> | ||
|
|
||
| <li class="toctree-l1 nav-item"> | ||
| <a class="reference internal nav-link" href="/en/latest/examples/index.html"> | ||
| Examples | ||
| </a> | ||
| </li> | ||
|
|
||
| <li class="toctree-l1 nav-item"> | ||
| <a class="reference internal nav-link" href="/en/latest/contributing.html"> | ||
| Contribute | ||
| </a> | ||
| </li> | ||
|
|
||
|
|
||
| </ul> | ||
| </div> | ||
|
|
||
| </div> | ||
|
|
||
| <div id="navbar-end"> | ||
|
|
||
| <div class="navbar-end-item"> | ||
| <div class="dropdown" id="version_switcher"> | ||
| <button type="button" class="btn btn-sm navbar-btn dropdown-toggle" id="version_switcher_button" data-toggle="dropdown"> | ||
| dev <!-- this text may get changed later by javascript --> | ||
| <span class="caret"></span> | ||
| </button> | ||
| <div id="version_switcher_menu" class="dropdown-menu list-group-flush py-0" aria-labelledby="version_switcher_button"> | ||
| <!-- dropdown will be populated by javascript on page load --> | ||
| </div> | ||
| </div> | ||
|
|
||
| <!-- NOTE: this JS must live here (not in our global JS file) because it relies | ||
| on being processed by Jinja before it is run (specifically for replacing | ||
| variables 404 and {'json_url': 'https://visualization.fluent.docs.pyansys.com/release/versions.json', 'version_match': 'dev'}. | ||
| --> | ||
|
|
||
| <script type="text/javascript"> | ||
| // Check if corresponding page path exists in other version of docs | ||
| // and, if so, go there instead of the homepage of the other docs version | ||
| function checkPageExistsAndRedirect(event) { | ||
| const currentFilePath = "404.html", | ||
| tryUrl = event.target.getAttribute("href"); | ||
| let otherDocsHomepage = tryUrl.replace(currentFilePath, ""); | ||
| $.ajax({ | ||
| type: 'HEAD', | ||
| url: tryUrl, | ||
| // if the page exists, go there | ||
| success: function() { | ||
| location.href = tryUrl; | ||
| } | ||
| }).fail(function() { | ||
| location.href = otherDocsHomepage; | ||
| }); | ||
| // this prevents the browser from following the href of the clicked node | ||
| // (which is fine because this function takes care of redirecting) | ||
| return false; | ||
| } | ||
|
|
||
| // Populate the version switcher from the JSON config file | ||
| (function () { | ||
| $.getJSON("https://visualization.fluent.docs.pyansys.com/release/versions.json", function(data, textStatus, jqXHR) { | ||
| const currentFilePath = "404.html"; | ||
| let btn = document.getElementById("version_switcher_button"); | ||
| // Set empty strings by default so that these attributes exist and can be used in CSS selectors | ||
| btn.dataset["activeVersionName"] = ""; | ||
| btn.dataset["activeVersion"] = ""; | ||
| // create links to the corresponding page in the other docs versions | ||
| $.each(data, function(index, entry) { | ||
| // if no custom name specified (e.g., "latest"), use version string | ||
| if (!("name" in entry)) { | ||
| entry.name = entry.version; | ||
| } | ||
| // create the node | ||
| const node = document.createElement("a"); | ||
| node.setAttribute("class", "list-group-item list-group-item-action py-1"); | ||
| node.textContent = `${entry.name}`; | ||
| node.setAttribute("href", `${entry.url}${currentFilePath}`); | ||
| // on click, AJAX calls will check if the linked page exists before | ||
| // trying to redirect, and if not, will redirect to the homepage | ||
| // for that version of the docs. | ||
| node.onclick = checkPageExistsAndRedirect; | ||
| // Add dataset values for the version and name in case people want | ||
| // to apply CSS styling based on this information. | ||
| node.dataset["versionName"] = entry.name; | ||
| node.dataset["version"] = entry.version; | ||
|
|
||
| $("#version_switcher_menu").append(node); | ||
| // replace dropdown button text with the preferred display name of | ||
| // this version, rather than using sphinx's 0.8.dev0 variable. | ||
| // also highlight the dropdown entry for the currently-viewed | ||
| // version's entry | ||
| if (entry.version == "dev") { | ||
| node.classList.add("active"); | ||
| btn.innerText = btn.dataset["activeVersionName"] = entry.name; | ||
| btn.dataset["activeVersion"] = entry.version; | ||
| } | ||
| }); | ||
| }); | ||
| })(); | ||
| </script> | ||
| </div> | ||
|
|
||
| <div class="navbar-end-item"> | ||
| <span id="theme-switch" class="btn btn-sm btn-outline-primary navbar-btn rounded-circle"> | ||
| <a class="theme-switch" data-mode="light"><i class="fas fa-sun"></i></a> | ||
| <a class="theme-switch" data-mode="dark"><i class="far fa-moon"></i></a> | ||
| <a class="theme-switch" data-mode="auto"><i class="fas fa-adjust"></i></a> | ||
| </span> | ||
| </div> | ||
|
|
||
| <div class="navbar-end-item"> | ||
| <ul id="navbar-icon-links" class="navbar-nav" aria-label="Icon Links"> | ||
| <li class="nav-item"> | ||
| <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> | ||
| <label class="sr-only">GitHub</label></a> | ||
| </li> | ||
| </ul> | ||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
| </div> | ||
| </nav> | ||
|
|
||
|
|
||
| <div id="announcement_msg"></div> | ||
| <script> | ||
| fetch("announcement.html") | ||
| .then((response) => { | ||
| if (!response.ok) { | ||
| throw new Error(`HTTP error: ${response.status}`); | ||
| } | ||
| return response.text(); | ||
| }) | ||
| .then(text => document.getElementById("announcement_msg").innerHTML = text) | ||
| .catch((error) => console.error(`Fetch problem: ${error.message}`)); | ||
| </script> | ||
|
|
||
|
|
||
| <div class="container-xl"> | ||
| <div class="row"> | ||
| <div class="col-12 col-md-3" id="breadcrumbs-spacer"></div> | ||
| <div class="col-12 col-md-11 col-xl-9" id="breadcrumbs"> | ||
|
|
||
| <div class="related" role="navigation" aria-label="related navigation"> | ||
| <h3>Navigation</h3> | ||
| <ul> | ||
|
|
||
| <li class="nav-item nav-item-additional-breadcrumb"><a href="https://docs.pyansys.com/">PyAnsys</a> » </li> | ||
|
|
||
|
|
||
| <li class="nav-item nav-item-0"><a href="/en/latest/index.html">PyFluent-Visualization</a> » </li> | ||
|
|
||
|
|
||
| <li class="nav-item nav-item-this"><a href="">Page not found</a></li> | ||
| </ul> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <div class="bd-container container-xl"> | ||
| <div class="bd-container__inner row"> | ||
|
|
||
|
|
||
| <!-- Only show if we have sidebars configured, else just a small margin --> | ||
| <div class="bd-sidebar-primary col-12 col-md-3 bd-sidebar"> | ||
| <div class="sidebar-start-items"><form class="bd-search d-flex align-items-center" action="/en/latest/search.html" method="get"> | ||
| <i class="icon fas fa-search"></i> | ||
| <input type="search" class="form-control" name="q" id="search-input" placeholder="Search the docs ..." aria-label="Search the docs ..." autocomplete="off" > | ||
| </form><nav class="bd-links" id="bd-docs-nav" aria-label="Main navigation"> | ||
| <div class="bd-toc-item active"> | ||
|
|
||
| </div> | ||
| </nav> | ||
| </div> | ||
| <div class="sidebar-end-items"> | ||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class="bd-sidebar-secondary d-none d-xl-block col-xl-2 bd-toc"> | ||
|
|
||
| </div> | ||
|
|
||
|
|
||
|
|
||
|
|
||
| <div class="bd-content col-12 col-md-9 col-xl-7"> | ||
|
|
||
| <article class="bd-article" role="main"> | ||
|
|
||
| <h1>Page not found</h1> | ||
|
|
||
| Unfortunately we couldn't find the content you were looking for. | ||
|
|
||
| </article> | ||
|
|
||
|
|
||
|
|
||
| </div> | ||
|
|
||
| </div> | ||
| </div> | ||
|
|
||
|
|
||
|
|
||
| <!-- Scripts loaded after <body> so the DOM is not blocked --> | ||
| <script src="/en/latest/_static/scripts/pydata-sphinx-theme.js?digest=92025949c220c2e29695"></script> | ||
|
|
||
| <footer class="bd-footer"><div class="bd-footer__inner container"> | ||
|
|
||
| <div class="footer-item"> | ||
| <p class="copyright"> | ||
| © Copyright (c) 2023 ANSYS, Inc. All rights reserved.<br> | ||
| </p> | ||
| </div> | ||
|
|
||
| <div class="footer-item"> | ||
| <p class="sphinx-version"> | ||
| Created using <a href="http://sphinx-doc.org/">Sphinx</a> 5.3.0.<br> | ||
| </p> | ||
| </div> | ||
|
|
||
| </div> | ||
| </footer> | ||
| </body> | ||
| </html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
Oops, something went wrong.