[coreboot-gerrit] [S] Change in coreboot[main]: [RFC][POC] Docs: Integrate Breathe extension

[Nicholas Chin (Code Review)]

Nicholas Chin has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/87230?usp=email )

Change subject: [RFC][POC] Docs: Integrate Breathe extension
......................................................................

[RFC][POC] Docs: Integrate Breathe extension

Enable the Breathe extension in the Sphinx conf.py, and add the Doxygen
XML output as a prerequisite for the sphinx target.

Change-Id: Ib9cdf93896184848e3ea450b774160ca30f1935c
Signed-off-by: Nicholas Chin 
---
M Documentation/Makefile
M Documentation/conf.py
2 files changed, 14 insertions(+), 3 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/30/87230/1

diff --git a/Documentation/Makefile b/Documentation/Makefile
index af2f9bb..ffafccf 100644
--- a/Documentation/Makefile
+++ b/Documentation/Makefile
@@ -14,13 +14,19 @@
 $(BUILDDIR):
    mkdir -p $(BUILDDIR)

-sphinx: $(BUILDDIR)
+sphinx: $(BUILDDIR) doxygen-xml
    $(MAKE) -f Makefile.sphinx html BUILDDIR="$(BUILDDIR)"

clean-sphinx:
    $(MAKE) -f Makefile.sphinx clean BUILDDIR="$(BUILDDIR)"

-clean: clean-sphinx
+doxygen-xml:
+	$(MAKE) -C .. doxygen-xml
+
+clean-doxygen:
+	$(MAKE) -C .. doxygen-clean
+
+clean: clean-sphinx clean-doxygen
    rm -f *.aux *.idx *.log *.toc *.out $(FIGS)

distclean: clean
diff --git a/Documentation/conf.py b/Documentation/conf.py
index d5b522a..664373d 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -20,7 +20,7 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-config...

-extensions = ["myst_parser"]
+extensions = ["myst_parser", "breathe"]

myst_heading_anchors = 5
 myst_url_schemes = ["http", "https", "mailto", "ftp", "ircs"]
@@ -46,3 +46,8 @@
 html_css_files = [
     'theme_overrides.css',  # override wide tables in RTD theme
 ]
+
+breathe_projects = {
+        "coreboot": "doxygen/xml/"
+}
+breathe_default_project = "coreboot"