Add graph output #27
Add graph output #27
Conversation
Supports 3 out of 4 graph types supported by doxygen. For those 3 graph types there are sphinx extensions available to render them: * dot -> sphinx.ext.graphviz * plantuml -> sphinxcontrib.plantuml * msc -> sphinxcontrib.mscgen If the required extension isn't available, the graph code will not be given in the html output which is also a plus IMO, as it normally clutters the descritpion. It seems there is no extension available for dia. Also missing currently is support for graph file references, as well as passthrough of captions.
Codecov Report
@@ Coverage Diff @@
## master #27 +/- ##
=======================================
Coverage 87.32% 87.32%
=======================================
Files 14 14
Lines 2043 2043
=======================================
Hits 1784 1784
Misses 259 259Continue to review full report at Codecov.
|
|
Thanks for your contribution! Could you please share some project which makes use of the newly added functionality? I wanted to play with it a little before merging it in. |
|
I think I should be able to provide an example in the second half of next week. I can't provide the project I am using doxyrest for, as that's internal to our company, but deriving some examples how we use it should be possible. |
|
Sorry for the delay. Attached is an example containing one of each graph type (dot, msc, dia). It should build without errors (doxygen; doxyrest; sphinx). Graphs are rather simple and silly. I currently can't think of any real project using graphs in their doxygen docs. (But there probably are some out there) |
|
Thanks, it actually looks pretty cool! I never used that before, but I might just start doing that :) Totally can see where it can be useful. |
I am currently testing doxyrest for a project which makes use of embedded graphs (mainly dot and plantuml). I noticed the graph code is currently passed through as paragraph and figured out it isn't much needed to correctly wrap it in sphinx directives rendering them.
Added frame code and a short explanation for the manual.
Missing is output for diafiles (
\diafile) as there doesn't seem a sphinx module available. As well as the file commands (\dotfile,\mscfile). Enabling support for the latter two is possibly not complicated, but I haven't looked into it yet. If I get the chance I might provide another patch.Greetings
loebl