From aa3882a6c008916445f6ce717c12f9069b88b54f Mon Sep 17 00:00:00 2001 From: Jason Kridner <jkridner@beagleboard.org> Date: Thu, 26 Oct 2023 00:37:27 -0400 Subject: [PATCH] librobotcontrol: getting to some content --- conf.py | 29 +++++++++++++++++++++++++++-- projects/librobotcontrol | 2 +- 2 files changed, 28 insertions(+), 3 deletions(-) diff --git a/conf.py b/conf.py index e3bd6daa..7431d988 100644 --- a/conf.py +++ b/conf.py @@ -10,6 +10,7 @@ from pathlib import Path import re import sphinx_rtd_theme from sphinx.ext.imgconverter import ImagemagickConverter +import textwrap ImagemagickConverter.conversion_rules.append(('image/webp', 'image/png')) @@ -33,12 +34,36 @@ extensions = [ "sphinx.ext.imgconverter", "sphinx.ext.todo", "sphinx_tabs.tabs", - "breathe" + "breathe", + "exhale" ] breathe_projects = {"librobotcontrol": "projects/librobotcontrol/docs/xml"} breathe_default_project = "librobotcontrol" +exhale_args = { + "containmentFolder": "./librobotcontrol", + "rootFileName": "index.rst", + "rootFileTitle": "Robot Control Library", + "createTreeView": True, + "exhaleExecutesDoxygen": False, + "doxygenStripFromPath": ".", + "exhaleDoxygenStdin": textwrap.dedent(''' + INPUT = projects/librobotcontrol/docs/xml + PROJECT_NAME = "Robotics Control Library" + LAYOUT_FILE = projects/librobotcontrol/docs/src/DoxygenLayout.xml + EXCLUDE_PATTERNS = */include/rc/mavlink/* + EXAMPLE_PATH += projects/librobotcontrol/examples/src/ \ + projects/librobotcontrol/library/include/ \ + projects/librobotcontrol/rc_project_template/ + '''), + "verboseBuild": False, +} + #STRIP_FROM_INC_PATH = ./projects/librobotcontrol/library/include/ + +primary_domain = 'cpp' +highlight_language = 'cpp' + todo_include_todos = True # Update (HTML) supported_image_types selection priority order @@ -59,7 +84,7 @@ navigation_with_keys = True # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'env'] html_theme = 'sphinx_rtd_theme' html_show_sphinx = False diff --git a/projects/librobotcontrol b/projects/librobotcontrol index 62946297..acec1ef5 160000 --- a/projects/librobotcontrol +++ b/projects/librobotcontrol @@ -1 +1 @@ -Subproject commit 629462972652dd726392e0832bb2bdb855b0a572 +Subproject commit acec1ef5eba439427e79f9d34c9567d21e1ab398 -- GitLab