MAINT: Cheat sheet (#871)

Co-authored-by: pyansys-ci-bot <[email protected]>
ansys · Aug 13, 2024 · 3df45cc · 3df45cc
1 parent 8d3ac59
commit 3df45cc
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 2 deletions.
diff --git a/doc/changelog.d/871.documentation.md b/doc/changelog.d/871.documentation.md
@@ -0,0 +1 @@
+MAINT: Cheat sheet
diff --git a/doc/source/cheatsheet/cheat_sheet.qmd b/doc/source/cheatsheet/cheat_sheet.qmd
@@ -1,7 +1,7 @@
 ---
 title: PyMechanical cheat sheet
 format: cheat_sheet-pdf
-version: 0.11.0
+version: main
 footer: PyMechanical
 footerlinks:
   - urls: 'https://mechanical.docs.pyansys.com/version/stable/'
@@ -78,7 +78,7 @@ import ansys.mechanical.core as pymechanical
 # Connect locally
 mechanical = pymechanical.Mechanical(port=10000)
           # Or
-# Connect remotely, specifying the IP address or hostname
+# Connect remotely, to the IP address or hostname
 mechanical = pymechanical.Mechanical(
   "192.168.0.1", port=10000
   )

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -318,3 +318,17 @@
     linkcheck_ignore.append(
         f"https://github.com/ansys/pymechanical/releases/tag/v{pymechanical.__version__}"
     )
+
+
+def replace_version_in_qmd(file_path, version):
+    """Update the version in cheatsheet."""
+    with open(file_path, "r") as file:
+        content = file.read()
+
+    content = content.replace("version: main", f"version: {version}")
+
+    with open(file_path, "w") as file:
+        file.write(content)
+
+
+replace_version_in_qmd("cheatsheet/cheat_sheet.qmd", version)