Merge branch 'main' into post_processor_refacto

ansys · Apr 11, 2024 · 82d3661 · 82d3661
2 parents 7fd4007 + e9c7290
commit 82d3661
Show file tree

Hide file tree

Showing 15 changed files with 15 additions and 126 deletions.
diff --git a/.github/workflows/build_documentation.yml b/.github/workflows/build_documentation.yml
@@ -103,6 +103,12 @@ jobs:
         run: |
           make -C doc pdf-no-examples
 
+      - name: Add assets to HTML docs
+        run: |
+          zip -r documentation-html.zip ./doc/_build/html
+          mv documentation-html.zip ./doc/_build/html/_static/assets/download/
+          cp doc/_build/latex/PyAEDT-Documentation-*.pdf ./doc/_build/html/_static/assets/download/pyaedt.pdf
+
       - name: Upload documentation PDF artifact
         uses: actions/upload-artifact@v4
         with:

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -58,6 +58,12 @@ repos:
   -   id: blacken-docs
       additional_dependencies: [black==24.3.0]
 
+# This validates our pre-commit.ci configuration
+- repo: https://github.com/pre-commit-ci/pre-commit-ci-config
+  rev: v1.6.1
+  hooks:
+  -   id: check-pre-commit-ci-config
+
 
 # - repo: https://github.com/numpy/numpydoc
 #   rev: v1.6.0

diff --git a/doc/Makefile b/doc/Makefile
@@ -37,7 +37,7 @@ phtml-no-examples:
 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
+	(test -f $(BUILDDIR)/latex/PyAEDT-Documentation-*.pdf && echo pdf exists) || exit 1
 
 pdf-no-examples:
 	export PYAEDT_SKIP_EXAMPLE="1"

diff --git a/doc/source/_static/assets/download/README.md b/doc/source/_static/assets/download/README.md
@@ -0,0 +1 @@
+Downloadable assets are stored here.
diff --git a/doc/source/_static/assets/index_api.png b/doc/source/_static/assets/index_api.png
diff --git a/doc/source/_static/assets/index_api.svg b/doc/source/_static/assets/index_api.svg
diff --git a/doc/source/_static/assets/index_contribute.png b/doc/source/_static/assets/index_contribute.png
diff --git a/doc/source/_static/assets/index_contribute.svg b/doc/source/_static/assets/index_contribute.svg
diff --git a/doc/source/_static/assets/index_examples.png b/doc/source/_static/assets/index_examples.png
diff --git a/doc/source/_static/assets/index_examples.svg b/doc/source/_static/assets/index_examples.svg
diff --git a/doc/source/_static/assets/index_getting_started.png b/doc/source/_static/assets/index_getting_started.png
diff --git a/doc/source/_static/assets/index_getting_started.svg b/doc/source/_static/assets/index_getting_started.svg
diff --git a/doc/source/_static/assets/index_user_guide.png b/doc/source/_static/assets/index_user_guide.png
diff --git a/doc/source/_static/assets/index_user_guide.svg b/doc/source/_static/assets/index_user_guide.svg
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -344,6 +344,7 @@ def setup(app):
         },
         {
             "name": "Download documentation in PDF",
+            # NOTE: Changes to this URL must be reflected in CICD documentation build
             "url": f"https://{cname}/version/{switcher_version}/_static/assets/download/pyaedt.pdf",
             # noqa: E501
             "icon": "fa fa-file-pdf fa-fw",