From a6abbad02017d1d2520c2b2e4456b079780bd3f7 Mon Sep 17 00:00:00 2001 From: "U-ANSYS\\mgalvagn" Date: Mon, 11 Nov 2024 07:38:54 -0800 Subject: [PATCH 1/2] Update documentation libraries --- doc/source/conf.py | 2 +- pyproject.toml | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index e6450779..96c143ef 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -74,7 +74,7 @@ # Intersphinx mapping intersphinx_mapping = { - "python": ("https://docs.python.org/3.11", None), + "python": ("https://docs.python.org/3", None), # kept here as an example # "scipy": ("https://docs.scipy.org/doc/scipy/reference", None), # "numpy": ("https://numpy.org/devdocs", None), diff --git a/pyproject.toml b/pyproject.toml index 59eeff3e..d92dfcbd 100755 --- a/pyproject.toml +++ b/pyproject.toml @@ -80,11 +80,11 @@ test = [ "ansys-dpf-core==0.13.0", ] doc = [ - "ansys-sphinx-theme==0.12.4", + "ansys-sphinx-theme==1.1.1", "numpydoc==1.8.0", "pillow==10.4.0", "docker>=7.1.0", - "Sphinx==7.2.6", + "Sphinx==8.0.2", "sphinx-copybutton==0.5.2", "sphinx-gallery==0.18.0", ] @@ -95,7 +95,7 @@ dev = [ "ipdb", "ipython", "whatsonpypi", - "ansys-sphinx-theme==0.12.4", + "ansys-sphinx-theme==1.1.1", "numpy==1.25.1", "numpydoc==1.8.0", "pillow==10.4.0", @@ -103,7 +103,7 @@ dev = [ "docker>=7.1.0", "pytest==8.3.3", "pytest-cov==4.1.0", - "Sphinx==7.2.6", + "Sphinx==8.0.2", "sphinx-copybutton==0.5.2", "sphinx-gallery==0.18.0", "pre-commit==3.3.3", From e5338ad2d12271f878b1fe0758425edf0de3dba4 Mon Sep 17 00:00:00 2001 From: "U-ANSYS\\mgalvagn" Date: Mon, 11 Nov 2024 09:03:10 -0800 Subject: [PATCH 2/2] fix doc syntax issues --- doc/source/examples_source/00-basic/02-plottype.py | 2 +- doc/source/lowlevelapi/TemplateObjects.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/source/examples_source/00-basic/02-plottype.py b/doc/source/examples_source/00-basic/02-plottype.py index f4b03f53..3b147707 100755 --- a/doc/source/examples_source/00-basic/02-plottype.py +++ b/doc/source/examples_source/00-basic/02-plottype.py @@ -63,7 +63,7 @@ # but this time we will set the plot attribute to line to visualize the values # as two line plots, and we will use the xaxis attribute to set which row should # be used as the X axis. We can also control the formatting and the title of the -# axis separately with the *axis_format and *title attributes, as done below. +# axis separately with the *axis_format* and *title attributes*, as done below. # The result can be seen in the following image. line_plot = adr_service.create_item(obj_name="Line Plot", source="Documentation") diff --git a/doc/source/lowlevelapi/TemplateObjects.rst b/doc/source/lowlevelapi/TemplateObjects.rst index 6d839a4f..c5d725f8 100755 --- a/doc/source/lowlevelapi/TemplateObjects.rst +++ b/doc/source/lowlevelapi/TemplateObjects.rst @@ -26,7 +26,7 @@ Template Objects .. _Tree Merge: https://s3.amazonaws.com/www3.ensight.com/nexus_docs/nexus_sphinx/is/TreeMerge.html .. _Userdefined: https://s3.amazonaws.com/www3.ensight.com/nexus_docs/nexus_sphinx/is/Userdefined.html .. _Generator templates: https://s3.amazonaws.com/www3.ensight.com/nexus_docs/nexus_sphinx/is/GeneratorTemplates.html - +.. _Statistical Analysis: https://ansysproducthelpqa.win.ansys.com/public/account/secured?returnurl=Views/Secured/corp/v251/en/adr_ug/ad_ug_generator_statistical_analysis.html report_objects.TemplateREST object @@ -1698,7 +1698,7 @@ no tree header be generated. .. _statisticalREST: statisticalREST object -^^^^^^^^^^^^^^^^^^^^ +^^^^^^^^^^^^^^^^^^^^^^ Inherits from TemplateREST, GeneratorREST