Separate the C++ Interpreter API into a separate library root

Since breathe doesn't support multiple projects by default, this
uses a fork of the monkey-patch extensions to enable this.
This commit is contained in:
Simon Hausmann 2021-03-22 14:36:55 +01:00
parent bd6cace54c
commit a769b630ca
3 changed files with 25 additions and 5 deletions

View file

@ -12,6 +12,7 @@ sphinx-rtd-theme = "*"
exhale = "*"
recommonmark = "*"
sphinx-markdown-tables = "*"
sphinx-contrib-exhale-multiproject = {subdirectory = "sphinx-contrib-exhale-multiproject", editable = true, git = "https://github.com/tronical/sphinx-contrib-mithro"}
[requires]
python_version = "3.8"

View file

@ -13,7 +13,7 @@
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
import exhale_multiproject_monkeypatch
# -- Project information -----------------------------------------------------
@ -33,24 +33,41 @@ release = '0.0.5'
extensions = ["breathe", "recommonmark", "exhale", "sphinx_markdown_tables"]
breathe_projects = {
"SixtyFPS": "./docs/xml"
"SixtyFPS": "./docs/xml",
"SixtyFPS Interpreter": "./interpreter-docs/xml",
}
breathe_default_project = "SixtyFPS"
exhale_args = {
"containmentFolder": "./api",
"rootFileName": "library_root.rst",
"rootFileTitle": "SixtyFPS CPP Reference Documentation",
"doxygenStripFromPath": "..",
"createTreeView": True,
"exhaleExecutesDoxygen": True,
"rootFileName": "library_root.rst",
}
exhale_projects_args = {
"SixtyFPS": {
"rootFileTitle": "SixtyFPS CPP Reference",
"containmentFolder": "./api",
"exhaleDoxygenStdin": '''INPUT = ../../api/sixtyfps-cpp/include
EXCLUDE_SYMBOLS = sixtyfps::cbindgen_private* sixtyfps::private_api* sixtyfps::interpreter*
EXCLUDE = ../../api/sixtyfps-cpp/include/vtable.h ../../api/sixtyfps-cpp/include/sixtyfps_testing.h
ENABLE_PREPROCESSING = YES
PREDEFINED = DOXYGEN'''
},
"SixtyFPS Interpreter": {
"rootFileTitle": "SixtyFPS Interpreter CPP Reference",
"containmentFolder": "./interpreter-api",
"exhaleDoxygenStdin": '''INPUT = ../../api/sixtyfps-cpp/include/sixtyfps_interpreter.h
EXCLUDE_SYMBOLS = sixtyfps::cbindgen_private* sixtyfps::private_api*
EXCLUDE = ../../api/sixtyfps-cpp/include/vtable.h ../../api/sixtyfps-cpp/include/sixtyfps_testing.h
ENABLE_PREPROCESSING = YES
PREDEFINED = DOXYGEN
'''
},
}
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

View file

@ -31,6 +31,8 @@ Welcome to SixtyFPS C++'s documentation!
markdown/widgets.md
markdown/langref.md
interpreter-api/library_root
Indices and tables
==================