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 44 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
44 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
9658fc1
fix: crier new section
Revathyvenugopal162 Nov 4, 2024
21751af
fix: add tabs
Revathyvenugopal162 Nov 5, 2024
ff49e29
fix: add whatsnew
Revathyvenugopal162 Nov 6, 2024
0bbbc5c
fix: update the libs
Revathyvenugopal162 Nov 6, 2024
1c939e0
fix: add whatsnew section
Revathyvenugopal162 Nov 6, 2024
0753f8a
fix: add changelog
Revathyvenugopal162 Nov 6, 2024
13586c6
fix: files
Revathyvenugopal162 Nov 8, 2024
f542f57
Merge branch 'main' into feat/whatsnew
Revathyvenugopal162 Nov 8, 2024
8a26909
fix: update the branch
Revathyvenugopal162 Nov 13, 2024
3968d37
Merge branch 'feat/whatsnew' of https://github.com/ansys/pymechanical…
Revathyvenugopal162 Nov 13, 2024
5d9ae03
fix: us the reusable jinja template
Revathyvenugopal162 Nov 13, 2024
6858577
fix: delete the changelog file
Revathyvenugopal162 Nov 13, 2024
47bf5f7
Merge branch 'main' into feat/whatsnew
Revathyvenugopal162 Nov 13, 2024
1b47c77
Merge branch 'main' into feat/whatsnew
Revathyvenugopal162 Nov 14, 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
1 change: 1 addition & 0 deletions doc/changelog.d/945.added.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
add what's new section
17 changes: 0 additions & 17 deletions doc/changelog.d/changelog_template.jinja

This file was deleted.

21 changes: 21 additions & 0 deletions doc/changelog.d/whatsnew/123.whatsnew.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
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")
12 changes: 12 additions & 0 deletions doc/changelog.d/whatsnew/456.whatsnew.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Prints mechanical project tree
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This feature let you see the hierarchy of the mechanical project.
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()
10 changes: 10 additions & 0 deletions doc/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
:orphan:

.. _ref_release_notes:

.. button-ref:: release-note
:ref-type: doc
:color: primary
:shadow:
:expand:

Go to new release notes

Release notes
#############

Expand Down
12 changes: 8 additions & 4 deletions doc/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -207,12 +207,16 @@
"icon": "fa fa-comment fa-fw",
},
],
"cheatsheet": {
"file": "cheatsheet/cheat_sheet.qmd",
"title": "PyMechanical cheat sheet",
},
# "cheatsheet": {
# "file": "cheatsheet/cheat_sheet.qmd",
# "title": "PyMechanical cheat sheet",
# },
"ansys_sphinx_theme_autoapi": {"project": project, "templates": "_templates/autoapi"},
"navigation_depth": 10,
"whatsnew": {
"file": "release-note",
"pages": ["index", "release-note"],
},
}

# -- Options for HTMLHelp output ---------------------------------------------
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
release-note
whatsnew
79 changes: 79 additions & 0 deletions doc/source/whatsnew.rst
Original file line number Diff line number Diff line change
@@ -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

Check warning on line 9 in doc/source/whatsnew.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/whatsnew.rst#L9

[Google.Headings] 'v0.11.x' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'v0.11.x' should use sentence-style capitalization.", "location": {"path": "doc/source/whatsnew.rst", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}
-------

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.

Check failure on line 38 in doc/source/whatsnew.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/whatsnew.rst#L38

[Vale.Spelling] Did you really mean 'heirachial'?
Raw output
{"message": "[Vale.Spelling] Did you really mean 'heirachial'?", "location": {"path": "doc/source/whatsnew.rst", "range": {"start": {"line": 38, "column": 30}}}, "severity": "ERROR"}
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

Check warning on line 61 in doc/source/whatsnew.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/whatsnew.rst#L61

[Google.Headings] 'v0.10.x' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'v0.10.x' should use sentence-style capitalization.", "location": {"path": "doc/source/whatsnew.rst", "range": {"start": {"line": 61, "column": 1}}}, "severity": "WARNING"}
-------

Visualize geometry in 3D

Check warning on line 64 in doc/source/whatsnew.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/whatsnew.rst#L64

[Google.Headings] 'Visualize geometry in 3D' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Visualize geometry in 3D' should use sentence-style capitalization.", "location": {"path": "doc/source/whatsnew.rst", "range": {"start": {"line": 64, "column": 1}}}, "severity": "WARNING"}
^^^^^^^^^^^^^^^^^^^^^^^^

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()
30 changes: 22 additions & 8 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ tests = [
]
doc = [
"sphinx==8.1.3",
"ansys-sphinx-theme[autoapi]==1.2.0",
"grpcio==1.67.1",
"ansys-sphinx-theme[autoapi] @ git+https://github.com/ansys/ansys-sphinx-theme.git@fix/jinja-template-testing",
"grpcio==1.66.2",
"imageio-ffmpeg==0.5.1",
"imageio==2.36.0",
"jupyter_sphinx==0.5.3",
Expand Down Expand Up @@ -156,25 +156,26 @@ xfail_strict = true
[tool.towncrier]
package = "ansys.mechanical.core"
directory = "doc/changelog.d"
filename = "doc/source/changelog.rst"
filename = "doc/source/release-note.rst"
start_string = ".. towncrier release notes start\n"
template = "doc/changelog.d/changelog_template.jinja"
title_format = "`{version} <https://github.com/ansys/pymechanical/releases/tag/v{version}>`_ - {project_date}"
template = "ansys_sphinx_theme:changelog_template.jinja"
title_format = "Version `{version} <https://github.com/ansys/pymechanical/releases/tag/v{version}>`_ ({project_date})"
issue_format = "`#{issue} <https://github.com/ansys/pymechanical/pull/{issue}>`_"
all_bullets = false

[[tool.towncrier.type]]
directory = "added"
name = "Added"
name = "Features"
showcontent = true

[[tool.towncrier.type]]
directory = "changed"
name = "Changed"
name = "Deprecated and Changed"
showcontent = true

[[tool.towncrier.type]]
directory = "fixed"
name = "Fixed"
name = "Bug fixes"
showcontent = true

[[tool.towncrier.type]]
Expand All @@ -187,6 +188,19 @@ directory = "miscellaneous"
name = "Miscellaneous"
showcontent = true

[[tool.towncrier.type]]
directory = "whatsnew"
name = "Whatsnew"
showcontent = true

[[tool.towncrier.section]]
name = ""
path = ""

[[tool.towncrier.section]]
name = "Whatsnew"
path = "whatsnew"

# ========================================================
# Flake8 Configuration
# ========================================================
Expand Down
Loading