From 3fc7bc26670a1b21d980b67b64b8d814cabd9700 Mon Sep 17 00:00:00 2001 From: Roland Conybeare Date: Fri, 19 Apr 2024 07:35:21 -0400 Subject: [PATCH] xo-ratio: docs: ++ install links for 3rd-party deps --- docs/install.rst | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index cbb638fd..f1359075 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -81,8 +81,16 @@ Unit test dependencies: To build documentation, will also need: -* `doxygen` -* `graphviz` -* `sphinx` -* `breathe` -* `sphinx_rtd_theme` +* `doxygen`_ c++ documentation +* `graphviz`_ graph drawing software, used by doxygen +* `sphinx`_ documentation system, ReST (`.rst`) format +* `breathe`_ use `doxygen`-generated ingredients in sphinx `.rst` files +* `sphinx_rtd_theme`_ css for sphinx html output + +Can install these + +.. _doxygen: https://www.doxygen.nl +.. _graphviz: https://graphviz.org +.. _sphinx: https://www.sphinx-doc.org/en/master +.. _breathe: https://breathe.readthedocs.io/en/latest +.. _sphinx_rtd_theme: https://github.com/readthedocs/sphinx_rtd_theme