fix: change gitub to github (#444)

change gitub to github

Author: RobPasMue

.buildinfo

@@ -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: 01b48db682127ca4186a898729c925da
+tags: 645f666f9bcd5a90fca523b33c5a78b7

.nojekyll

@@ -0,0 +1 @@
+dev.docs.pyansys.com

CNAME

@@ -0,0 +1,122 @@
+{
+  "cells": [
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "\n\n# Adding a new gallery example\n\nThis example shows how to add a new example to the PyAnsys [Sphinx-Gallery](https://sphinx-gallery.github.io/). You can use this example as a template\nfor adding your examples.\n\nEach example should have a reference tag/key in the form:\n\n``.. _<example-name>_example:``.\n\nThe ``.. _`` is necessary. Everything that follows is your reference tag, which\ncan potentially be used within a docstring. All references should be in snake case.\n\nThe first section, which is text, provides a brief overview of what the example is.\nWhen using this example as a template, you would change the title to an appropriate\none for your example.\n\nAdd new examples as Python scripts like this:\n\n``examples/<index>-<directory-name>/<some-example>.py``\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>Avoid creating directories unless absolutely necessary. If you *must*\n   create a directory, make sure to add a ``README.txt`` file containing a\n   reference, a title, and a one-sentence description of the directory.\n   Otherwise, Sphinx ignores the new directory.</p></div>\n\nExample file names should use snake case and be hyphen-separated:\n\n``some-example.py``\n\nAfter this text section is the first code block. This is where you\ntypically set up your imports.\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "import pyvista as pv"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Section title\n\nCode blocks can be broken up with text sections, which are interpreted as\nReStructuredText.\n\nThe text sections are also translated into a markdown cell in the generated Jupyter\nnotebook or in the HTML documentation.\n\nText sections can contain any information that you may have regarding the example,\nsuch as step-by-step comments and notes regarding motivations.\n\nAs in Jupyter notebooks, if a statement is unassigned at the end of a code\nblock, output is generated and printed to the screen according to its\n``__repr__`` method. Otherwise, you can use the ``print()`` function to output text.\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "# Create a dataset and exercise its ``__repr__`` method\n\ndataset = pv.Sphere()\ndataset"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Plots and images\nIf you use anything that outputs an image (for example, the\n:func:`pyvista.Plotter.show` function), the resulting image is rendered in the\nHTML documentation.\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>Unless ``sphinx_gallery_thumbnail_number = <int>`` is included at the top\n   of the example script, the first figure (this one) is used for the\n   gallery thumbnail image.\n\n   Also note that this image number uses one-based indexing.</p></div>\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "dataset.plot(text=\"Example Figure\")"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Caveat - plotter must be within one cell\nIt's not possible to have a single :class:`pyvista.Plotter` object across\nmultiple cells because these are closed out automatically at the end of a\ncell.\n\nThis code exercise the :class:`pyvista.Actor` ``repr`` to demonstrate\nwhy you might want to instantiate a plotter without showing it in the same\ncell:\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "pl = pv.Plotter()\nactor = pl.add_mesh(dataset)\nactor"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## This cell cannot run the plotter\nBecause the plotter is already closed by Sphinx-Gallery, the following code\nwould raise an error:\n\n>>> pl.show()\n\n"
+      ]
+    },
+    {
+      "cell_type": "code",
+      "execution_count": null,
+      "metadata": {
+        "collapsed": false
+      },
+      "outputs": [],
+      "source": [
+        "# You can, however, close out the plotter or access other attributes.\n\npl.close()"
+      ]
+    },
+    {
+      "cell_type": "markdown",
+      "metadata": {},
+      "source": [
+        "## Create a pull request\nOnce your example is complete and you've verified that it builds locally, you can\ncreate a pull request.\n\nBranches containing examples should be prefixed with ``docs/`` as per [Branch-naming conventions](https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions).\n\n<div class=\"alert alert-info\"><h4>Note</h4><p>You only need to create the Python source example (PY file). Sphinx-Gallery\n   automatically generates the Jupyter notebook and the RST file for generating\n   the HTML documentation page.</p></div>\n\n"
+      ]
+    }
+  ],
+  "metadata": {
+    "kernelspec": {
+      "display_name": "Python 3",
+      "language": "python",
+      "name": "python3"
+    },
+    "language_info": {
+      "codemirror_mode": {
+        "name": "ipython",
+        "version": 3
+      },
+      "file_extension": ".py",
+      "mimetype": "text/x-python",
+      "name": "python",
+      "nbconvert_exporter": "python",
+      "pygments_lexer": "ipython3",
+      "version": "3.10.14"
+    }
+  },
+  "nbformat": 4,
+  "nbformat_minor": 0
+}

