diff --git a/doc/changelog.d/1553.documentation.md b/doc/changelog.d/1553.documentation.md new file mode 100644 index 0000000000..b6d0a76066 --- /dev/null +++ b/doc/changelog.d/1553.documentation.md @@ -0,0 +1 @@ +Test gallery examples diff --git a/doc/source/_static/ansys-gallery/ansys-favicon.png b/doc/source/_static/ansys-gallery/ansys-favicon.png new file mode 100644 index 0000000000..cfb2e5356a Binary files /dev/null and b/doc/source/_static/ansys-gallery/ansys-favicon.png differ diff --git a/doc/source/_static/ansys_mechanical_core_examples.json b/doc/source/_static/ansys_mechanical_core_examples.json new file mode 100644 index 0000000000..6d5f25ff51 --- /dev/null +++ b/doc/source/_static/ansys_mechanical_core_examples.json @@ -0,0 +1,35 @@ +{ + "00_basic/example_01_simple_structural_solve.py": [ + "ansys.mechanical.core.embedding.messages.MessageManager.remove", + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "00_basic/example_02_capture_images.py": [ + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "00_basic/example_03_show_object_properties.py": [ + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "01_tips_n_tricks/example_01_run_python_script_output.py": [], + "01_tips_n_tricks/example_02_run_python_script_scope.py": [], + "basic/example_06_bolt_pretension.py": [ + "ansys.mechanical.core.embedding.messages.MessageManager.remove", + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "basic/example_08_lsdyna_taylor_bar.py": [ + "ansys.mechanical.core.embedding.app.App.open", + "ansys.mechanical.core.embedding.app.App.plot", + "ansys.mechanical.core.embedding.messages.MessageManager.remove", + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "basic/example_09_tracemapping.py": [ + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "technology_showcase/example_05_td_026.py": [ + "ansys.mechanical.core.embedding.messages.MessageManager.remove", + "ansys.mechanical.core.mechanical.Mechanical.name" + ], + "technology_showcase/example_07_td_043.py": [ + "ansys.mechanical.core.embedding.messages.MessageManager.remove", + "ansys.mechanical.core.mechanical.Mechanical.name" + ] +} \ No newline at end of file diff --git a/doc/source/conf.py b/doc/source/conf.py index 2665ac0d4b..f2c5e4d040 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -242,7 +242,19 @@ "changelog_file_name": "changelog.rst", "sidebar_pages": ["changelog", "index"], }, - "ansys_sphinx_theme_autoapi": {"project": project}, + "ansys_sphinx_theme_autoapi": { + "project": project, + "examples_dirs": [ + "../../examples/", + ], + "examples_json": [ + { + "file": "_static/ansys_mechanical_core_examples.json", + "base_url": ("https://examples.mechanical.docs.pyansys.com/examples/"), + "fqn_prefixes": ["ansys"], + } + ], + }, } diff --git a/pyproject.toml b/pyproject.toml index 041b75cc66..6bff3c19e4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -57,7 +57,7 @@ tests = [ doc = [ "sphinx>=8.2.3,<9", - "ansys-sphinx-theme[autoapi,changelog]>=1.7.0,<2", + "ansys-sphinx-theme[autoapi,changelog]@git+https://github.com/ansys/ansys-sphinx-theme.git@feat/minigallaery", "imageio-ffmpeg>=0.6.0,<1", "imageio>=2.37.2,<3", "jupyter_sphinx>=0.5.3,<1",