From 7438b5d4461edc0e9a868f03b1a3dba6fe496303 Mon Sep 17 00:00:00 2001
From: Jason Kridner <jkridner@beagleboard.org>
Date: Wed, 15 Nov 2023 22:49:34 -0500
Subject: [PATCH] librobotcontrol: start simple for now
Disabling `exhale` because it is just overloading things right now.
Hidden in this commit are a couple of other items:
* Enable .md documents for CONTRIBUTING.md to avoid same content not on
docs.beagleboard.org
* Added graphviz to the venv setup, but that doesn't do much as I think
it was already there
---
conf.py | 5 +++--
index.rst | 2 +-
projects/index.rst | 2 +-
projects/librobotcontrol | 2 +-
venv-build-env.sh | 3 ++-
5 files changed, 8 insertions(+), 6 deletions(-)
diff --git a/conf.py b/conf.py
index 6b20bdf1..7fea3b88 100644
--- a/conf.py
+++ b/conf.py
@@ -36,9 +36,10 @@ extensions = [
"sphinx.ext.todo",
"sphinx_tabs.tabs",
"breathe",
- "exhale"
]
+# "exhale"
+
#graphviz_output_format = 'svg'
breathe_projects = {"librobotcontrol": "projects/librobotcontrol/docs/xml"}
@@ -70,7 +71,7 @@ LaTeXBuilder.supported_image_types = ['application/pdf', 'image/jpg', 'image/jpe
templates_path = ['_templates']
-source_suffix = '.rst'
+source_suffix = ['.rst', '.md']
numfig = True
navigation_with_keys = True
diff --git a/index.rst b/index.rst
index 25695877..e208895e 100644
--- a/index.rst
+++ b/index.rst
@@ -404,7 +404,7 @@ developers. Some developers choose to host documentation for their :ref:`project
/projects/simppru/index
/projects/bb-config/index
- /projects/librobotcontrol/index
+ /projects/librobotcontrol/docs/index
/projects/beagleconnect/index
Books
diff --git a/projects/index.rst b/projects/index.rst
index f8aaf538..1bb3de7a 100644
--- a/projects/index.rst
+++ b/projects/index.rst
@@ -10,5 +10,5 @@ This is a collection of reasonably well-supported projects useful to Beagle deve
/projects/simppru/index
/projects/bb-config/index
- /projects/librobotcontrol/index
+ /projects/librobotcontrol/docs/index
/projects/beagleconnect/index
diff --git a/projects/librobotcontrol b/projects/librobotcontrol
index cb13bb7c..1974b76f 160000
--- a/projects/librobotcontrol
+++ b/projects/librobotcontrol
@@ -1 +1 @@
-Subproject commit cb13bb7c843b67398a030000304e60fb5d9ca073
+Subproject commit 1974b76fd578ff9f5d1481ebd34f6801b9edeb6a
diff --git a/venv-build-env.sh b/venv-build-env.sh
index 393b2045..bea1e929 100755
--- a/venv-build-env.sh
+++ b/venv-build-env.sh
@@ -1,5 +1,5 @@
#!/bin/sh
-# Source this script
+# Source this script like `. ./venv-build-env.sh`
if [ ! -e ./sphinx-env ]; then
python3 -m venv sphinx-env
fi
@@ -8,3 +8,4 @@ python3 -m pip install --upgrade pip
python3 -m pip install sphinx==5.3.0 sphinx-rtd-theme sphinx_design sphinx-tabs sphinxcontrib.svg2pdfconverter sphinx-reredirects
python3 -m pip install sphinxcontrib-images
python3 -m pip install breathe exhale
+python3 -m pip install graphviz
--
GitLab