From e9b69c611dea197a183976cf8a745882968010d7 Mon Sep 17 00:00:00 2001 From: John Bampton Date: Fri, 30 Dec 2022 09:05:13 +1000 Subject: [PATCH] rake doc: C API needs both Doxygen and Graphviz https://www.doxygen.nl/ https://graphviz.org/download/ --- README.md | 2 +- tasks/doc.rake | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index d2907862c..dd8661754 100644 --- a/README.md +++ b/README.md @@ -52,7 +52,7 @@ See the [compile.md](doc/guides/compile.md) file for the detail. ## Building documentation -There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen) +There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen and Graphviz) To build both of them, simply go diff --git a/tasks/doc.rake b/tasks/doc.rake index 5f21c1118..a6135bb82 100644 --- a/tasks/doc.rake +++ b/tasks/doc.rake @@ -19,13 +19,15 @@ namespace :doc do begin sh "doxygen Doxyfile" rescue - puts "ERROR: To generate C API documents, you need Doxygen." + puts "ERROR: To generate C API documents, you need Doxygen and Graphviz." puts "On Debian-based systems:" - puts " $ sudo apt-get install doxygen" + puts " $ sudo apt-get install doxygen graphviz" puts "On RHEL-based systems:" - puts " $ sudo dnf install doxygen" + puts " $ sudo dnf install doxygen graphviz" puts "On macOS-based systems:" - puts " $ brew install doxygen" + puts " $ brew install doxygen graphviz" + puts "https://www.doxygen.nl/" + puts "https://graphviz.org/" end end