From 195c16b2a7170b92b624c601fee94c0dd4ba1a0a Mon Sep 17 00:00:00 2001 From: Christian Frisson Date: Mon, 18 Mar 2024 13:00:57 -0400 Subject: [PATCH 1/3] src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py: extensions: add: "sphinx.ext.imgconverter" --- .../{{cookiecutter.__project_name_slug}}/doc/source/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py index 64ab0f1f2..6ba55f820 100755 --- a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py +++ b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/doc/source/conf.py @@ -64,6 +64,7 @@ "numpydoc", "sphinx.ext.intersphinx", "sphinx_copybutton", + "sphinx.ext.imgconverter", ] # Intersphinx mapping From 198fe5125d4fea306a0dbe9793a0ac44b500ba7f Mon Sep 17 00:00:00 2001 From: Christian Frisson Date: Mon, 18 Mar 2024 13:01:22 -0400 Subject: [PATCH 2/3] src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml: doc-build: dependencies: "imagemagick" --- .../.github/workflows/ci_cd.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml index c5091eccc..bf5580e60 100644 --- a/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml +++ b/src/ansys/templates/python/common/{{cookiecutter.__project_name_slug}}/.github/workflows/ci_cd.yml @@ -86,6 +86,7 @@ jobs: - uses: ansys/actions/doc-build@v5 with: python-version: {{ '${{ env.MAIN_PYTHON_VERSION }}' }} + dependencies: "imagemagick" build-library: name: "Build library basic example" From 1f6a0f0d1333c1160ad6e0acef8421b768d6b34b Mon Sep 17 00:00:00 2001 From: Christian Frisson Date: Mon, 18 Mar 2024 13:22:31 -0400 Subject: [PATCH 3/3] src/ansys/templates/python/*/{{cookiecutter.__project_name_slug}}/README.rst: add: Install imagemagick for image conversion --- .../README.rst | 15 +++++++++++++++ .../README.rst | 14 ++++++++++++++ .../README.rst | 14 ++++++++++++++ .../README.rst | 14 ++++++++++++++ 4 files changed, 57 insertions(+) diff --git a/src/ansys/templates/python/doc_project/{{cookiecutter.__project_name_slug}}/README.rst b/src/ansys/templates/python/doc_project/{{cookiecutter.__project_name_slug}}/README.rst index 19d4d97cb..a0d480ed0 100644 --- a/src/ansys/templates/python/doc_project/{{cookiecutter.__project_name_slug}}/README.rst +++ b/src/ansys/templates/python/doc_project/{{cookiecutter.__project_name_slug}}/README.rst @@ -21,6 +21,21 @@ Previous command will run `pre-commit`_ for checking code quality. Documentation ------------- + +Install imagemagick for image conversion: + +- Linux (Ubuntu) + + .. code:: bash + + sudo apt install imagemagick + +- Windows + + .. code:: bash + + winget install imagemagick + Documentation can be rendered by running: .. code-block:: text diff --git a/src/ansys/templates/python/pyansys/{{cookiecutter.__project_name_slug}}/README.rst b/src/ansys/templates/python/pyansys/{{cookiecutter.__project_name_slug}}/README.rst index 9fef71b24..a5c0f68f0 100644 --- a/src/ansys/templates/python/pyansys/{{cookiecutter.__project_name_slug}}/README.rst +++ b/src/ansys/templates/python/pyansys/{{cookiecutter.__project_name_slug}}/README.rst @@ -90,6 +90,20 @@ environment, which is another reason to consider using `tox`_. Documentation ------------- +Install imagemagick for image conversion: + +- Linux (Ubuntu) + + .. code:: bash + + sudo apt install imagemagick + +- Windows + + .. code:: bash + + winget install imagemagick + For building documentation, you can either run the usual rules provided in the `Sphinx`_ Makefile, such us: diff --git a/src/ansys/templates/python/pyansys_advanced/{{cookiecutter.__project_name_slug}}/README.rst b/src/ansys/templates/python/pyansys_advanced/{{cookiecutter.__project_name_slug}}/README.rst index 25486649f..72f0ca93d 100644 --- a/src/ansys/templates/python/pyansys_advanced/{{cookiecutter.__project_name_slug}}/README.rst +++ b/src/ansys/templates/python/pyansys_advanced/{{cookiecutter.__project_name_slug}}/README.rst @@ -173,6 +173,20 @@ encouraged to install this tool via: Documentation ------------- +Install imagemagick for image conversion: + +- Linux (Ubuntu) + + .. code:: bash + + sudo apt install imagemagick + +- Windows + + .. code:: bash + + winget install imagemagick + For building documentation, you can either run the usual rules provided in the `Sphinx`_ Makefile, such us: diff --git a/src/ansys/templates/python/pybasic/{{cookiecutter.__project_name_slug}}/README.rst b/src/ansys/templates/python/pybasic/{{cookiecutter.__project_name_slug}}/README.rst index 592736da0..86f133a66 100644 --- a/src/ansys/templates/python/pybasic/{{cookiecutter.__project_name_slug}}/README.rst +++ b/src/ansys/templates/python/pybasic/{{cookiecutter.__project_name_slug}}/README.rst @@ -88,6 +88,20 @@ environment, which is another reason to use tools like `tox`_. Documentation ------------- +Install imagemagick for image conversion: + +- Linux (Ubuntu) + + .. code:: bash + + sudo apt install imagemagick + +- Windows + + .. code:: bash + + winget install imagemagick + For building documentation, you can either run the usual rules provided in the `Sphinx`_ Makefile, such us: