How I got sphinx working on ubuntu 23.1 + WSL
Firstly, thanks to Michael Balzer for fixing my errors in the rst files I checked in. (Also, apparently I can't spell Auxiliary - doh). I _had_ tried to get sphinx working recently and failed miserably, so I tried again this morning. The problem is that ubuntu: * Doesn't provide a package for m2r2 or sphinx-mdinclude (a fork of m2r2) * No longer allows you to pip install into the main python library path So first I got rid of the installed sphinx-doc sudo apt remove sphinx-doc Then I set up a sphinx virtual environment pipx install sphinx pipx inject sphinx sphinx_rtd_theme docutils mistune requests sphinx-mdinclude For some reason I was getting run-time python errors with m2r2 which is why I tried switching to mdinclude. In docs/source/conf.py I changed extensions = [ 'm2r2' ] to be 'sphinx_mdinclude' instead of 'm2r2' The pipx command creates a virtual execution environment for sphinx and puts a shim for sphinx in your local path that runs it in the virtual environment. //.ichael
Hi Michael, to get get pip working on Debian I need to remove (or rename) the file /usr/lib/python3.11/EXTERNALLY-MANAGED After doing that I can use pip as normal. It should be the same on Ubuntu. There are other solutions too: https://www.makeuseof.com/fix-pip-error-externally-managed-environment-linux... But this is the one I prefer. Regards Chris Am Sonntag, dem 17.11.2024 um 08:19 +0800 schrieb Michael Geddes via OvmsDev:
Firstly, thanks to Michael Balzer for fixing my errors in the rst files I checked in. (Also, apparently I can't spell Auxiliary - doh). I _had_ tried to get sphinx working recently and failed miserably, so I tried again this morning.
The problem is that ubuntu: * Doesn't provide a package for m2r2 or sphinx-mdinclude (a fork of m2r2) * No longer allows you to pip install into the main python library path
So first I got rid of the installed sphinx-doc sudo apt remove sphinx-doc
Then I set up a sphinx virtual environment
pipx install sphinx pipx inject sphinx sphinx_rtd_theme docutils mistune requests sphinx- mdinclude
For some reason I was getting run-time python errors with m2r2 which is why I tried switching to mdinclude.
In docs/source/conf.py I changed extensions = [ 'm2r2' ] to be 'sphinx_mdinclude' instead of 'm2r2'
The pipx command creates a virtual execution environment for sphinx and puts a shim for sphinx in your local path that runs it in the virtual environment.
//.ichael _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
OK. I assume that file will get restored? Apart from m2r2 needing to be replaced by mdinclude, I'm assuming my solution is actually the method intended by Ubuntu people . //. On Sun, 17 Nov 2024, 14:11 Chris van der Meijden, <chris@arachnon.de> wrote:
Hi Michael,
to get get pip working on Debian I need to remove (or rename) the file
/usr/lib/python3.11/EXTERNALLY-MANAGED
After doing that I can use pip as normal. It should be the same on Ubuntu.
There are other solutions too:
https://www.makeuseof.com/fix-pip-error-externally-managed-environment-linux...
But this is the one I prefer.
Regards
Chris
Am Sonntag, dem 17.11.2024 um 08:19 +0800 schrieb Michael Geddes via OvmsDev:
Firstly, thanks to Michael Balzer for fixing my errors in the rst files I checked in. (Also, apparently I can't spell Auxiliary - doh). I _had_ tried to get sphinx working recently and failed miserably, so I tried again this morning.
The problem is that ubuntu: * Doesn't provide a package for m2r2 or sphinx-mdinclude (a fork of m2r2) * No longer allows you to pip install into the main python library path
So first I got rid of the installed sphinx-doc sudo apt remove sphinx-doc
Then I set up a sphinx virtual environment
pipx install sphinx pipx inject sphinx sphinx_rtd_theme docutils mistune requests sphinx-mdinclude
For some reason I was getting run-time python errors with m2r2 which is why I tried switching to mdinclude.
In docs/source/conf.py I changed extensions = [ 'm2r2' ] to be 'sphinx_mdinclude' instead of 'm2r2'
The pipx command creates a virtual execution environment for sphinx and puts a shim for sphinx in your local path that runs it in the virtual environment.
//.ichael _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
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 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)
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
Perfect. Maybe include my howto using pipx for Ubuntu systems, since it is doing it the Ubuntu preferred way? //. On Wed, 20 Nov 2024, 02:22 Michael Balzer via OvmsDev, < ovmsdev@lists.openvehicles.com> wrote:
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 <https://www.google.com/maps/search/Am+Rahmen+5+*+D-58313+Herdecke?entry=gmail&source=g> Fon 02330 9104094 * Handy 0176 20698926
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Michael, Yes, readthedocs is broken. But seems to have had various problems building the docs for the past few weeks (although more to do with errors in the docs files before). Build logs shown below. Seems to be a dependency problem (probably docutils vs sphinx_mdinclude). I can’t see a trivial solution (it was painful enough to get it working with m2r), and am out of time now, but will try again tonight. Regards, Mark. P.S. I’ve added your eMail to the readthedocs notification list so you see build notifications. If you create an account on readthedocs.com <http://readthedocs.com/>, I can also add you as a maintainer there, if it helps. Read the Docs build information Build id: 26335608 Project: ovms Version: latest Commit: 1f863527d0a593fe8b10d2faee5cc0e04da4a843 Date: 2024-11-19T23:56:17.734263Z State: finished Success: False [rtd-command-info] start-time: 2024-11-19T23:56:18.277210Z, end-time: 2024-11-19T23:56:22.276851Z, duration: 3, exit-code: 0 git clone --depth 1 https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3.git . Cloning into '.'... [rtd-command-info] start-time: 2024-11-19T23:56:22.296787Z, end-time: 2024-11-19T23:56:24.339706Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master [rtd-command-info] start-time: 2024-11-19T23:56:24.414382Z, end-time: 2024-11-19T23:56:25.042773Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c <new-branch-name> Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at 1f86352 Include docutils, without specific version [rtd-command-info] start-time: 2024-11-19T23:56:25.068777Z, end-time: 2024-11-19T23:56:25.129267Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/source/requirements.txt [rtd-command-info] start-time: 2024-11-19T23:56:30.973717Z, end-time: 2024-11-19T23:56:31.050053Z, duration: 0, exit-code: 0 asdf global python 3.11.10 [rtd-command-info] start-time: 2024-11-19T23:56:31.420254Z, end-time: 2024-11-19T23:56:32.502084Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.10.final.0-64 in 772ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2024-11-19T23:56:32.536062Z, end-time: 2024-11-19T23:56:46.548826Z, duration: 14, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-24.3.1-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.8 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-75.5.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 21.1 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.3.1 setuptools-75.5.0 [rtd-command-info] start-time: 2024-11-19T23:56:46.593930Z, end-time: 2024-11-19T23:56:56.073085Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-8.1.3-py3-none-any.whl.metadata (6.4 kB) Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB) Collecting Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.22,>=0.20 (from sphinx) Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB) Collecting alabaster>=0.7.14 (from sphinx) Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.30.0 (from sphinx) Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-24.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.10-py3-none-any.whl.metadata (10 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx) Downloading urllib3-2.2.3-py3-none-any.whl.metadata (6.5 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-8.1.3-py3-none-any.whl (3.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.5/3.5 MB 116.3 MB/s eta 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.16.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 181.2 MB/s eta 0:00:00 Downloading docutils-0.21.2-py3-none-any.whl (587 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 366.5 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) Downloading packaging-24.2-py3-none-any.whl (65 kB) Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 365.8 MB/s eta 0:00:00 Downloading requests-2.32.3-py3-none-any.whl (64 kB) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB) Downloading certifi-2024.8.30-py3-none-any.whl (167 kB) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB) Downloading idna-3.10-py3-none-any.whl (70 kB) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB) Downloading urllib3-2.2.3-py3-none-any.whl (126 kB) Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-1.0.0 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-24.2 requests-2.32.3 snowballstemmer-2.2.0 sphinx-8.1.3 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.2.3 [rtd-command-info] start-time: 2024-11-19T23:56:56.096582Z, end-time: 2024-11-19T23:56:59.156352Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/source/requirements.txt Collecting sphinx_rtd_theme (from -r docs/source/requirements.txt (line 1)) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl.metadata (4.4 kB) Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from -r docs/source/requirements.txt (line 3)) (0.21.2) Collecting mistune<2.0.0 (from -r docs/source/requirements.txt (line 4)) Downloading mistune-0.8.4-py2.py3-none-any.whl.metadata (8.5 kB) Collecting requests<2.29.0 (from -r docs/source/requirements.txt (line 5)) Downloading requests-2.28.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: sphinx<9,>=6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (8.1.3) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) INFO: pip is looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.1-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.6.0-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.4-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.3-py3-none-any.whl.metadata (4.1 kB) Downloading sphinx_mdinclude-0.5.2-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.1-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.0-py3-none-any.whl.metadata (4.0 kB) INFO: pip is still looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl.metadata (4.0 kB) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.4.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.10) Collecting urllib3<1.27,>=1.21.1 (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) Downloading urllib3-1.26.20-py2.py3-none-any.whl.metadata (50 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (2024.8.30) Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.1.4) Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.18.0) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.16.0) Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.4.1) INFO: pip is looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-8.1.2-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.1-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.0-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.0.2-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.1-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.0-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB) Collecting alabaster~=0.7.14 (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) INFO: pip is still looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-7.4.6-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.5-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.4-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.3-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.2-py3-none-any.whl.metadata (6.1 kB) INFO: This is taking longer than usual. You might need to provide the dependency resolver with stricter constraints to reduce runtime. See https://pip.pypa.io/warnings/backtracking for guidance. If you want to abort this run, press Ctrl + C. Downloading sphinx-7.4.1-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.0-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.3.7-py3-none-any.whl.metadata (6.0 kB) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (24.2) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from Jinja2>=3.1->sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.0.2) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl (7.7 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.7/7.7 MB 143.1 MB/s eta 0:00:00 Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl (14 kB) Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Downloading requests-2.28.2-py3-none-any.whl (62 kB) Downloading sphinx-7.3.7-py3-none-any.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 164.0 MB/s eta 0:00:00 Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Downloading urllib3-1.26.20-py2.py3-none-any.whl (144 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Installing collected packages: mistune, urllib3, sphinx_mdinclude, alabaster, requests, sphinx, sphinxcontrib-jquery, sphinx_rtd_theme Attempting uninstall: urllib3 Found existing installation: urllib3 2.2.3 Uninstalling urllib3-2.2.3: Successfully uninstalled urllib3-2.2.3 Attempting uninstall: alabaster Found existing installation: alabaster 1.0.0 Uninstalling alabaster-1.0.0: Successfully uninstalled alabaster-1.0.0 Attempting uninstall: requests Found existing installation: requests 2.32.3 Uninstalling requests-2.32.3: Successfully uninstalled requests-2.32.3 Attempting uninstall: sphinx Found existing installation: Sphinx 8.1.3 Uninstalling Sphinx-8.1.3: Successfully uninstalled Sphinx-8.1.3 Successfully installed alabaster-0.7.16 mistune-0.8.4 requests-2.28.2 sphinx-7.3.7 sphinx_mdinclude-0.4.0 sphinx_rtd_theme-3.0.2 sphinxcontrib-jquery-4.1 urllib3-1.26.20 [rtd-command-info] start-time: 2024-11-19T23:56:59.229935Z, end-time: 2024-11-19T23:56:59.285486Z, duration: 0, exit-code: 0 cat docs/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- Path setup -------------------------------------------------------------- # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- Project information ----------------------------------------------------- project = 'Open Vehicles' copyright = '2019-2024, Open Vehicles Developers' author = 'Open Vehicle Developers' # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx_mdinclude', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # 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 = [ 'docs', '*/**.md', '*/wolfssl/*', '*/duktape/*', '*/mongoose/*', ] master_doc = 'index' # -- Source configuration ---------------------------------------------------- # - |clearfix| global substitution to clear floats (e.g. images) rst_epilog = """ .. |clearfix| raw:: html <div class="clearfix"></div> """ # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # #html_theme = 'default' html_theme = 'sphinx_rtd_theme' # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] html_context = { } def setup(app): app.add_css_file('theme_overrides.css') app.add_css_file('copybutton.css') app.add_js_file('clipboard.min.js') app.add_js_file('copybutton.js') [rtd-command-info] start-time: 2024-11-19T23:56:59.307664Z, end-time: 2024-11-19T23:56:59.818337Z, duration: 0, exit-code: 2 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.3.7 Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 453, in load_extension mod = import_module(extname) ^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/.asdf/installs/python/3.11.10/lib/python3.11/importlib/__init__.py", line 126, in import_module return _bootstrap._gcd_import(name[level:], package, level) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "<frozen importlib._bootstrap>", line 1204, in _gcd_import File "<frozen importlib._bootstrap>", line 1176, in _find_and_load File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 690, in _load_unlocked File "<frozen importlib._bootstrap_external>", line 940, in exec_module File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx_mdinclude/__init__.py", line 17, in <module> from docutils.core import ErrorString ImportError: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py) The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 332, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 229, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 402, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 456, in load_extension raise ExtensionError(__('Could not import extension %s') % extname, sphinx.errors.ExtensionError: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)) Extension error: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)
On 20 Nov 2024, at 2:22 AM, Michael Balzer via OvmsDev <ovmsdev@lists.openvehicles.com> wrote:
Signed PGP part 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 <mailto: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 _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com <mailto:OvmsDev@lists.openvehicles.com> http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Mark, I can login to readthedocs.com using my Github account (dexterbg). Regarding the build issue, I'd suspect an error in the requirements.txt file. I didn't change the other lines, but wondered why it defines these requirements with maximum version numbers: mistune<2.0.0 requests<2.29.0 Was that necessary for m2r2? If so, maybe try without, so pip determines the best match? Manually installing sphinx_mdinclude on my machine produced this constellation: sphinx_mdinclude 0.6.2 mistune 3.0.2 requests 2.32.3 Regards, Michael Am 20.11.24 um 01:01 schrieb Mark Webb-Johnson:
Michael,
Yes, readthedocs is broken. But seems to have had various problems building the docs for the past few weeks (although more to do with errors in the docs files before).
Build logs shown below. Seems to be a dependency problem (probably docutils vs sphinx_mdinclude). I can’t see a trivial solution (it was painful enough to get it working with m2r), and am out of time now, but will try again tonight.
Regards, Mark.
P.S. I’ve added your eMail to the readthedocs notification list so you see build notifications. If you create an account on readthedocs.com <http://readthedocs.com>, I can also add you as a maintainer there, if it helps.
Read the Docs build information Build id: 26335608 Project: ovms Version: latest Commit: 1f863527d0a593fe8b10d2faee5cc0e04da4a843 Date: 2024-11-19T23:56:17.734263Z State: finished Success: False
[rtd-command-info] start-time: 2024-11-19T23:56:18.277210Z, end-time: 2024-11-19T23:56:22.276851Z, duration: 3, exit-code: 0 git clone --depth 1https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3.git . Cloning into '.'...
[rtd-command-info] start-time: 2024-11-19T23:56:22.296787Z, end-time: 2024-11-19T23:56:24.339706Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master
[rtd-command-info] start-time: 2024-11-19T23:56:24.414382Z, end-time: 2024-11-19T23:56:25.042773Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to 'origin/master'.
You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch.
If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example:
git switch -c <new-branch-name>
Or undo this operation with:
git switch -
Turn off this advice by setting config variable advice.detachedHead to false
HEAD is now at 1f86352 Include docutils, without specific version
[rtd-command-info] start-time: 2024-11-19T23:56:25.068777Z, end-time: 2024-11-19T23:56:25.129267Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # Seehttps://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required version: 2
# Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11"
# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py
# We recommend specifying your dependencies to enable reproducible builds: #https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/source/requirements.txt
[rtd-command-info] start-time: 2024-11-19T23:56:30.973717Z, end-time: 2024-11-19T23:56:31.050053Z, duration: 0, exit-code: 0 asdf global python 3.11.10
[rtd-command-info] start-time: 2024-11-19T23:56:31.420254Z, end-time: 2024-11-19T23:56:32.502084Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.10.final.0-64 in 772ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator
[rtd-command-info] start-time: 2024-11-19T23:56:32.536062Z, end-time: 2024-11-19T23:56:46.548826Z, duration: 14, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-24.3.1-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.8 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-75.5.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 21.1 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.3.1 setuptools-75.5.0
[rtd-command-info] start-time: 2024-11-19T23:56:46.593930Z, end-time: 2024-11-19T23:56:56.073085Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-8.1.3-py3-none-any.whl.metadata (6.4 kB) Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB) Collecting Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.22,>=0.20 (from sphinx) Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB) Collecting alabaster>=0.7.14 (from sphinx) Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.30.0 (from sphinx) Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-24.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.10-py3-none-any.whl.metadata (10 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx) Downloading urllib3-2.2.3-py3-none-any.whl.metadata (6.5 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-8.1.3-py3-none-any.whl (3.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.5/3.5 MB 116.3 MB/s eta 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.16.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 181.2 MB/s eta 0:00:00 Downloading docutils-0.21.2-py3-none-any.whl (587 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 366.5 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) Downloading packaging-24.2-py3-none-any.whl (65 kB) Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 365.8 MB/s eta 0:00:00 Downloading requests-2.32.3-py3-none-any.whl (64 kB) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB) Downloading certifi-2024.8.30-py3-none-any.whl (167 kB) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB) Downloading idna-3.10-py3-none-any.whl (70 kB) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB) Downloading urllib3-2.2.3-py3-none-any.whl (126 kB) Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-1.0.0 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-24.2 requests-2.32.3 snowballstemmer-2.2.0 sphinx-8.1.3 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.2.3
[rtd-command-info] start-time: 2024-11-19T23:56:56.096582Z, end-time: 2024-11-19T23:56:59.156352Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/source/requirements.txt Collecting sphinx_rtd_theme (from -r docs/source/requirements.txt (line 1)) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl.metadata (4.4 kB) Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from -r docs/source/requirements.txt (line 3)) (0.21.2) Collecting mistune<2.0.0 (from -r docs/source/requirements.txt (line 4)) Downloading mistune-0.8.4-py2.py3-none-any.whl.metadata (8.5 kB) Collecting requests<2.29.0 (from -r docs/source/requirements.txt (line 5)) Downloading requests-2.28.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: sphinx<9,>=6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (8.1.3) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) INFO: pip is looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.1-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.6.0-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.4-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.3-py3-none-any.whl.metadata (4.1 kB) Downloading sphinx_mdinclude-0.5.2-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.1-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.0-py3-none-any.whl.metadata (4.0 kB) INFO: pip is still looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl.metadata (4.0 kB) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.4.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.10) Collecting urllib3<1.27,>=1.21.1 (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) Downloading urllib3-1.26.20-py2.py3-none-any.whl.metadata (50 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (2024.8.30) Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.1.4) Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.18.0) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.16.0) Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.4.1) INFO: pip is looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-8.1.2-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.1-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.0-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.0.2-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.1-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.0-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB) Collecting alabaster~=0.7.14 (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) INFO: pip is still looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-7.4.6-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.5-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.4-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.3-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.2-py3-none-any.whl.metadata (6.1 kB) INFO: This is taking longer than usual. You might need to provide the dependency resolver with stricter constraints to reduce runtime. Seehttps://pip.pypa.io/warnings/backtracking for guidance. If you want to abort this run, press Ctrl + C. Downloading sphinx-7.4.1-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.0-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.3.7-py3-none-any.whl.metadata (6.0 kB) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (24.2) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from Jinja2>=3.1->sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.0.2) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl (7.7 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.7/7.7 MB 143.1 MB/s eta 0:00:00 Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl (14 kB) Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Downloading requests-2.28.2-py3-none-any.whl (62 kB) Downloading sphinx-7.3.7-py3-none-any.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 164.0 MB/s eta 0:00:00 Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Downloading urllib3-1.26.20-py2.py3-none-any.whl (144 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Installing collected packages: mistune, urllib3, sphinx_mdinclude, alabaster, requests, sphinx, sphinxcontrib-jquery, sphinx_rtd_theme Attempting uninstall: urllib3 Found existing installation: urllib3 2.2.3 Uninstalling urllib3-2.2.3: Successfully uninstalled urllib3-2.2.3 Attempting uninstall: alabaster Found existing installation: alabaster 1.0.0 Uninstalling alabaster-1.0.0: Successfully uninstalled alabaster-1.0.0 Attempting uninstall: requests Found existing installation: requests 2.32.3 Uninstalling requests-2.32.3: Successfully uninstalled requests-2.32.3 Attempting uninstall: sphinx Found existing installation: Sphinx 8.1.3 Uninstalling Sphinx-8.1.3: Successfully uninstalled Sphinx-8.1.3 Successfully installed alabaster-0.7.16 mistune-0.8.4 requests-2.28.2 sphinx-7.3.7 sphinx_mdinclude-0.4.0 sphinx_rtd_theme-3.0.2 sphinxcontrib-jquery-4.1 urllib3-1.26.20
[rtd-command-info] start-time: 2024-11-19T23:56:59.229935Z, end-time: 2024-11-19T23:56:59.285486Z, duration: 0, exit-code: 0 cat docs/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: #http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Open Vehicles' copyright = '2019-2024, Open Vehicles Developers' author = 'Open Vehicle Developers'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx_mdinclude', ]
# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']
# 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 = [ 'docs', '*/**.md', '*/wolfssl/*', '*/duktape/*', '*/mongoose/*', ]
master_doc = 'index'
# -- Source configuration ----------------------------------------------------
# - |clearfix| global substitution to clear floats (e.g. images) rst_epilog = """ .. |clearfix| raw:: html
<div class="clearfix"></div>
"""
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # #html_theme = 'default' html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static']
html_context = { }
def setup(app): app.add_css_file('theme_overrides.css') app.add_css_file('copybutton.css') app.add_js_file('clipboard.min.js') app.add_js_file('copybutton.js')
[rtd-command-info] start-time: 2024-11-19T23:56:59.307664Z, end-time: 2024-11-19T23:56:59.818337Z, duration: 0, exit-code: 2 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.3.7
Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 453, in load_extension mod = import_module(extname) ^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/.asdf/installs/python/3.11.10/lib/python3.11/importlib/__init__.py", line 126, in import_module return _bootstrap._gcd_import(name[level:], package, level) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "<frozen importlib._bootstrap>", line 1204, in _gcd_import File "<frozen importlib._bootstrap>", line 1176, in _find_and_load File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 690, in _load_unlocked File "<frozen importlib._bootstrap_external>", line 940, in exec_module File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx_mdinclude/__init__.py", line 17, in <module> from docutils.core import ErrorString ImportError: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)
The above exception was the direct cause of the following exception:
Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 332, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 229, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 402, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 456, in load_extension raise ExtensionError(__('Could not import extension %s') % extname, sphinx.errors.ExtensionError: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py))
Extension error: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)
On 20 Nov 2024, at 2:22 AM, Michael Balzer via OvmsDev <ovmsdev@lists.openvehicles.com> wrote:
Signed PGP part 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 _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
Michael, I added you as a maintainer. Please check inbox for invite. Removing the dependencies for mistune and requests seems to have resolved it. Those were there before to deal with various m2r issues with Sphinx. Regards, Mark.
On 20 Nov 2024, at 3:08 PM, Michael Balzer <dexter@expeedo.de> wrote:
Mark,
I can login to readthedocs.com using my Github account (dexterbg).
Regarding the build issue, I'd suspect an error in the requirements.txt file. I didn't change the other lines, but wondered why it defines these requirements with maximum version numbers:
mistune<2.0.0 requests<2.29.0
Was that necessary for m2r2? If so, maybe try without, so pip determines the best match?
Manually installing sphinx_mdinclude on my machine produced this constellation:
sphinx_mdinclude 0.6.2 mistune 3.0.2 requests 2.32.3
Regards, Michael
Am 20.11.24 um 01:01 schrieb Mark Webb-Johnson:
Michael,
Yes, readthedocs is broken. But seems to have had various problems building the docs for the past few weeks (although more to do with errors in the docs files before).
Build logs shown below. Seems to be a dependency problem (probably docutils vs sphinx_mdinclude). I can’t see a trivial solution (it was painful enough to get it working with m2r), and am out of time now, but will try again tonight.
Regards, Mark.
P.S. I’ve added your eMail to the readthedocs notification list so you see build notifications. If you create an account on readthedocs.com <http://readthedocs.com/>, I can also add you as a maintainer there, if it helps. Read the Docs build information Build id: 26335608 Project: ovms Version: latest Commit: 1f863527d0a593fe8b10d2faee5cc0e04da4a843 Date: 2024-11-19T23:56:17.734263Z State: finished Success: False
[rtd-command-info] start-time: 2024-11-19T23:56:18.277210Z, end-time: 2024-11-19T23:56:22.276851Z, duration: 3, exit-code: 0 git clone --depth 1 https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3.git . Cloning into '.'...
[rtd-command-info] start-time: 2024-11-19T23:56:22.296787Z, end-time: 2024-11-19T23:56:24.339706Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master
[rtd-command-info] start-time: 2024-11-19T23:56:24.414382Z, end-time: 2024-11-19T23:56:25.042773Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to 'origin/master'.
You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by switching back to a branch.
If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example:
git switch -c <new-branch-name>
Or undo this operation with:
git switch -
Turn off this advice by setting config variable advice.detachedHead to false
HEAD is now at 1f86352 Include docutils, without specific version
[rtd-command-info] start-time: 2024-11-19T23:56:25.068777Z, end-time: 2024-11-19T23:56:25.129267Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
# Required version: 2
# Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11"
# Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/source/conf.py
# We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - requirements: docs/source/requirements.txt
[rtd-command-info] start-time: 2024-11-19T23:56:30.973717Z, end-time: 2024-11-19T23:56:31.050053Z, duration: 0, exit-code: 0 asdf global python 3.11.10
[rtd-command-info] start-time: 2024-11-19T23:56:31.420254Z, end-time: 2024-11-19T23:56:32.502084Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.10.final.0-64 in 772ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator
[rtd-command-info] start-time: 2024-11-19T23:56:32.536062Z, end-time: 2024-11-19T23:56:46.548826Z, duration: 14, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-24.3.1-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.8 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-75.5.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 21.1 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.3.1 setuptools-75.5.0
[rtd-command-info] start-time: 2024-11-19T23:56:46.593930Z, end-time: 2024-11-19T23:56:56.073085Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-8.1.3-py3-none-any.whl.metadata (6.4 kB) Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB) Collecting Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.22,>=0.20 (from sphinx) Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB) Collecting alabaster>=0.7.14 (from sphinx) Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.30.0 (from sphinx) Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-24.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.10-py3-none-any.whl.metadata (10 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx) Downloading urllib3-2.2.3-py3-none-any.whl.metadata (6.5 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-8.1.3-py3-none-any.whl (3.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.5/3.5 MB 116.3 MB/s eta 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.16.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 181.2 MB/s eta 0:00:00 Downloading docutils-0.21.2-py3-none-any.whl (587 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 366.5 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) Downloading packaging-24.2-py3-none-any.whl (65 kB) Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 365.8 MB/s eta 0:00:00 Downloading requests-2.32.3-py3-none-any.whl (64 kB) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB) Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB) Downloading certifi-2024.8.30-py3-none-any.whl (167 kB) Downloading charset_normalizer-3.4.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (142 kB) Downloading idna-3.10-py3-none-any.whl (70 kB) Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB) Downloading urllib3-2.2.3-py3-none-any.whl (126 kB) Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-1.0.0 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-24.2 requests-2.32.3 snowballstemmer-2.2.0 sphinx-8.1.3 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 urllib3-2.2.3
[rtd-command-info] start-time: 2024-11-19T23:56:56.096582Z, end-time: 2024-11-19T23:56:59.156352Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/source/requirements.txt Collecting sphinx_rtd_theme (from -r docs/source/requirements.txt (line 1)) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl.metadata (4.4 kB) Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from -r docs/source/requirements.txt (line 3)) (0.21.2) Collecting mistune<2.0.0 (from -r docs/source/requirements.txt (line 4)) Downloading mistune-0.8.4-py2.py3-none-any.whl.metadata (8.5 kB) Collecting requests<2.29.0 (from -r docs/source/requirements.txt (line 5)) Downloading requests-2.28.2-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: sphinx<9,>=6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (8.1.3) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) INFO: pip is looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Collecting sphinx_mdinclude (from -r docs/source/requirements.txt (line 2)) Downloading sphinx_mdinclude-0.6.1-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.6.0-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.4-py3-none-any.whl.metadata (4.6 kB) Downloading sphinx_mdinclude-0.5.3-py3-none-any.whl.metadata (4.1 kB) Downloading sphinx_mdinclude-0.5.2-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.1-py3-none-any.whl.metadata (4.0 kB) Downloading sphinx_mdinclude-0.5.0-py3-none-any.whl.metadata (4.0 kB) INFO: pip is still looking at multiple versions of sphinx-mdinclude to determine which version is compatible with other requirements. This could take a while. Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl.metadata (4.0 kB) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.4.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (3.10) Collecting urllib3<1.27,>=1.21.1 (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) Downloading urllib3-1.26.20-py2.py3-none-any.whl.metadata (50 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from requests<2.29.0->-r docs/source/requirements.txt (line 5)) (2024.8.30) Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.1.4) Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.18.0) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (2.16.0) Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.0.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (1.4.1) INFO: pip is looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-8.1.2-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.1-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.1.0-py3-none-any.whl.metadata (6.4 kB) Downloading sphinx-8.0.2-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.1-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-8.0.0-py3-none-any.whl.metadata (6.2 kB) Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB) Collecting alabaster~=0.7.14 (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) INFO: pip is still looking at multiple versions of sphinx to determine which version is compatible with other requirements. This could take a while. Collecting sphinx<9,>=6 (from sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) Downloading sphinx-7.4.6-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.5-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.4-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.3-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.2-py3-none-any.whl.metadata (6.1 kB) INFO: This is taking longer than usual. You might need to provide the dependency resolver with stricter constraints to reduce runtime. See https://pip.pypa.io/warnings/backtracking for guidance. If you want to abort this run, press Ctrl + C. Downloading sphinx-7.4.1-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.4.0-py3-none-any.whl.metadata (6.1 kB) Downloading sphinx-7.3.7-py3-none-any.whl.metadata (6.0 kB) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (24.2) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages (from Jinja2>=3.1->sphinx<9,>=6->sphinx_rtd_theme->-r docs/source/requirements.txt (line 1)) (3.0.2) Downloading sphinx_rtd_theme-3.0.2-py2.py3-none-any.whl (7.7 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.7/7.7 MB 143.1 MB/s eta 0:00:00 Downloading sphinx_mdinclude-0.4.0-py3-none-any.whl (14 kB) Downloading mistune-0.8.4-py2.py3-none-any.whl (16 kB) Downloading requests-2.28.2-py3-none-any.whl (62 kB) Downloading sphinx-7.3.7-py3-none-any.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 164.0 MB/s eta 0:00:00 Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Downloading urllib3-1.26.20-py2.py3-none-any.whl (144 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Installing collected packages: mistune, urllib3, sphinx_mdinclude, alabaster, requests, sphinx, sphinxcontrib-jquery, sphinx_rtd_theme Attempting uninstall: urllib3 Found existing installation: urllib3 2.2.3 Uninstalling urllib3-2.2.3: Successfully uninstalled urllib3-2.2.3 Attempting uninstall: alabaster Found existing installation: alabaster 1.0.0 Uninstalling alabaster-1.0.0: Successfully uninstalled alabaster-1.0.0 Attempting uninstall: requests Found existing installation: requests 2.32.3 Uninstalling requests-2.32.3: Successfully uninstalled requests-2.32.3 Attempting uninstall: sphinx Found existing installation: Sphinx 8.1.3 Uninstalling Sphinx-8.1.3: Successfully uninstalled Sphinx-8.1.3 Successfully installed alabaster-0.7.16 mistune-0.8.4 requests-2.28.2 sphinx-7.3.7 sphinx_mdinclude-0.4.0 sphinx_rtd_theme-3.0.2 sphinxcontrib-jquery-4.1 urllib3-1.26.20
[rtd-command-info] start-time: 2024-11-19T23:56:59.229935Z, end-time: 2024-11-19T23:56:59.285486Z, duration: 0, exit-code: 0 cat docs/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # http://www.sphinx-doc.org/en/master/config
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # # import os # import sys # sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'Open Vehicles' copyright = '2019-2024, Open Vehicles Developers' author = 'Open Vehicle Developers'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ 'sphinx_mdinclude', ]
# Add any paths that contain templates here, relative to this directory. templates_path = ['_templates']
# 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 = [ 'docs', '*/**.md', '*/wolfssl/*', '*/duktape/*', '*/mongoose/*', ]
master_doc = 'index'
# -- Source configuration ----------------------------------------------------
# - |clearfix| global substitution to clear floats (e.g. images) rst_epilog = """ .. |clearfix| raw:: html
<div class="clearfix"></div>
"""
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # #html_theme = 'default' html_theme = 'sphinx_rtd_theme'
# Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static']
html_context = { }
def setup(app): app.add_css_file('theme_overrides.css') app.add_css_file('copybutton.css') app.add_js_file('clipboard.min.js') app.add_js_file('copybutton.js')
[rtd-command-info] start-time: 2024-11-19T23:56:59.307664Z, end-time: 2024-11-19T23:56:59.818337Z, duration: 0, exit-code: 2 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.3.7
Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 453, in load_extension mod = import_module(extname) ^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/.asdf/installs/python/3.11.10/lib/python3.11/importlib/__init__.py", line 126, in import_module return _bootstrap._gcd_import(name[level:], package, level) ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "<frozen importlib._bootstrap>", line 1204, in _gcd_import File "<frozen importlib._bootstrap>", line 1176, in _find_and_load File "<frozen importlib._bootstrap>", line 1147, in _find_and_load_unlocked File "<frozen importlib._bootstrap>", line 690, in _load_unlocked File "<frozen importlib._bootstrap_external>", line 940, in exec_module File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx_mdinclude/__init__.py", line 17, in <module> from docutils.core import ErrorString ImportError: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)
The above exception was the direct cause of the following exception:
Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 332, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 229, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 402, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 456, in load_extension raise ExtensionError(__('Could not import extension %s') % extname, sphinx.errors.ExtensionError: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py))
Extension error: Could not import extension sphinx_mdinclude (exception: cannot import name 'ErrorString' from 'docutils.core' (/home/docs/checkouts/readthedocs.org/user_builds/ovms/envs/latest/lib/python3.11/site-packages/docutils/core.py)
On 20 Nov 2024, at 2:22 AM, Michael Balzer via OvmsDev <ovmsdev@lists.openvehicles.com> <mailto:ovmsdev@lists.openvehicles.com> wrote:
Signed PGP part 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 <mailto: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 _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com <mailto:OvmsDev@lists.openvehicles.com> http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
I have three ovms modules, two are in cars and one is on the bench. Most of the time they are on my home wifi. hologram used to bill me less often than once a month. But I noticed recently this had increased to about once every three days. When I looked at usage (see attached) things changed in early January. I keep an archive of the builds I've run. On January 8th I upgraded from 3.3.004-246-ge9decc46 (September 8th, 2024) to 3.3.004-332-gadce9471. That seems to be when hologram usage increased. Last week I upgraded to 3.3.004-382-ge83be0e7 but usage still seems high. I looked a per-sim usage and though I put similar miles on each car in a month, one is 50% higher than the other. But even the dev unit is way higher than I would expect for a module that is *always* in range of wifi. What am I missing? Craig # ovms-z OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1 # ovms-v OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -79 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1 # dev OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
Craig, Can you show your ‘module summary’ so we can see what is running? In particular just v2 or also v3 server? The only other time I’ve seen something similar is where the module was in poor connectivity - causing it to reconnect frequently and leading to very small connection data transfers (which Hologram and other providers round-up). Regards, Mark.
On 20 Feb 2025, at 7:06 AM, Craig Leres via OvmsDev <ovmsdev@lists.openvehicles.com> wrote:
I have three ovms modules, two are in cars and one is on the bench. Most of the time they are on my home wifi.
hologram used to bill me less often than once a month. But I noticed recently this had increased to about once every three days. When I looked at usage (see attached) things changed in early January.
I keep an archive of the builds I've run. On January 8th I upgraded from 3.3.004-246-ge9decc46 (September 8th, 2024) to 3.3.004-332-gadce9471. That seems to be when hologram usage increased.
Last week I upgraded to 3.3.004-382-ge83be0e7 but usage still seems high. I looked a per-sim usage and though I put similar miles on each car in a month, one is 50% higher than the other. But even the dev unit is way higher than I would expect for a module that is *always* in range of wifi.
What am I missing?
Craig
# ovms-z OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
# ovms-v OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -79 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
# dev OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1 <hologram.png><persim.png>_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Craig, I cannot see how the modem in your bench module "dev" could cause >8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level. The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you. You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers. Looking forward to your findings. Regards, Michael Am 06.04.25 um 19:48 schrieb Craig Leres:
I'm still hunting the regression that causes high hologram usage. My search so far shows:
3.3.004-298-gd00134c2 16Nov24 good 3.3.004-327-ge8bac6d4 31Dec24 bad
I just built/booted 3.3.004-323-gbc1f75c9 (24Nov24). I've been letting test versions run at least a few days before checking the hologram dashboard usage graph. But I must admit, once I found a version that I got the charges down from $45/month (back to ~$5/month), I've been less aggressive in my testing.
Craig
Am 20.02.25 um 00:06 schrieb Craig Leres via OvmsDev:
I have three ovms modules, two are in cars and one is on the bench. Most of the time they are on my home wifi.
hologram used to bill me less often than once a month. But I noticed recently this had increased to about once every three days. When I looked at usage (see attached) things changed in early January.
I keep an archive of the builds I've run. On January 8th I upgraded from 3.3.004-246-ge9decc46 (September 8th, 2024) to 3.3.004-332-gadce9471. That seems to be when hologram usage increased.
Last week I upgraded to 3.3.004-382-ge83be0e7 but usage still seems high. I looked a per-sim usage and though I put similar miles on each car in a month, one is 50% higher than the other. But even the dev unit is way higher than I would expect for a module that is *always* in range of wifi.
What am I missing?
Craig
# ovms-z OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
# ovms-v OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -79 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
# dev OVMS# cell MODEM Status Model: SIM7600 Network Registration: RegisteredRoaming Provider: T-Mobile Hologram Signal: -85 dBm Mode: LTE,Online State: NetMode Mux: Status up PPP: Connected on channel: #2 GPS: Connected on channel: #1
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
On 4/9/25 10:54, Michael Balzer via OvmsDev wrote:
I cannot see how the modem in your bench module "dev" could cause >8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level.
The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you.
You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers.
Looking forward to your findings.
The version that causes problems for me is 3.3.004-324-g367f6b95 All modules are using a lot more cellular data but one in particular stands out. It's the one with the lowest wifi dBm but it's not *that* bad, but it makes me wonder if there is some kind of wifi power saving that's making wifi frequently unavailable causing cellular data usage (combined with something in this version that is 10X as chatty -- I suspect fixing this will get my usage back down). Craig # ovms-dev OVMS# wifi Power: on Mode: Client mode STA SSID: Team America (-30.6 dBm) [fixed] MAC: 94:b9:7e:ff:ff:ff IP: 172.16.1.299/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff # ovms-v OVMS# wifi Power: on Mode: Client mode STA SSID: Team America (-60.7 dBm) [fixed] MAC: 94:b9:7e:ff:ff:ff IP: 172.16.1.298/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff # ovms-z OVMS# wifi Power: on Mode: Client mode STA SSID: Team America (-64.7 dBm) [fixed] MAC: 24:d7:eb:ff:ff:ff IP: 172.16.1.297/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff
Am 10.04.25 um 19:16 schrieb Craig Leres:
On 4/9/25 10:54, Michael Balzer via OvmsDev wrote:
I cannot see how the modem in your bench module "dev" could cause >8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level.
The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you.
You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers.
Looking forward to your findings.
The version that causes problems for me is 3.3.004-324-g367f6b95
That would be commit 367f6b950f62adef04c8c877f5e29889e6e22c64, which only included minor changes to the e-Up module, so that can be ruled out as the causing commit. https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/commit/367f...
All modules are using a lot more cellular data but one in particular stands out. It's the one with the lowest wifi dBm but it's not *that* bad, but it makes me wonder if there is some kind of wifi power saving that's making wifi frequently unavailable causing cellular data usage (combined with something in this version that is 10X as chatty -- I suspect fixing this will get my usage back down).
Did you check your network wifi SQ & reconnect settings? Not that they would make any difference from that commit, but maybe it's not the commit but some random Wifi fluctuation causing an occasional switch to cellular. That should be clearly visible in the logs though. Regards, Michael
Craig
# ovms-dev OVMS# wifi Power: on Mode: Client mode
STA SSID: Team America (-30.6 dBm) [fixed] MAC: 94:b9:7e:ff:ff:ff IP: 172.16.1.299/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff
# ovms-v OVMS# wifi Power: on Mode: Client mode
STA SSID: Team America (-60.7 dBm) [fixed] MAC: 94:b9:7e:ff:ff:ff IP: 172.16.1.298/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff
# ovms-z OVMS# wifi Power: on Mode: Client mode
STA SSID: Team America (-64.7 dBm) [fixed] MAC: 24:d7:eb:ff:ff:ff IP: 172.16.1.297/255.255.255.0 GW: 172.16.1.1 AP: 30:87:d9:ff:ff:ff
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
On 4/10/25 13:30, Michael Balzer via OvmsDev wrote:
Am 10.04.25 um 19:16 schrieb Craig Leres:
On 4/9/25 10:54, Michael Balzer via OvmsDev wrote:
I cannot see how the modem in your bench module "dev" could cause >8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level.
The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you.
You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers.
Looking forward to your findings.
The version that causes problems for me is 3.3.004-324-g367f6b95
That would be commit 367f6b950f62adef04c8c877f5e29889e6e22c64, which only included minor changes to the e-Up module, so that can be ruled out as the causing commit.
https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/ commit/367f6b950f62adef04c8c877f5e29889e6e22c64
My testing found: 3.3.004-323-gbc1f75c9 24Nov24 good 3.3.004-324-g367f6b95 25Nov24 BAD When I run: git diff bc1f75c9 367f6b95 I see a *lot* more changes than in the url you show above. I guess there are somehow multiple commits hidden in the range between 323 and 324?
All modules are using a lot more cellular data but one in particular stands out. It's the one with the lowest wifi dBm but it's not *that* bad, but it makes me wonder if there is some kind of wifi power saving that's making wifi frequently unavailable causing cellular data usage (combined with something in this version that is 10X as chatty -- I suspect fixing this will get my usage back down).
Did you check your network wifi SQ & reconnect settings?
I don't know what those are (and it seems to be somewhat of a POLA violation that the default config would use 10X the cellular data (especially for modules that are on wifi).
Not that they would make any difference from that commit, but maybe it's not the commit but some random Wifi fluctuation causing an occasional switch to cellular.
That should be clearly visible in the logs though.
I guess I have more commit hashes to test. Craig
Am 10.04.25 um 22:44 schrieb Craig Leres:
On 4/10/25 13:30, Michael Balzer via OvmsDev wrote:
Am 10.04.25 um 19:16 schrieb Craig Leres:
On 4/9/25 10:54, Michael Balzer via OvmsDev wrote:
I cannot see how the modem in your bench module "dev" could cause
8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level.
The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you.
You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers.
Looking forward to your findings.
The version that causes problems for me is 3.3.004-324-g367f6b95
That would be commit 367f6b950f62adef04c8c877f5e29889e6e22c64, which only included minor changes to the e-Up module, so that can be ruled out as the causing commit.
https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/ commit/367f6b950f62adef04c8c877f5e29889e6e22c64
My testing found:
3.3.004-323-gbc1f75c9 24Nov24 good 3.3.004-324-g367f6b95 25Nov24 BAD
When I run:
git diff bc1f75c9 367f6b95
I see a *lot* more changes than in the url you show above.
I guess there are somehow multiple commits hidden in the range between 323 and 324?
bc1f75c9 is not a master branch commit… it's a merge of the master state 470979369be56fe18eae0df90f1619afdd27e850 into Dimitrie's SmartEQ development branch. I'd recommend strictly sticking to the master branch. git bisect normally does that by itself, so I guess you're doing a manual search?
All modules are using a lot more cellular data but one in particular stands out. It's the one with the lowest wifi dBm but it's not *that* bad, but it makes me wonder if there is some kind of wifi power saving that's making wifi frequently unavailable causing cellular data usage (combined with something in this version that is 10X as chatty -- I suspect fixing this will get my usage back down).
Did you check your network wifi SQ & reconnect settings?
I don't know what those are (and it seems to be somewhat of a POLA violation that the default config would use 10X the cellular data (especially for modules that are on wifi).
The defaults do not cause any issues, my suspicion is you maybe accidentally changed them during some test. The defaults are shown here: https://docs.openvehicles.com/en/latest/userguide/wifi.html#wifi-signal-qual... Regards, Michael
Not that they would make any difference from that commit, but maybe it's not the commit but some random Wifi fluctuation causing an occasional switch to cellular.
That should be clearly visible in the logs though.
I guess I have more commit hashes to test.
Craig
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
On 4/10/25 14:12, Michael Balzer via OvmsDev wrote:
Am 10.04.25 um 22:44 schrieb Craig Leres:
On 4/10/25 13:30, Michael Balzer via OvmsDev wrote:
Am 10.04.25 um 19:16 schrieb Craig Leres:
On 4/9/25 10:54, Michael Balzer via OvmsDev wrote:
I cannot see how the modem in your bench module "dev" could cause
8 MB network traffic when the module has Wifi all the time, except by many reconnects + Hologram counting these as traffic (which I think they shouldn't and don't do), or by the module not using Wifi due to a test or very poor signal level.
The only modem change coming to my mind is the GSM signal quality extension by Jaime, which initially had switched good & bad signal levels. But that wouldn't have triggered a modem reconnect, rather reboots, and that wouldn't have gone unnoticed by you.
You can check the cellular reconnect count from "cellular status debug". Of course that only counts reconnects that need an IP renegotiation, not transparent transitions to other cell towers.
Looking forward to your findings.
The version that causes problems for me is 3.3.004-324-g367f6b95
That would be commit 367f6b950f62adef04c8c877f5e29889e6e22c64, which only included minor changes to the e-Up module, so that can be ruled out as the causing commit.
https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3/ commit/367f6b950f62adef04c8c877f5e29889e6e22c64
My testing found:
3.3.004-323-gbc1f75c9 24Nov24 good 3.3.004-324-g367f6b95 25Nov24 BAD
When I run:
git diff bc1f75c9 367f6b95
I see a *lot* more changes than in the url you show above.
I guess there are somehow multiple commits hidden in the range between 323 and 324?
bc1f75c9 is not a master branch commit… it's a merge of the master state 470979369be56fe18eae0df90f1619afdd27e850 into Dimitrie's SmartEQ development branch.
I'd recommend strictly sticking to the master branch. git bisect normally does that by itself, so I guess you're doing a manual search?
All modules are using a lot more cellular data but one in particular stands out. It's the one with the lowest wifi dBm but it's not *that* bad, but it makes me wonder if there is some kind of wifi power saving that's making wifi frequently unavailable causing cellular data usage (combined with something in this version that is 10X as chatty -- I suspect fixing this will get my usage back down).
Did you check your network wifi SQ & reconnect settings?
I don't know what those are (and it seems to be somewhat of a POLA violation that the default config would use 10X the cellular data (especially for modules that are on wifi).
The defaults do not cause any issues, my suspicion is you maybe accidentally changed them during some test.
The defaults are shown here: https://docs.openvehicles.com/en/latest/ userguide/wifi.html#wifi-signal-quality
I think this says I haven't set anything in the "network" param: OVMS# config list network network (readable writeable) dns: (all three modules are the same). I'm now testing 3.3.004-313-g78a49a59 (which is older than 3.3.004-323-gbc1f75c9, yet another git annoyance for me that the hashes are not chronological...) But I think it has one change that 3.3.004-313-g78a49a59 does not. Craig
On 4/10/25 14:21, Craig Leres via OvmsDev wrote:
I'm now testing 3.3.004-313-g78a49a59 (which is older than 3.3.004-323- gbc1f75c9, yet another git annoyance for me that the hashes are not chronological...) But I think it has one change that 3.3.004-313- g78a49a59 does not.
It looks like 78a49a59 is the source of my hologram usage increase. I see these: + m_updatetime_keepalive = 29*60; + m_legacy_event_topic = true; But m_legacy_event_topic doesn't look like it has an impact (mg_mqtt_publish() still gets called). However, this worries me: + [server.v3] updatetime.keepalive -- Max number of seconds to allow the MQTT connection to be idle before + sending PINGREQ. Should be set slightly shorter than the network's + NAT timeout and the timeout of your MQTT server. If these are unknown + you can use trial and error. Symptoms of keepalive being too high are + a lack of metric updates after a certain point, or "Disconnected from + OVMS Server V3" appearing in the log. In previous releases this used + the Mongoose default of 60. New default value 1740 aligns with + observed Hologram timeout of 1800. but, again, not clear how it can drive up cellular usage when I'm on wifi. (Unless there is some kind of wifi-sleep mode happening that causes cellular to be used?) So maybe this is just triggering a previously latent bug? Anyway, I don't see how to disable this short of commenting code out. Craig OVMS# config list server.v3 server.v3 (readable writeable) port: server: example.net tls: yes topic.prefix: updatetime.connected: updatetime.idle: user: fred
Craig, if (?) you're running a server v3 instance with the shown "example.net" config, the keepalive is not your main issue, as it will keep retrying to connect indefinitely. But it would have done so all the time already. Regarding wifi/cellular, did you check your logs yet for unexpected switches? Regards, Michael Am 16.04.25 um 19:07 schrieb Craig Leres via OvmsDev:
On 4/10/25 14:21, Craig Leres via OvmsDev wrote:
I'm now testing 3.3.004-313-g78a49a59 (which is older than 3.3.004-323- gbc1f75c9, yet another git annoyance for me that the hashes are not chronological...) But I think it has one change that 3.3.004-313- g78a49a59 does not.
It looks like 78a49a59 is the source of my hologram usage increase. I see these:
+ m_updatetime_keepalive = 29*60; + m_legacy_event_topic = true;
But m_legacy_event_topic doesn't look like it has an impact (mg_mqtt_publish() still gets called).
However, this worries me:
+ [server.v3] updatetime.keepalive -- Max number of seconds to allow the MQTT connection to be idle before + sending PINGREQ. Should be set slightly shorter than the network's + NAT timeout and the timeout of your MQTT server. If these are unknown + you can use trial and error. Symptoms of keepalive being too high are + a lack of metric updates after a certain point, or "Disconnected from + OVMS Server V3" appearing in the log. In previous releases this used + the Mongoose default of 60. New default value 1740 aligns with + observed Hologram timeout of 1800.
but, again, not clear how it can drive up cellular usage when I'm on wifi. (Unless there is some kind of wifi-sleep mode happening that causes cellular to be used?) So maybe this is just triggering a previously latent bug?
Anyway, I don't see how to disable this short of commenting code out.
Craig
OVMS# config list server.v3 server.v3 (readable writeable) port: server: example.net tls: yes topic.prefix: updatetime.connected: updatetime.idle: user: fred
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
On 4/17/25 00:50, Michael Balzer via OvmsDev wrote:
if (?) you're running a server v3 instance with the shown "example.net" config, the keepalive is not your main issue, as it will keep retrying to connect indefinitely. But it would have done so all the time already.
Regarding wifi/cellular, did you check your logs yet for unexpected switches?
I'm not sure how to do that. What logging level should I be using for this? I'll attach some logs for a 24 hour period when I was running 3.3.004-313-g78a49a59 FYI, I'm going to have to stop investigating for a bit so don't think I've forgotten about it if you don't hear from me for a few weeks... Craig
As you're looking for a network issue, setting level debug for netmanager, cellular and esp32wifi might help. Your log shows you actually do use server-v3 with your own server at xse.com, and your log shows there are wifi reconnects to the same network every four minutes. With the running v3 client, each reconnect means a full retransmission of all metrics, as also logged. If that 4 minute period also occurs while on cellular, that's your culprit. Regards, Michael Am 17.04.25 um 21:20 schrieb Craig Leres:
On 4/17/25 00:50, Michael Balzer via OvmsDev wrote:
if (?) you're running a server v3 instance with the shown "example.net" config, the keepalive is not your main issue, as it will keep retrying to connect indefinitely. But it would have done so all the time already.
Regarding wifi/cellular, did you check your logs yet for unexpected switches?
I'm not sure how to do that.
What logging level should I be using for this?
I'll attach some logs for a 24 hour period when I was running 3.3.004-313-g78a49a59
FYI, I'm going to have to stop investigating for a bit so don't think I've forgotten about it if you don't hear from me for a few weeks...
Craig
-- Michael Balzer * Am Rahmen 5 * D-58313 Herdecke Fon 02330 9104094 * Handy 0176 20698926
On 4/18/25 00:03, Michael Balzer via OvmsDev wrote:
As you're looking for a network issue, setting level debug for netmanager, cellular and esp32wifi might help.
Ok, I'll report back later after turning those on.
Your log shows you actually do use server-v3 with your own server at xse.com, and your log shows there are wifi reconnects to the same network every four minutes.
With the running v3 client, each reconnect means a full retransmission of all metrics, as also logged. If that 4 minute period also occurs while on cellular, that's your culprit.
I'm still not understanding what changed in 3.3.004-313-g78a49a59 to increase cellular usage by 10X. My AP is a ruckus R710. I checked and the "inactivity timeout" is not enabled for the ssid used. It looks to me as if the wifi goes to sleep and the module switches to cellular instead of re-connecting to wifi. Maybe it takes longer for the wifi to re-connect than the code is willing to wait before switching to celluar? Craig
Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ. The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo) All this is available in the branch lilygo-support of https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo... My question to the main developers: Is there interest to incorporate this into the official OVMS repository? Best regards Christian
Hi Christian, very impressive. You did a great job on the development and on the documentation. It is good to have an alternative hardware option. As you mentioned, it is a disadvantage that OTA is not possible, but that seems to be the price for a cheaper hardware. Other obstacles I see, is that the hardware seems only available directly from China and that we need to build our own motherboard. That is for me the greatest hurdle, alltough you did a great documentation with the Eagle schematics. I would like to test your hardware approach, if the hardware would be available as a "ready to go" kit. Are you planning on providing such a kit? I could definitly see this as part of the OVMS repository. Lets see what the other opinions on that are :-) Regards Chris Am Samstag, dem 26.04.2025 um 17:40 +0200 schrieb Info via OvmsDev:
Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ.
The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module
There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support
The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo)
All this is available in the branch lilygo-support of https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo...
My question to the main developers: Is there interest to incorporate this into the official OVMS repository?
Best regards Christian
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Hi Chris and Mark, thanks for your positive responses. The Simcom modem is already supported by my last PR, so no extra configuration required. This is independent from the hardware selection. The currently used single config CONFIG_OVMS_HW_BASE_LILYGO_1_0 takes care of 2 things: - Change the pin assignment of the ESP32 to match the Lilygo module and the motherboard - Reassign required signals of the GPIO extender chip max7317 to ESP32 IO pins. This is only related to the powering of the modem. Thats all. The latter can easily be handled by an alternative config, if the max7317 is disabled. But there is the need to handle an alternative IO mapping in ovms_peripherals.h and this is very specific for the Lilygo/motherboard combination. I do not care, whether this is handled as a separate HW version, or is achieved by just an additional optional config to rearrange pins. To keep it completely flexible, a free pin mapping could be available via menuconfig or an extra file, but that might be too error prone. Concerning the availability of the hardware: at this stage, I will not be able to provide kits for this hardware option. Probably someone else is interested doing this? Chris, if you are interested to test it, I could provide you with a partially assembled motherboard (most passive components and the DC/DC converter). As far as I see, you are located in Germany as well, so shipment would be no problem. Best regards Christian Am 27.04.2025 um 14:44 schrieb Mark Webb-Johnson via OvmsDev:
Chris,
I guess if somebody wanted to, it could be available as an unsoldered kit of Pcb and parts. The problem with assembled kits is CE (and ROHS) certification for sale in EU, but unsoldered kits are generally considered exempted from that (although the radio / antenna part of it is a gray area).
Regards, Mark
On Apr 27, 2025, at 3:03 PM, Chris van der Meijden via OvmsDev <ovmsdev@lists.openvehicles.com> wrote:
Hi Christian,
very impressive. You did a great job on the development and on the documentation.
It is good to have an alternative hardware option.
As you mentioned, it is a disadvantage that OTA is not possible, but that seems to be the price for a cheaper hardware. Other obstacles I see, is that the hardware seems only available directly from China and that we need to build our own motherboard. That is for me the greatest hurdle, alltough you did a great documentation with the Eagle schematics.
I would like to test your hardware approach, if the hardware would be available as a "ready to go" kit. Are you planning on providing such a kit?
I could definitly see this as part of the OVMS repository. Lets see what the other opinions on that are :-)
Regards
Chris
Am Samstag, dem 26.04.2025 um 17:40 +0200 schrieb Info via OvmsDev:
Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ.
The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module
There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support
The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo)
All this is available in the branch lilygo-support of https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo...
My question to the main developers: Is there interest to incorporate this into the official OVMS repository?
Best regards Christian
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Hi Christian, really nice work, thanks. I immediately ordered 5 PCBs and will test it on my electric scooter from NIU which has a CAN bus and I did some reverse engineering already. Only the high price of an OVMS 3.3 module was holding me back :-) Greetings from Germany Carsten ________________________________ Von: OvmsDev <ovmsdev-bounces@lists.openvehicles.com> im Auftrag von Info Zeitnitz via OvmsDev <ovmsdev@lists.openvehicles.com> Gesendet: Montag, 28. April 2025 14:24:32 An: ovmsdev@lists.openvehicles.com Cc: Info Zeitnitz Betreff: Re: [Ovmsdev] Support for Lilygo T-Call based module Hi Chris and Mark, thanks for your positive responses. The Simcom modem is already supported by my last PR, so no extra configuration required. This is independent from the hardware selection. The currently used single config CONFIG_OVMS_HW_BASE_LILYGO_1_0 takes care of 2 things: - Change the pin assignment of the ESP32 to match the Lilygo module and the motherboard - Reassign required signals of the GPIO extender chip max7317 to ESP32 IO pins. This is only related to the powering of the modem. Thats all. The latter can easily be handled by an alternative config, if the max7317 is disabled. But there is the need to handle an alternative IO mapping in ovms_peripherals.h and this is very specific for the Lilygo/motherboard combination. I do not care, whether this is handled as a separate HW version, or is achieved by just an additional optional config to rearrange pins. To keep it completely flexible, a free pin mapping could be available via menuconfig or an extra file, but that might be too error prone. Concerning the availability of the hardware: at this stage, I will not be able to provide kits for this hardware option. Probably someone else is interested doing this? Chris, if you are interested to test it, I could provide you with a partially assembled motherboard (most passive components and the DC/DC converter). As far as I see, you are located in Germany as well, so shipment would be no problem. Best regards Christian Am 27.04.2025 um 14:44 schrieb Mark Webb-Johnson via OvmsDev: Chris, I guess if somebody wanted to, it could be available as an unsoldered kit of Pcb and parts. The problem with assembled kits is CE (and ROHS) certification for sale in EU, but unsoldered kits are generally considered exempted from that (although the radio / antenna part of it is a gray area). Regards, Mark On Apr 27, 2025, at 3:03 PM, Chris van der Meijden via OvmsDev <ovmsdev@lists.openvehicles.com><mailto:ovmsdev@lists.openvehicles.com> wrote: Hi Christian, very impressive. You did a great job on the development and on the documentation. It is good to have an alternative hardware option. As you mentioned, it is a disadvantage that OTA is not possible, but that seems to be the price for a cheaper hardware. Other obstacles I see, is that the hardware seems only available directly from China and that we need to build our own motherboard. That is for me the greatest hurdle, alltough you did a great documentation with the Eagle schematics. I would like to test your hardware approach, if the hardware would be available as a "ready to go" kit. Are you planning on providing such a kit? I could definitly see this as part of the OVMS repository. Lets see what the other opinions on that are :-) Regards Chris Am Samstag, dem 26.04.2025 um 17:40 +0200 schrieb Info via OvmsDev: Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ. The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo) All this is available in the branch lilygo-support of https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo... My question to the main developers: Is there interest to incorporate this into the official OVMS repository? Best regards Christian _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com<mailto:OvmsDev@lists.openvehicles.com> http://lists.openvehicles.com/mailman/listinfo/ovmsdev _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com<mailto:OvmsDev@lists.openvehicles.com> http://lists.openvehicles.com/mailman/listinfo/ovmsdev _______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com<mailto:OvmsDev@lists.openvehicles.com> http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Hi Christian Thank you for your generous offer. I'm deep into other projects at the moment, so I woukd not feel comfortable when your hardware would be laying around at my place and I would not be spending the time with it it deserves. And as Carsten now jumped in, there will be some good team testing. So thank you again. I will be following the development with great interest and surely will step into this hardware somewhere in the future. Success Chris Am Montag, dem 28.04.2025 um 15:16 +0000 schrieb Carsten Schmiemann via OvmsDev:
Hi Christian,
really nice work, thanks.
I immediately ordered 5 PCBs and will test it on my electric scooter from NIU which has a CAN bus and I did some reverse engineering already. Only the high price of an OVMS 3.3 module was holding me back :-)
Greetings from Germany Carsten Von: OvmsDev <ovmsdev-bounces@lists.openvehicles.com> im Auftrag von Info Zeitnitz via OvmsDev <ovmsdev@lists.openvehicles.com> Gesendet: Montag, 28. April 2025 14:24:32 An: ovmsdev@lists.openvehicles.com Cc: Info Zeitnitz Betreff: Re: [Ovmsdev] Support for Lilygo T-Call based module Hi Chris and Mark, thanks for your positive responses.
The Simcom modem is already supported by my last PR, so no extra configuration required. This is independent from the hardware selection.
The currently used single config CONFIG_OVMS_HW_BASE_LILYGO_1_0 takes care of 2 things: - Change the pin assignment of the ESP32 to match the Lilygo module and the motherboard - Reassign required signals of the GPIO extender chip max7317 to ESP32 IO pins. This is only related to the powering of the modem. Thats all. The latter can easily be handled by an alternative config, if the max7317 is disabled. But there is the need to handle an alternative IO mapping in ovms_peripherals.h and this is very specific for the Lilygo/motherboard combination. I do not care, whether this is handled as a separate HW version, or is achieved by just an additional optional config to rearrange pins. To keep it completely flexible, a free pin mapping could be available via menuconfig or an extra file, but that might be too error prone. Concerning the availability of the hardware: at this stage, I will not be able to provide kits for this hardware option. Probably someone else is interested doing this? Chris, if you are interested to test it, I could provide you with a partially assembled motherboard (most passive components and the DC/DC converter). As far as I see, you are located in Germany as well, so shipment would be no problem. Best regards Christian
Am 27.04.2025 um 14:44 schrieb Mark Webb-Johnson via OvmsDev:
Chris,
I guess if somebody wanted to, it could be available as an unsoldered kit of Pcb and parts. The problem with assembled kits is CE (and ROHS) certification for sale in EU, but unsoldered kits are generally considered exempted from that (although the radio / antenna part of it is a gray area).
Regards, Mark
On Apr 27, 2025, at 3:03 PM, Chris van der Meijden via OvmsDev<ovmsdev@lists.openvehicles.com> wrote:
Hi Christian,
very impressive. You did a great job on the development and on the documentation.
It is good to have an alternative hardware option.
As you mentioned, it is a disadvantage that OTA is not possible, but that seems to be the price for a cheaper hardware. Other obstacles I see, is that the hardware seems only available directly from China and that we need to build our own motherboard. That is for me the greatest hurdle, alltough you did a great documentation with the Eagle schematics.
I would like to test your hardware approach, if the hardware would be available as a "ready to go" kit. Are you planning on providing such a kit?
I could definitly see this as part of the OVMS repository. Lets see what the other opinions on that are :-)
Regards
Chris
Am Samstag, dem 26.04.2025 um 17:40 +0200 schrieb Info via OvmsDev:
Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ.
The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module
There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support
The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo)
All this is available in the branch lilygo-support of
https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo...
My question to the main developers: Is there interest to incorporate this into the official OVMS repository?
Best regards Christian
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Hi Chris and Casten, ok, very good. Carsten, if you experience any problems, please get in touch with me. Best regards. Christian Am 29. April 2025 07:10:22 schrieb Chris van der Meijden via OvmsDev <ovmsdev@lists.openvehicles.com>:
Hi Christian
Thank you for your generous offer.
I'm deep into other projects at the moment, so I woukd not feel comfortable when your hardware would be laying around at my place and I would not be spending the time with it it deserves.
And as Carsten now jumped in, there will be some good team testing.
So thank you again. I will be following the development with great interest and surely will step into this hardware somewhere in the future.
Success
Chris
Am Montag, dem 28.04.2025 um 15:16 +0000 schrieb Carsten Schmiemann via OvmsDev:
Hi Christian,
really nice work, thanks.
I immediately ordered 5 PCBs and will test it on my electric scooter from NIU which has a CAN bus and I did some reverse engineering already. Only the high price of an OVMS 3.3 module was holding me back :-)
Greetings from Germany
Carsten
Von: OvmsDev <ovmsdev-bounces@lists.openvehicles.com> im Auftrag von Info Zeitnitz via OvmsDev <ovmsdev@lists.openvehicles.com> Gesendet: Montag, 28. April 2025 14:24:32 An: ovmsdev@lists.openvehicles.com Cc: Info Zeitnitz Betreff: Re: [Ovmsdev] Support for Lilygo T-Call based module Hi Chris and Mark, thanks for your positive responses.
The Simcom modem is already supported by my last PR, so no extra configuration required. This is independent from the hardware selection.
The currently used single config CONFIG_OVMS_HW_BASE_LILYGO_1_0 takes care of 2 things: - Change the pin assignment of the ESP32 to match the Lilygo module and the motherboard - Reassign required signals of the GPIO extender chip max7317 to ESP32 IO pins. This is only related to the powering of the modem. Thats all. The latter can easily be handled by an alternative config, if the max7317 is disabled. But there is the need to handle an alternative IO mapping in ovms_peripherals.h and this is very specific for the Lilygo/motherboard combination. I do not care, whether this is handled as a separate HW version, or is achieved by just an additional optional config to rearrange pins. To keep it completely flexible, a free pin mapping could be available via menuconfig or an extra file, but that might be too error prone. Concerning the availability of the hardware: at this stage, I will not be able to provide kits for this hardware option. Probably someone else is interested doing this? Chris, if you are interested to test it, I could provide you with a partially assembled motherboard (most passive components and the DC/DC converter). As far as I see, you are located in Germany as well, so shipment would be no problem. Best regards Christian
Am 27.04.2025 um 14:44 schrieb Mark Webb-Johnson via OvmsDev:
Chris,
I guess if somebody wanted to, it could be available as an unsoldered kit of Pcb and parts. The problem with assembled kits is CE (and ROHS) certification for sale in EU, but unsoldered kits are generally considered exempted from that (although the radio / antenna part of it is a gray area).
Regards, Mark
On Apr 27, 2025, at 3:03 PM, Chris van der Meijden via OvmsDev<ovmsdev@lists.openvehicles.com> wrote: Hi Christian,
very impressive. You did a great job on the development and on the documentation.
It is good to have an alternative hardware option.
As you mentioned, it is a disadvantage that OTA is not possible, but that seems to be the price for a cheaper hardware. Other obstacles I see, is that the hardware seems only available directly from China and that we need to build our own motherboard. That is for me the greatest hurdle, alltough you did a great documentation with the Eagle schematics.
I would like to test your hardware approach, if the hardware would be available as a "ready to go" kit. Are you planning on providing such a kit?
I could definitly see this as part of the OVMS repository. Lets see what the other opinions on that are :-)
Regards
Chris
Am Samstag, dem 26.04.2025 um 17:40 +0200 schrieb Info via OvmsDev:
Hi,
I finished the implementation and documentation of the OVMS module based
on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E).
The module is in operation since more than a month in my Smart EQ.
The hardware details can be found here:
https://github.com/zbchristian/OVMS-Lilygo-based-Module
There are some limitations wrt the standard module:
- only 4MB Flash -> no OTA update
- no GPIO extender -> only 2 CAN buses
- no SD-card support
The required modification in the firmware:
- remapping of the ESP32 pins in ovms_peripherals
- replace some of the GPIO extender pins by standard ESP32 pins
- new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y)
- Simcom 7670 modem support (already available in the OVMS repo)
All this is available in the branch lilygo-support of
https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo...
My question to the main developers: Is there interest to incorporate
this into the official OVMS repository?
Best regards
Christian
_______________________________________________
OvmsDev mailing list
OvmsDev@lists.openvehicles.com
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
Looks good, although the limitations like OTA worry me. A shame these companies don’t spend the extra one dollar to use 16MB flash. Unless this is a generally available standard hardware, my suggestions for integration to the main code repository are: 1. Don’t use one single config (CONFIG_OVMS_HW_BASE_LILYGO_1_0) to turn it on/off. 2. Instead, introduce specific configs (either in kconfig or via a run-time config setting) for each hardware component that needs customisation. Leave the default as standard OVMS hardware. It may be better to come up with a standard framework for this (such as a config for can1, can2, can3, modem power, … each individual component, to specify whether it is enabled/disabled and if enabled then which peripheral it is on) - likely the existing runtime pcp framework could handle this. 3. The Simcom can be incorporated directly as a main component (the cellular system already supports auto-detect as well as manual configuration of modem driver). That way, firmware for this or other alternatives can be built simply, without requiring fork and all the hassle that comes with maintaining that. Regards, Mark
On Apr 26, 2025, at 11:41 PM, Info via OvmsDev <ovmsdev@lists.openvehicles.com> wrote:
Hi, I finished the implementation and documentation of the OVMS module based on the Lilygo T-Call A7670E board (ESP32 WROVER E and a Simcom A7670E). The module is in operation since more than a month in my Smart EQ.
The hardware details can be found here: https://github.com/zbchristian/OVMS-Lilygo-based-Module
There are some limitations wrt the standard module: - only 4MB Flash -> no OTA update - no GPIO extender -> only 2 CAN buses - no SD-card support
The required modification in the firmware: - remapping of the ESP32 pins in ovms_peripherals - replace some of the GPIO extender pins by standard ESP32 pins - new hardware option in menuconfig (set CONFIG_OVMS_HW_BASE_LILYGO_1_0=y) - Simcom 7670 modem support (already available in the OVMS repo)
All this is available in the branch lilygo-support of https://github.com/zbchristian/Open-Vehicle-Monitoring-System-3-Lilygo-Suppo...
My question to the main developers: Is there interest to incorporate this into the official OVMS repository?
Best regards Christian
_______________________________________________ OvmsDev mailing list OvmsDev@lists.openvehicles.com http://lists.openvehicles.com/mailman/listinfo/ovmsdev
On 4/18/25 12:57, Craig Leres wrote:
On 4/18/25 00:03, Michael Balzer via OvmsDev wrote:
As you're looking for a network issue, setting level debug for netmanager, cellular and esp32wifi might help.
Ok, I'll report back later after turning those on.
Catching up after being out of town for almost a month. I have these components set to debug logging: canlog-monitor cellular esp32wifi netmanager Attached is a log with 3.3.004-313-g78a49a59 which I booted on May 10th. (I anonymized the GPS locations.) My other two modules are still running 3.3.004-323-gbc1f75c9 so the huge increase in cellular usage is purely due to a single module. Craig
participants (9)
-
Carsten Schmiemann -
Chris van der Meijden -
Christian Zeitnitz -
Craig Leres -
Info
-
Info Zeitnitz
-
Mark Webb-Johnson -
Michael Balzer -
Michael Geddes