Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: use imgconverter with imagemagick #455

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"numpydoc",
"sphinx.ext.intersphinx",
"sphinx_copybutton",
"sphinx.ext.imgconverter",
]

# Intersphinx mapping
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
Loading