From 63bee81118ec715e5f47319aec8565404921993c Mon Sep 17 00:00:00 2001 From: Sebastien Morais Date: Tue, 30 Apr 2024 09:44:34 +0200 Subject: [PATCH 1/5] DOC: Fix blank area --- doc/source/index.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index c4cdb25bbf8..89c34b69bfe 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -39,8 +39,6 @@ enabling straightforward and efficient automation in your workflow. .. jinja:: main_toctree - .. grid:: 2 - {% if run_examples %} .. grid-item-card:: Examples :fa:`scroll` :link: examples/index @@ -48,6 +46,7 @@ enabling straightforward and efficient automation in your workflow. Explore examples that show how to use PyAEDT to perform different types of simulations. + .. grid:: 2 {% endif %} .. grid-item-card:: Contribute :fa:`people-group` From cbf3afac15b315dde2e4a051d7be2685728d0621 Mon Sep 17 00:00:00 2001 From: Sebastien Morais Date: Tue, 30 Apr 2024 12:27:34 +0200 Subject: [PATCH 2/5] DOC: Fix item card --- doc/source/index.rst | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 89c34b69bfe..45467bfedca 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,6 +37,14 @@ enabling straightforward and efficient automation in your workflow. This section contains descriptions of the functions and modules included in PyAEDT. It describes how the methods work and the parameters that can be used. + .. grid-item-card:: Contribute :fa:`people-group` + :link: Getting_started/Contributing + :link-type: doc + + Learn how to contribute to the PyAEDT codebase or documentation. + +.. grid:: 2 + .. jinja:: main_toctree {% if run_examples %} @@ -49,11 +57,6 @@ enabling straightforward and efficient automation in your workflow. .. grid:: 2 {% endif %} - .. grid-item-card:: Contribute :fa:`people-group` - :link: Getting_started/Contributing - :link-type: doc - - Learn how to contribute to the PyAEDT codebase or documentation. .. jinja:: main_toctree From 03b5c838f23a86bb537cfe90ff817b3108326dec Mon Sep 17 00:00:00 2001 From: Sebastien Morais Date: Fri, 3 May 2024 09:47:57 +0200 Subject: [PATCH 3/5] DOC: Remove sphinx-jinja dependency --- doc/source/conf.py | 19 ------------------- doc/source/index.rst | 31 ++++++++++--------------------- pyproject.toml | 2 -- 3 files changed, 10 insertions(+), 42 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 94f2b01248f..4629c5687cc 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -129,7 +129,6 @@ def setup(app): "sphinx.ext.coverage", "sphinx_copybutton", "sphinx_design", - "sphinx_jinja", "sphinx.ext.graphviz", "sphinx.ext.mathjax", "sphinx.ext.inheritance_diagram", @@ -296,24 +295,6 @@ def setup(app): # "set_plot_theme('document')"), } -jinja_contexts = { - "main_toctree": { - "run_examples": config["run_examples"], - }, -} -# def prepare_jinja_env(jinja_env) -> None: -# """ -# Customize the jinja env. -# -# Notes -# ----- -# See https://jinja.palletsprojects.com/en/3.0.x/api/#jinja2.Environment -# """ -# jinja_env.globals["project_name"] = project -# -# -# autoapi_prepare_jinja_env = prepare_jinja_env - # -- Options for HTML output ------------------------------------------------- html_short_title = html_title = "PyAEDT" html_theme = "ansys_sphinx_theme" diff --git a/doc/source/index.rst b/doc/source/index.rst index 45467bfedca..62a73d654ed 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -45,27 +45,16 @@ enabling straightforward and efficient automation in your workflow. .. grid:: 2 -.. jinja:: main_toctree - - {% if run_examples %} - .. grid-item-card:: Examples :fa:`scroll` - :link: examples/index - :link-type: doc - - Explore examples that show how to use PyAEDT to perform different types of simulations. - - .. grid:: 2 - {% endif %} - + .. grid-item-card:: Examples :fa:`scroll` + :link: examples/index + :link-type: doc -.. jinja:: main_toctree + Explore examples that show how to use PyAEDT to perform different types of simulations. - .. toctree:: - :hidden: +.. toctree:: + :hidden: - Getting_started/index - User_guide/index - API/index - {% if run_examples %} - examples/index - {% endif %} + Getting_started/index + User_guide/index + API/index + examples/index diff --git a/pyproject.toml b/pyproject.toml index 3ae4883ddda..23772ac788b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -93,7 +93,6 @@ doc = [ #"sphinx-autodoc-typehints", "sphinx-copybutton>=0.5.0,<0.6", "sphinx-gallery>=0.14.0,<0.17", - "sphinx-jinja>=2.0,<2.1", #"sphinx-notfound-page", "sphinx_design>=0.4.0,<0.6", #"sphinxcontrib-websupport", @@ -118,7 +117,6 @@ doc-noexamples = [ #"sphinx-notfound-page", #"sphinxcontrib-websupport", "sphinx_design>=0.4.0,<0.6", - "sphinx-jinja>=2.0,<2.1", ] all = [ "imageio>=2.30.0,<2.35", From cee578a97999a9022c2f644b04a77e4b2cfb103b Mon Sep 17 00:00:00 2001 From: Sebastien Morais Date: Fri, 3 May 2024 09:49:11 +0200 Subject: [PATCH 4/5] DOC: Reorder item cards --- doc/source/index.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 62a73d654ed..e2c60197713 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -37,19 +37,19 @@ enabling straightforward and efficient automation in your workflow. This section contains descriptions of the functions and modules included in PyAEDT. It describes how the methods work and the parameters that can be used. - .. grid-item-card:: Contribute :fa:`people-group` - :link: Getting_started/Contributing + .. grid-item-card:: Examples :fa:`scroll` + :link: examples/index :link-type: doc - Learn how to contribute to the PyAEDT codebase or documentation. + Explore examples that show how to use PyAEDT to perform different types of simulations. .. grid:: 2 - .. grid-item-card:: Examples :fa:`scroll` - :link: examples/index + .. grid-item-card:: Contribute :fa:`people-group` + :link: Getting_started/Contributing :link-type: doc - Explore examples that show how to use PyAEDT to perform different types of simulations. + Learn how to contribute to the PyAEDT codebase or documentation. .. toctree:: :hidden: From 9c4ba602610bea306ad5fac04fda6f97598b9563 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Morais?= <146729917+SMoraisAnsys@users.noreply.github.com> Date: Fri, 3 May 2024 14:19:24 +0000 Subject: [PATCH 5/5] TESTS: Limit skip to AEDT 2024.1 (#4624) --- _unittest_solvers/test_00_analyze.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/_unittest_solvers/test_00_analyze.py b/_unittest_solvers/test_00_analyze.py index 8286d715b34..91b665acd5b 100644 --- a/_unittest_solvers/test_00_analyze.py +++ b/_unittest_solvers/test_00_analyze.py @@ -431,7 +431,7 @@ def test_07_export_maxwell_fields(self, m3dtransient): new_setup.props = setup.props new_setup.update() - @pytest.mark.skipif(is_linux and desktop_version == "2024.2", reason="Temporary skip for SPISIM related tests") + @pytest.mark.skipif(is_linux and desktop_version == "2024.1", reason="Temporary skip for SPISIM related tests") def test_08_compute_erl(self, circuit_erl): touchstone_file = circuit_erl.export_touchstone() spisim = SpiSim(touchstone_file) @@ -453,7 +453,7 @@ def test_08_compute_erl(self, circuit_erl): erl_data_3 = spisim.compute_erl(specify_through_ports=[1, 2, 3, 4]) assert erl_data_3 - @pytest.mark.skipif(is_linux and desktop_version == "2024.2", reason="Temporary skip for SPISIM related tests") + @pytest.mark.skipif(is_linux and desktop_version == "2024.1", reason="Temporary skip for SPISIM related tests") def test_09a_compute_com(self, local_scratch, circuit_com): touchstone_file = circuit_com.export_touchstone() spisim = SpiSim(touchstone_file) @@ -466,7 +466,7 @@ def test_09a_compute_com(self, local_scratch, circuit_com): ) assert com - @pytest.mark.skipif(is_linux and desktop_version == "2024.2", reason="Temporary skip for SPISIM related tests") + @pytest.mark.skipif(is_linux and desktop_version == "2024.1", reason="Temporary skip for SPISIM related tests") def test_09b_compute_com(self, local_scratch): com_example_file_folder = os.path.join(local_path, "example_models", test_subfolder, "com_unit_test_sparam") thru_s4p = local_scratch.copyfile(os.path.join(com_example_file_folder, "SerDes_Demo_02_Thru.s4p")) @@ -506,7 +506,7 @@ def test_09b_compute_com(self, local_scratch): ) assert com_0 and com_1 - @pytest.mark.skipif(is_linux and desktop_version == "2024.2", reason="Temporary skip for SPISIM related tests") + @pytest.mark.skipif(is_linux and desktop_version == "2024.1", reason="Temporary skip for SPISIM related tests") def test_09c_compute_com(self, local_scratch): com_example_file_folder = Path(local_path) / "example_models" / test_subfolder / "com_unit_test_sparam" thru_s4p = local_scratch.copyfile(com_example_file_folder / "SerDes_Demo_02_Thru.s4p")