From 02437684d05d5f86cf0cffbf876b8077b40d55fa Mon Sep 17 00:00:00 2001 From: Derek Ardolf Date: Fri, 27 Aug 2021 12:10:03 -0500 Subject: [PATCH] Add imagemagick prereq (#60771) --- CONTRIBUTING.rst | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 263f9567902..bc9a6bf0d66 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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, it’s time to 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 ----------- @@ -273,8 +292,10 @@ Documentation ~~~~~~~~~~~~~ Salt uses both docstrings, as well as normal reStructuredText files in -the ``salt/doc`` folder for documentation. Since we use nox, you can -build your docs and view them in your browser with this one-liner: +the ``salt/doc`` folder for documentation. Sphinx is used to generate the +documentation, and does require :ref:`setting up imagemagick on your OS.` +Since we use ``nox``, you can build your docs and view them in your browser +with this one-liner: ::