Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add what's new section #945

Draft
wants to merge 30 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
9d44332
adding whatsnew.rst
dipinknair Oct 3, 2024
230d014
Merge branch 'main' into feat/whatsnew
dipinknair Oct 9, 2024
8cf817e
feat: add html and sphinx event
Revathyvenugopal162 Oct 10, 2024
2d6bc22
Merge branch 'feat/whatsnew' of https://github.com/ansys/pymechanical…
Revathyvenugopal162 Oct 10, 2024
14ac8e6
fix: update the conf file
Revathyvenugopal162 Oct 15, 2024
8f8c1a6
fix: Update doc/source/conf.py
Revathyvenugopal162 Oct 15, 2024
f476255
fix: remove unused sidebar
Revathyvenugopal162 Oct 15, 2024
28a340a
Merge branch 'main' into feat/whatsnew
Revathyvenugopal162 Oct 15, 2024
65a359b
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
1c9706b
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
eb5b008
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
30faa52
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
02cd39d
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
0645cb3
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
6d6b3df
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
ae91c0c
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
8dad6a5
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
eff8a15
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
c97bbfc
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
6ebf959
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
a42c578
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
4703795
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
86efa28
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
6ed5d60
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
6d13436
chore: adding changelog file 945.added.md [dependabot-skip]
pyansys-ci-bot Oct 15, 2024
494924e
fix: update the conf file
Revathyvenugopal162 Oct 15, 2024
632b822
Merge branch 'feat/whatsnew' of https://github.com/ansys/pymechanical…
Revathyvenugopal162 Oct 15, 2024
6929fe4
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 15, 2024
5a3b5f1
update whatsnew
dipinknair Oct 16, 2024
78477ed
chore: auto fixes from pre-commit hooks
pre-commit-ci[bot] Oct 16, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@
"github_repo": "pymechanical",
"github_version": "main",
"doc_path": "doc/source",
# "whatsnew": [{'title': 'v0.11.x', 'children': 'Open the project files with Mechanical GUI.', 'url': ''}, {'title': 'v0.10.x', 'children': 'Visualize imported geometry in 3D. This feature is available only from 24R1 or later.', 'url': ''}]
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
}
html_theme_options = {
"logo": "pyansys",
Expand Down Expand Up @@ -213,6 +214,10 @@
},
"ansys_sphinx_theme_autoapi": {"project": project, "templates": "_templates/autoapi"},
"navigation_depth": 10,
"whatsnew": {
"file": "whatsnew",
"pages": ["index"],
}
}

# -- Options for HTMLHelp output ---------------------------------------------
Expand All @@ -224,6 +229,7 @@
"changelog": [],
"examples/index": [],
"contributing": [],
"index": ["sidebar-nav-bs.html"],
Revathyvenugopal162 marked this conversation as resolved.
Show resolved Hide resolved
}

html_show_sourcelink = False
Expand Down
4 changes: 2 additions & 2 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -118,4 +117,5 @@ Python API to interact with `Ansys Mechanical`_ (FEA software for structural eng
contributing
kil/index
faq
changelog
changelog
whatsnew
43 changes: 43 additions & 0 deletions doc/source/whatsnew.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
.. _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 project files with Mechanical GUI.

.. code:: python

launch_gui()

Opens up the saved ``.mechdb`` or ``.mechdat`` files.


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
from ansys.mechanical.core.examples import delete_downloads, download_file

app = mech.App(version=242)
app.update_globals(globals())

# Import the geometry

# visualize
app.plot()
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ tests = [
]
doc = [
"sphinx==8.0.2",
"ansys-sphinx-theme[autoapi]==1.1.2",
"ansys-sphinx-theme[autoapi] @ git+https://github.com/ansys/ansys-sphinx-theme.git@fix/whatsnew",
"grpcio==1.66.2",
"imageio-ffmpeg==0.5.1",
"imageio==2.35.1",
Expand Down