DOCS: Add PyAEDT cheat sheet

.github/workflows/ci_cd.yml

@@ -57,6 +57,7 @@ jobs:
           python-version: ${{ env.MAIN_PYTHON_VERSION }}
           sphinxopts: '-j auto --color -w build_errors.txt'
           check-links: false
+          needs-quarto: true
 
   smoke-tests:
     name: Build wheelhouse and smoke tests

doc/source/cheatsheet/.gitignore

@@ -0,0 +1,4 @@
+*
+!cheat_sheet.qmd
+!.gitignore
+/.quarto/

doc/source/cheatsheet/cheat_sheet.qmd

@@ -0,0 +1,56 @@
+---
+title: PyAEDT cheat sheet
+format: cheat_sheet-pdf
+params:
+  version: main
+footer: PyAEDT
+footerlinks:
+  - urls: 'https://aedt.docs.pyansys.com/version/stable/'
+    text: Documentation
+  - urls: 'https://aedt.docs.pyansys.com/version/stable/Getting_started/index.html'
+    text: Getting started
+  - urls: 'https://examples.aedt.docs.pyansys.com/'
+    text: Examples
+  - urls: 'https://aedt.docs.pyansys.com/version/stable/User_guide/index.html'
+    text: User guide
+  - urls: 'https://aedt.docs.pyansys.com/version/stable/API/index.html'
+    text: API reference
+execute:
+    # output: false
+    eval: false
+
+latex-clean: true
+jupyter:
+  jupytext:
+    text_representation:
+      extension: .qmd
+      format_name: quarto
+      format_version: '1.0'
+      jupytext_version: 1.16.1
+  kernelspec:
+    display_name: Python 3 (ipykernel)
+    language: python
+    name: python3
+---
+
+# Launch PyAEDT
+
+## Launch an HFSS instance locally
+```{python}
+#| eval: false
+from ansys.aedt.core import Hfss
+hfss = Hfss(
+    version='2024.2',
+    new_desktop=True,
+    close_on_exit=True,
+    non_graphical=False,
+    project="project_name",
+    design="design_name"
+)
+```
+
+## Exit your local instance:
+```{python}
+#| eval: false
+hfss.release_desktop()
+```

doc/source/conf.py

@@ -297,6 +297,10 @@ def setup(app):
         "limite": 10,
         "ignoreLocation": True,
     },
+    "cheatsheet": {
+        "file": "cheatsheet/cheat_sheet.qmd",
+        "title": "PyAEDT cheat sheet",
+    },
 }
 
 # # Add button to download PDF

pyproject.toml

@@ -78,6 +78,7 @@ dotnet = [
 ]
 doc = [
     "ansys-sphinx-theme>=1.0.0,<1.3",
+    "jupyter",
     "numpydoc>=1.5.0,<1.9",
     "recommonmark",
     "Sphinx>=7.1.0,<8.2",