diff --git a/doc/guides/docs/images/doc-gen-flow.dot b/doc/guides/docs/images/doc-gen-flow.dot deleted file mode 100644 index a19fbc4fa00..00000000000 --- a/doc/guides/docs/images/doc-gen-flow.dot +++ /dev/null @@ -1,23 +0,0 @@ -# Doc Generation flow -# dot -Tpng -odoc-gen-flow.png doc-gen-flow.dot - -digraph docgen { - node [ fontname="verdana"] - bgcolor=transparent; rankdir=LR; - images [shape="rectangle" label=".png, .jpg\nimages"] - rst [shape="rectangle" label="restructuredText\nfiles"] - conf [shape="rectangle" label="conf.py\nconfiguration"] - rtd [shape="rectangle" label="read-the-docs\ntheme"] - header [shape="rectangle" label="c header\ncomments"] - xml [shape="rectangle" label="XML"] - html [shape="rectangle" label="HTML\nweb site"] - sphinx[shape="ellipse" label="sphinx +\nbreathe,\ndocutils"] - images -> sphinx - rst -> sphinx - conf -> sphinx - header -> doxygen - doxygen -> xml - xml-> sphinx - rtd -> sphinx - sphinx -> html - } diff --git a/doc/guides/docs/images/doc-gen-flow.png b/doc/guides/docs/images/doc-gen-flow.png deleted file mode 100644 index 837563a6fbf..00000000000 Binary files a/doc/guides/docs/images/doc-gen-flow.png and /dev/null differ diff --git a/doc/guides/docs/index.rst b/doc/guides/docs/index.rst index 74e61ec0b34..eee755ec040 100644 --- a/doc/guides/docs/index.rst +++ b/doc/guides/docs/index.rst @@ -39,8 +39,30 @@ The project's documentation contains the following items: * Script-generated material for kernel configuration options based on Kconfig files found in the source code tree -.. image:: images/doc-gen-flow.png - :align: center +.. graphviz:: + :caption: Schematic of the documentation build process + + digraph { + rankdir=LR + + images [shape="rectangle" label=".png, .jpg\nimages"] + rst [shape="rectangle" label="restructuredText\nfiles"] + conf [shape="rectangle" label="conf.py\nconfiguration"] + rtd [shape="rectangle" label="read-the-docs\ntheme"] + header [shape="rectangle" label="c header\ncomments"] + xml [shape="rectangle" label="XML"] + html [shape="rectangle" label="HTML\nweb site"] + sphinx[shape="ellipse" label="sphinx +\nbreathe,\ndocutils"] + images -> sphinx + rst -> sphinx + conf -> sphinx + header -> doxygen + doxygen -> xml + xml-> sphinx + rtd -> sphinx + sphinx -> html + } + The reStructuredText files are processed by the Sphinx documentation system, and make use of the breathe extension for including the doxygen-generated API