Merge branch 'main' into patch-1

Author: MaxJPRey

.github/workflows/build_documentation.yml

@@ -30,7 +30,7 @@ jobs:
           vale-version: "2.29.6"
 
   docs_build:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v4
@@ -74,26 +74,38 @@ jobs:
 
       - name: Install doc build requirements
         run: |
-          sudo apt install graphviz
+          sudo apt update
+          sudo apt install graphviz texlive-latex-extra latexmk texlive-xetex texlive-fonts-extra -y
 
       # run doc build, without creating the examples directory
       # note that we have to add the examples file here since it won't
       # be created as gallery is disabled on linux.
-      - name: Documentation Build
+      - name: Documentation Build (HTML)
         run: |
           make -C doc clean
           mkdir doc/source/examples -p
           echo $'Examples\n========' > doc/source/examples/index.rst
-          make -C doc html SPHINXOPTS="-j auto -w build_errors.txt -N"
+          make -C doc phtml-no-examples SPHINXOPTS="-j auto -w build_errors.txt -N"
 
       # Verify that sphinx generates no warnings
       - name: Check for warnings
         run: |
           python doc/print_errors.py
 
-#      - name: Upload Documentation
-#        uses: actions/upload-artifact@v4
-#        with:
-#          name: Documentation
-#          path: doc/_build/html
-#          retention-days: 7
+      - name: Upload Documentation
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation
+          path: doc/_build/html
+          retention-days: 7
+
+      - name: Documentation Build (PDF)
+        run: |
+          make -C doc pdf-no-examples
+
+      - name: Upload documentation PDF artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: Documentation-pdf
+          path: doc/_build/latex/*.pdf
+          retention-days: 7

_unittest_solvers/conftest.py

@@ -35,7 +35,7 @@
 settings.enable_error_handler = False
 settings.enable_desktop_logs = False
 settings.desktop_launch_timeout = 180
-
+settings.release_on_exception = False
 
 from pyaedt.aedt_logger import pyaedt_logger
 from pyaedt.generic.general_methods import generate_unique_name

doc/Makefile

@@ -29,12 +29,22 @@ clean:
 phtml:
 	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -j auto
 
+phtml-no-examples:
+	export PYAEDT_SKIP_EXAMPLE="1"
+	$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) -j auto
+
 # Build pdf docs.
 pdf:
 	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
 	(test -f $(BUILDDIR)/latex/pyaedt.pdf && echo pdf exists) || exit 1
 
+pdf-no-examples:
+	export PYAEDT_SKIP_EXAMPLE="1"
+	@$(SPHINXBUILD) -M latex "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+	cd $(BUILDDIR)/latex && latexmk -r latexmkrc -pdf *.tex -interaction=nonstopmode || true
+	(test -f $(BUILDDIR)/latex/PyAEDT-Documentation-*.pdf && echo pdf exists) || exit 1
+
 # build docs like the CI build
 cibuild:
 	mkdir source/examples -p

doc/make.bat

@@ -33,10 +33,13 @@ goto end
 %SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 
 :pdf
+set PYAEDT_SKIP_EXAMPLE=1
+
+
 %SPHINXBUILD% -M latex %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
 cd "%BUILDDIR%\latex"
 for %%f in (*.tex) do (
-pdflatex "%%f" --interaction=nonstopmode)
+xelatex "%%f" --interaction=nonstopmode)
 
 :end
 popd

doc/source/User_guide/modeler.rst

@@ -57,9 +57,3 @@ All objects support executing any modeler operation, such as union or subtractio
      cyl = hfss.modeler["mycyl"]
      box.unite(cyl)
      box.subract(cyl)
-
-
-.. image:: ../Resources/objects_operations.gif
-  :width: 800
-  :alt: Object Modeler Operations
-

doc/source/conf.py

@@ -100,6 +100,7 @@ def setup(app):
 copyright = f"(c) {datetime.datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "Ansys Inc."
 cname = os.getenv("DOCUMENTATION_CNAME", "nocname.com")
+switcher_version = get_version_match(__version__)
 
 # Check for the local config file, otherwise use default desktop configuration
 local_config_file = os.path.join(local_path, "local_config.json")
@@ -134,6 +135,7 @@ def setup(app):
     "sphinx.ext.inheritance_diagram",
     "numpydoc",
     "ansys_sphinx_theme.extension.linkcode",
+    "recommonmark",
 ]
 
 # Intersphinx mapping
@@ -266,7 +268,7 @@ def setup(app):
     # necessary for pyvista when building the sphinx gallery
     pyvista.BUILDING_GALLERY = True
 
-    if config["run_examples"]:
+    if config["run_examples"] and not os.environ.get("PYAEDT_SKIP_EXAMPLE", False):
         extensions.append("sphinx_gallery.gen_gallery")
 
         sphinx_gallery_conf = {
@@ -340,6 +342,12 @@ def setup(app):
             "url": "https://github.com/ansys/pyaedt/discussions",
             "icon": "fa fa-comment fa-fw",
         },
+        {
+            "name": "Download documentation in PDF",
+            "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/pyaedt.pdf",
+            # noqa: E501
+            "icon": "fa fa-file-pdf fa-fw",
+        },
     ],
     "switcher": {
         "json_url": f"https://{cname}/versions.json",

pyproject.toml

@@ -82,7 +82,7 @@ doc = [
     "pypandoc>=1.10.0,<1.14",
     #"pytest-sphinx",
     "pyvista>=0.38.0,<0.44",
-    #"recommonmark",
+    "recommonmark",
     #"scikit-learn",
     "scikit-rf>=0.30.0,<0.33",
     "Sphinx==5.3.0; python_version == '3.7'",