From cc8d611cdcbc17fabc7b95ca7873d7d40659b36b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 9 Feb 2024 09:41:11 +0000 Subject: [PATCH 1/4] MAINT: Bump the documentation group with 4 updates Bumps the documentation group with 4 updates: [ansys-sphinx-theme](https://github.com/ansys/ansys-sphinx-theme), [pytest-sphinx](https://github.com/thisch/pytest-sphinx), [sphinx-autobuild](https://github.com/sphinx-doc/sphinx-autobuild) and [sphinx-autodoc-typehints](https://github.com/tox-dev/sphinx-autodoc-typehints). Updates `ansys-sphinx-theme` from 0.13.2 to 0.13.3 - [Release notes](https://github.com/ansys/ansys-sphinx-theme/releases) - [Commits](https://github.com/ansys/ansys-sphinx-theme/compare/v0.13.2...v0.13.3) Updates `pytest-sphinx` from 0.5.0 to 0.6.0 - [Release notes](https://github.com/thisch/pytest-sphinx/releases) - [Changelog](https://github.com/thisch/pytest-sphinx/blob/master/CHANGELOG.md) - [Commits](https://github.com/thisch/pytest-sphinx/compare/v0.5.0...v0.6.0) Updates `sphinx-autobuild` from 2021.3.14 to 2024.2.4 - [Release notes](https://github.com/sphinx-doc/sphinx-autobuild/releases) - [Changelog](https://github.com/sphinx-doc/sphinx-autobuild/blob/main/NEWS.rst) - [Commits](https://github.com/sphinx-doc/sphinx-autobuild/compare/2021.03.14...2024.02.04) Updates `sphinx-autodoc-typehints` from 1.25.2 to 2.0.0 - [Release notes](https://github.com/tox-dev/sphinx-autodoc-typehints/releases) - [Changelog](https://github.com/tox-dev/sphinx-autodoc-typehints/blob/main/CHANGELOG.md) - [Commits](https://github.com/tox-dev/sphinx-autodoc-typehints/compare/1.25.2...2.0.0) --- updated-dependencies: - dependency-name: ansys-sphinx-theme dependency-type: direct:production update-type: version-update:semver-patch dependency-group: documentation - dependency-name: pytest-sphinx dependency-type: direct:production update-type: version-update:semver-minor dependency-group: documentation - dependency-name: sphinx-autobuild dependency-type: direct:production update-type: version-update:semver-major dependency-group: documentation - dependency-name: sphinx-autodoc-typehints dependency-type: direct:production update-type: version-update:semver-major dependency-group: documentation ... Signed-off-by: dependabot[bot] --- pyproject.toml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 73b8685241..760a31aa8f 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -81,7 +81,7 @@ doc = [ "sphinx==7.2.6", "ansys-dpf-core==0.10.1", "ansys-mapdl-reader==0.53.0", - "ansys-sphinx-theme==0.13.2", + "ansys-sphinx-theme==0.13.3", "grpcio==1.60.1", "imageio-ffmpeg==0.4.9", "imageio==2.33.1", @@ -93,11 +93,11 @@ doc = [ "plotly==5.18.0", "pyiges[full]==0.3.1", "pypandoc==1.12", - "pytest-sphinx==0.5.0", + "pytest-sphinx==0.6.0", "pythreejs==2.4.2", "pyvista[trame]==0.43.2", - "sphinx-autobuild==2021.3.14", - "sphinx-autodoc-typehints==1.25.2", + "sphinx-autobuild==2024.2.4", + "sphinx-autodoc-typehints==2.0.0", "sphinx-copybutton==0.5.2", "sphinx-design==0.5.0", "sphinx-gallery==0.15.0", From 010be8cab314d9b8898d9bb967e44ce90b39b445 Mon Sep 17 00:00:00 2001 From: German Date: Fri, 2 Feb 2024 14:23:19 +0100 Subject: [PATCH 2/4] fixing some build issues --- src/ansys/mapdl/core/component.py | 1 + src/ansys/mapdl/core/logging.py | 1 + src/ansys/mapdl/core/mapdl_geometry.py | 3 ++- 3 files changed, 4 insertions(+), 1 deletion(-) diff --git a/src/ansys/mapdl/core/component.py b/src/ansys/mapdl/core/component.py index 96301bdde6..31ea84deb8 100644 --- a/src/ansys/mapdl/core/component.py +++ b/src/ansys/mapdl/core/component.py @@ -518,6 +518,7 @@ def select(self, names: Union[str, list[str], tuple[str]], mute=False) -> None: Name(s) of the components mute : bool, optional Whether to mute the `/CMSEL` command output or not, by default False. + """ if isinstance(names, str): names = [names] diff --git a/src/ansys/mapdl/core/logging.py b/src/ansys/mapdl/core/logging.py index 15db1b8a94..779f562443 100644 --- a/src/ansys/mapdl/core/logging.py +++ b/src/ansys/mapdl/core/logging.py @@ -583,6 +583,7 @@ def add_instance_logger( ------ Exception You can only input strings as ``name`` to this method. + """ count_ = 0 new_name = name diff --git a/src/ansys/mapdl/core/mapdl_geometry.py b/src/ansys/mapdl/core/mapdl_geometry.py index f1d8f1c4a4..18b9ebeefc 100644 --- a/src/ansys/mapdl/core/mapdl_geometry.py +++ b/src/ansys/mapdl/core/mapdl_geometry.py @@ -643,6 +643,7 @@ def generate_surface( ninc : int, optional Steps to between amin and amax. + """ with self._mapdl.save_selection: orig_anum = self.anum @@ -1499,7 +1500,7 @@ def __init__(self, mapdl: Mapdl): super().__init__(mapdl) def keypoints(self) -> np.array: # type: ignore - """Keypoint coordinates""" + """Keypoint coordinates.""" return super().get_keypoints(return_as_array=True) @requires_package("pyvista") From 230668c34bf5f83de8893906e41e2bd9bfcfe03a Mon Sep 17 00:00:00 2001 From: German Date: Fri, 9 Feb 2024 18:37:01 +0100 Subject: [PATCH 3/4] not upgrading `sphinx-autodoc-typehints` --- pyproject.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pyproject.toml b/pyproject.toml index 760a31aa8f..ffc3c37ab6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -97,7 +97,7 @@ doc = [ "pythreejs==2.4.2", "pyvista[trame]==0.43.2", "sphinx-autobuild==2024.2.4", - "sphinx-autodoc-typehints==2.0.0", + "sphinx-autodoc-typehints==1.25.2", "sphinx-copybutton==0.5.2", "sphinx-design==0.5.0", "sphinx-gallery==0.15.0", From c07d07358269baa7acf0964d717d2cb9506b246f Mon Sep 17 00:00:00 2001 From: German Date: Fri, 9 Feb 2024 18:40:24 +0100 Subject: [PATCH 4/4] fixing other requirements --- .devcontainer/codespaces-docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.devcontainer/codespaces-docs/requirements.txt b/.devcontainer/codespaces-docs/requirements.txt index 1e247f6a95..1f251b1b3a 100644 --- a/.devcontainer/codespaces-docs/requirements.txt +++ b/.devcontainer/codespaces-docs/requirements.txt @@ -17,7 +17,7 @@ pytest-sphinx==0.5.0 pythreejs==2.4.2 pyvista[trame]==0.43.3 sphinx-autobuild==2021.3.14 -sphinx-autodoc-typehints==1.25.3 +sphinx-autodoc-typehints==1.25.2 sphinx-copybutton==0.5.2 sphinx-gallery==0.15.0 sphinxcontrib-websupport==1.2.7