admin/mruby-mruby
1
0
Fork 0
mirror of https://github.com/mruby/mruby synced 2026-06-08 16:11:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #5892 from jbampton/rake-doc-capi-graphviz

Browse Source 
rake doc: C API needs both Doxygen and Graphviz
This commit is contained in:
Yukihiro "Matz" Matsumoto
2022-12-30 09:15:51 +09:00
committed by GitHub
parent d437182f79 e9b69c611d
commit 7fab8275dc
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+1 -1
View File
@@ -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
tasks/doc.rake
+6 -4
View File
@@ -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