feat: add what's new section

doc/changelog.d/945.added.md

@@ -0,0 +1 @@
+add what's new section

doc/source/conf.py

@@ -213,6 +213,10 @@
  },
  "ansys_sphinx_theme_autoapi": {"project": project, "templates": "_templates/autoapi"},
  "navigation_depth": 10,
+ "whatsnew": {
+ "file": "whatsnew",
+ "pages": ["index", "changelog"],
+ },
 }
 
 # -- Options for HTMLHelp output ---------------------------------------------

doc/source/index.rst

@@ -14,7 +14,6 @@
  :width: 580px
  :align: center
 
-
 Python API to interact with `Ansys Mechanical`_ (FEA software for structural engineering) from **2023R2** and later versions.
 
 .. grid:: 3
@@ -118,4 +117,5 @@ Python API to interact with `Ansys Mechanical`_ (FEA software for structural eng
  contributing
  kil/index
  faq
- changelog
+ changelog
+ whatsnew

doc/source/whatsnew.rst

@@ -0,0 +1,79 @@
+.. _ref_whatsnew:
+
+What's new
+==========
+
+Discover the latest updates in PyMechanical, including new features,
+performance enhancements, and bug fixes designed to improve your experience.
+
+v0.11.x
+-------
+
+Launch GUI
+^^^^^^^^^^
+
+Open the current project with Mechanical GUI.
+
+.. code:: python
+
+ from ansys.mechanical.core import App
+
+ app = App()
+ app.save()
+ app.launch_gui()
+
+Above code opens up the temporarily saved ``.mechdb`` or ``.mechdat`` files.
+The files are deleted when GUI is closed . For more info check
+`launch_gui() <../api/ansys/mechanical/core/embedding/launch_gui/index.html>`_ function
+
+Opens up the specified project file.
+
+.. code:: python
+
+ launch_gui("path/to/project.mechdb")
+
+Prints Mechanical project tree
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+This feature let you see the heirachial Mechanical project tree.
+It also shows whether an object is suppressed or not.
+
+.. code:: python
+
+ import ansys.mechanical.core as mech
+
+ app = mech.App()
+ app.update_globals(globals())
+ app.print_tree()
+
+.. code:: shell
+
+ ... ├── Project
+ ... | ├── Model
+ ... | | ├── Geometry Imports
+ ... | | ├── Geometry
+ ... | | ├── Materials
+ ... | | ├── Coordinate Systems
+ ... | | | ├── Global Coordinate System
+ ... | | ├── Remote Points
+ ... | | ├── Mesh
+
+v0.10.x
+-------
+
+Visualize geometry in 3D
+^^^^^^^^^^^^^^^^^^^^^^^^
+
+Visualize imported geometry in 3D. This feature is available only from 24R1 or later.
+
+.. code:: python
+
+ import ansys.mechanical.core as mech
+
+ app = mech.App(version=242)
+ app.update_globals(globals())
+
+ # Import the geometry
+
+ # visualize
+ app.plot()

pyproject.toml

@@ -55,7 +55,7 @@ tests = [
 ]
 doc = [
  "sphinx==8.1.3",
- "ansys-sphinx-theme[autoapi]==1.1.4",
+ "ansys-sphinx-theme[autoapi] @ git+https:/ansys/ansys-sphinx-theme.git@fix/whatsnew",
  "grpcio==1.66.2",
  "imageio-ffmpeg==0.5.1",
  "imageio==2.36.0",