Skip to content

Commit 23a5dac

Browse files
committed
[ReadTheDoc] set up read the doc hook.
Testing breathe purpose. I don't think I should use the doxygen generate api doc just yet.
1 parent 0ad77f4 commit 23a5dac

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

doc/conf.py

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
#
33
# For the full list of built-in configuration values, see the documentation:
44
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
import os
6+
import subprocess
57

68
# -- Project information -----------------------------------------------------
79
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
@@ -45,10 +47,19 @@
4547
suppress_warnings = [
4648
"myst.header"
4749
]
48-
myst_heading_anchors= 6
50+
myst_heading_anchors = 6
4951

5052
# -- Options for HTML output -------------------------------------------------
5153
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5254

5355
html_theme = 'furo'
5456
html_static_path = ['_static']
57+
58+
# -- Read the Doc Hook -------------------------------------------------------
59+
if os.environ.get("READTHEDOCS") == "True":
60+
def generate_doxygen_xml(_):
61+
subprocess.call('cd doc; doxygen', shell=True)
62+
63+
64+
def setup(app):
65+
app.connect('builder-inited', generate_doxygen_xml)

0 commit comments

Comments
 (0)