Add imagemagick prereq (#60771)

This commit is contained in:
Derek Ardolf 2021-08-27 12:10:03 -05:00 committed by GitHub
parent 61e0793dd9
commit 02437684d0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -180,6 +180,25 @@ Now before each commit, it will ensure that your code at least *looks*
right before you open a pull request. And with that step, its time to right before you open a pull request. And with that step, its time to
start hacking on Salt! start hacking on Salt!
.. _imagemagick-setup:
``imagemagick`` Setup
~~~~~~~~~~~~~~~~~~~~~
One last prerequisite is to have ``imagemagick`` installed, as it is required
by Sphinx for generating the HTML documentation.
::
# On Mac, via homebrew
brew install imagemagick
::
# Example Linux installation: Debian-based
sudo apt install imagemagick
Salt Issues Salt Issues
----------- -----------
@ -273,8 +292,10 @@ Documentation
~~~~~~~~~~~~~ ~~~~~~~~~~~~~
Salt uses both docstrings, as well as normal reStructuredText files in Salt uses both docstrings, as well as normal reStructuredText files in
the ``salt/doc`` folder for documentation. Since we use nox, you can the ``salt/doc`` folder for documentation. Sphinx is used to generate the
build your docs and view them in your browser with this one-liner: documentation, and does require :ref:`setting up imagemagick on your OS.<imagemagick-setup>`
Since we use ``nox``, you can build your docs and view them in your browser
with this one-liner:
:: ::