Skip to content

Commit 9f2029b

Browse files
committed
Document rsvg-convert requirement for building PDF docs
1 parent 781e8d8 commit 9f2029b

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

‎documentation/start-documenting.rst‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,8 +207,16 @@ To list other supported :program:`make` targets, run:
207207
208208
.\make help
209209
210+
210211
See :cpy-file:`Doc/README.rst` for more information.
211212

213+
.. note::
214+
215+
Some targets, such as ``dist-pdf``, require additional system
216+
dependencies beyond what's installed in the venv. Building the
217+
PDF documentation requires the ``rsvg-convert`` utility to be
218+
available on your system.
219+
212220

213221
.. _using-sphinx-build:
214222
.. _doc-build-sphinx:
@@ -239,4 +247,4 @@ replace ``html`` above with the desired builder ``name``.
239247
.. _Sphinx builder: https://www.sphinx-doc.org/en/master/usage/builders/index.html
240248
.. _Sphinx Lint: https://github.com/sphinx-contrib/sphinx-lint
241249
.. _venv-activate: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#activating-a-virtual-environment
242-
.. _venv-create: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment
250+
.. _venv-create: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#creating-a-virtual-environment

0 commit comments

Comments
 (0)