_downloads/0c5c5e31ce7a7c7f604d78875ac760d9/pyvista_example.ipynb

@@ -0,0 +1,122 @@
+"""
+.. _adding_a_new_gallery_example:
+
+Adding a new gallery example
+============================
+
+This example shows how to add a new example to the PyAnsys `Sphinx-Gallery
+<https://sphinx-gallery.github.io/>`_. You can use this example as a template
+for adding your examples.
+
+Each example should have a reference tag/key in the form:
+
+``.. _<example-name>_example:``.
+
+The ``.. _`` is necessary. Everything that follows is your reference tag, which
+can potentially be used within a docstring. All references should be in snake case.
+
+The first section, which is text, provides a brief overview of what the example is.
+When using this example as a template, you would change the title to an appropriate
+one for your example.
+
+Add new examples as Python scripts like this:
+
+``examples/<index>-<directory-name>/<some-example>.py``
+
+.. note::
+
+   Avoid creating directories unless absolutely necessary. If you *must*
+   create a directory, make sure to add a ``README.txt`` file containing a
+   reference, a title, and a one-sentence description of the directory.
+   Otherwise, Sphinx ignores the new directory.
+
+Example file names should use snake case and be hyphen-separated:
+
+``some-example.py``
+
+After this text section is the first code block. This is where you
+typically set up your imports.
+"""
+
+import pyvista as pv
+
+###############################################################################
+# Section title
+# ~~~~~~~~~~~~~
+#
+# Code blocks can be broken up with text sections, which are interpreted as
+# ReStructuredText.
+#
+# The text sections are also translated into a markdown cell in the generated Jupyter
+# notebook or in the HTML documentation.
+#
+# Text sections can contain any information that you may have regarding the example,
+# such as step-by-step comments and notes regarding motivations.
+#
+# As in Jupyter notebooks, if a statement is unassigned at the end of a code
+# block, output is generated and printed to the screen according to its
+# ``__repr__`` method. Otherwise, you can use the ``print()`` function to output text.
+
+# Create a dataset and exercise its ``__repr__`` method
+
+dataset = pv.Sphere()
+dataset
+
+###############################################################################
+# Plots and images
+# ~~~~~~~~~~~~~~~~
+# If you use anything that outputs an image (for example, the
+# :func:`pyvista.Plotter.show` function), the resulting image is rendered in the
+# HTML documentation.
+#
+# .. note::
+#
+#    Unless ``sphinx_gallery_thumbnail_number = <int>`` is included at the top
+#    of the example script, the first figure (this one) is used for the
+#    gallery thumbnail image.
+#
+#    Also note that this image number uses one-based indexing.
+
+dataset.plot(text="Example Figure")
+
+###############################################################################
+# Caveat - plotter must be within one cell
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# It's not possible to have a single :class:`pyvista.Plotter` object across
+# multiple cells because these are closed out automatically at the end of a
+# cell.
+#
+# This code exercise the :class:`pyvista.Actor` ``repr`` to demonstrate
+# why you might want to instantiate a plotter without showing it in the same
+# cell:
+
+pl = pv.Plotter()
+actor = pl.add_mesh(dataset)
+actor
+
+###############################################################################
+# This cell cannot run the plotter
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+# Because the plotter is already closed by Sphinx-Gallery, the following code
+# would raise an error:
+#
+# >>> pl.show()
+
+# You can, however, close out the plotter or access other attributes.
+
+pl.close()
+
+###############################################################################
+# Create a pull request
+# ~~~~~~~~~~~~~~~~~~~~~
+# Once your example is complete and you've verified that it builds locally, you can
+# create a pull request.
+#
+# Branches containing examples should be prefixed with ``docs/`` as per `Branch-naming conventions
+# <https://dev.docs.pyansys.com/how-to/contributing.html#branch-naming-conventions>`_.
+#
+# .. note::
+#
+#    You only need to create the Python source example (PY file). Sphinx-Gallery
+#    automatically generates the Jupyter notebook and the RST file for generating
+#    the HTML documentation page.

_downloads/a1e7d03a60dc93926209dd01b7696263/pyvista_example.py

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/AutoAPI-output-modified.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/GitHub-about-area.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/GitHub-line-selector-suggestions.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/architecture_diag.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/card-dev-guide-home-page.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/card-docker-containers-pyansys-geometry.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/github_sections.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/graphviz-063eaec166626f16a0324b89dcf35aff469fd034.png

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>

_images/graphviz-063eaec166626f16a0324b89dcf35aff469fd034.png.map

@@ -0,0 +1,2 @@
+<map id="sphinx&#45;ext&#45;graphviz" name="sphinx&#45;ext&#45;graphviz">
+</map>