I've switched the plugin from m2r2 to sphinx_mdinclude, works here as well.

Note: I've kept the name consistent for the install documentation, this works due to pip automatically switching between underscore & dash as needed.

@Mark: I guess this also needs some change to the ReadTheDocs configuration?

Regards,
Michael


Am 17.11.24 um 23:59 schrieb Michael Geddes:
Michael what do you think of switching over to mdinclude?

//.

On Mon, 18 Nov 2024, 05:28 Craig Leres, <leres@xse.com> wrote:
On 11/16/24 16:19, Michael Geddes via OvmsDev wrote:
> For some reason I was getting run-time python errors with m2r2 which is
> why I tried switching to mdinclude.

Over here in FreeBSD-land, I can "gmake html" if I change conf.py to use
sphinx_mdinclude instead of m2r2.

                Craig

ice 4003 % pkg info | fgrep sphinx
py311-sphinx-5.3.0_3,1         Python documentation generator
py311-sphinx-mdinclude-0.6.2   Sphinx extension that enables including
Markdown documents
py311-sphinx_rtd_theme-1.0.0   Mobile-friendly py-sphinx theme
py311-sphinxcontrib-applehelp-1.0.2 Extension which outputs Apple help books
py311-sphinxcontrib-devhelp-1.0.2 Sphinx extension which outputs Devhelp
document
py311-sphinxcontrib-htmlhelp-2.1.0 Sphinx extension which renders HTML
help files
py311-sphinxcontrib-jsmath-1.0.1 Sphinx extension which renders display
math in HTML via JavaScript
py311-sphinxcontrib-qthelp-2.0.0 Sphinx extension which outputs QtHelp
document
py311-sphinxcontrib-serializinghtml-2.0.0 Sphinx extension which outputs
serialized HTML files (json and pickle)


-- 
Michael Balzer * Am Rahmen 5 * D-58313 Herdecke
Fon 02330 9104094 * Handy 0176 20698926