]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: link to Dot User's Manual 48926/head
authorZac Dover <zac.dover@gmail.com>
Thu, 17 Nov 2022 05:35:58 +0000 (15:35 +1000)
committerZac Dover <zac.dover@gmail.com>
Thu, 17 Nov 2022 05:53:40 +0000 (15:53 +1000)
Add a link to the Dot User's Manual for Graphviz diagrams.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 249a4794afc01ae27314e55f87932f7492fecb4f)

doc/dev/documenting.rst

index 42bd56d06fed5754d55090445efaf1c1d5d810d1..c1a11890e6e4a638d85f0d24b26690f318b7d558 100644 (file)
@@ -86,6 +86,10 @@ separate file, like this::
 
   .. graphviz:: myfile.dot
 
+See the `Dot User's Manual <https://www.graphviz.org/pdf/dotguide.pdf>`_ by
+Emden R. Gansner, Eleftherios Koutsofios, and Stephen North for examples of
+digraphs. This is especially useful if this is your first time encountering
+GraphViz.
 
 Ditaa
 -----