<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
</head>
<body>
Mark,<br>
<br>
I can login to readthedocs.com using my Github account (dexterbg).<br>
<br>
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:<br>
<br>
mistune<2.0.0<br>
requests<2.29.0<br>
<br>
Was that necessary for m2r2? If so, maybe try without, so pip
determines the best match?<br>
<br>
Manually installing sphinx_mdinclude on my machine produced this
constellation:<br>
<br>
<font face="monospace">sphinx_mdinclude 0.6.2<br>
mistune 3.0.2<br>
requests 2.32.3</font><br>
<br>
Regards,<br>
Michael<br>
<br>
<br>
<div class="moz-cite-prefix">Am 20.11.24 um 01:01 schrieb Mark
Webb-Johnson:<br>
</div>
<blockquote type="cite"
cite="mid:BACFEE5F-70EC-403D-93C9-5F1B03D7FB64@webb-johnson.net">
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
Michael,
<div><br>
</div>
<div>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).</div>
<div><br>
</div>
<div>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.</div>
<div><br>
</div>
<div>Regards, Mark.</div>
<div><br>
</div>
<div>P.S. I’ve added your eMail to the readthedocs notification
list so you see build notifications. If you create an account on
<a href="http://readthedocs.com" moz-do-not-send="true">readthedocs.com</a>,
I can also add you as a maintainer there, if it helps.</div>
<blockquote
style="margin: 0 0 0 40px; border: none; padding: 0px;">
<pre
style="color: rgb(0, 0, 0); font-variant-ligatures: normal; orphans: 2; widows: 2; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; overflow-wrap: break-word; text-wrap-mode: wrap;"><pre
style="font-variant-ligatures: normal; text-decoration-thickness: initial; text-decoration-style: initial; text-decoration-color: initial; overflow-wrap: break-word; text-wrap-mode: wrap;">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 <a class="moz-txt-link-freetext" href="https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3.git">https://github.com/openvehicles/Open-Vehicle-Monitoring-System-3.git</a> .
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 <a class="moz-txt-link-freetext" href="https://docs.readthedocs.io/en/stable/config-file/v2.html">https://docs.readthedocs.io/en/stable/config-file/v2.html</a> 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:
# <a class="moz-txt-link-freetext" href="https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html">https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html</a>
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 <a class="moz-txt-link-freetext" href="https://pip.pypa.io/warnings/backtracking">https://pip.pypa.io/warnings/backtracking</a> 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:
# <a class="moz-txt-link-freetext" href="http://www.sphinx-doc.org/en/master/config">http://www.sphinx-doc.org/en/master/config</a>
# -- 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)</pre></pre>
</blockquote>
<div>
<div><br>
<blockquote type="cite">
<div>On 20 Nov 2024, at 2:22 AM, Michael Balzer via OvmsDev
<a class="moz-txt-link-rfc2396E" href="mailto:ovmsdev@lists.openvehicles.com"><ovmsdev@lists.openvehicles.com></a> wrote:</div>
<br class="Apple-interchange-newline">
<div>
<meta charset="UTF-8">
<div style="position: relative;">
<div
class="protected-part-E69FD823-56C5-42E3-8B21-B1FD5B2E7522"
style="padding-top: 0px; position: relative; caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;">
<div
class="protected-title-E69FD823-56C5-42E3-8B21-B1FD5B2E7522"
style="position: absolute; margin-top: -5px; background-color: rgb(255, 255, 255); margin-left: 20px; font-weight: bold;">Signed
PGP part</div>
<div
class="protected-content-E69FD823-56C5-42E3-8B21-B1FD5B2E7522"
style="border: 3px solid rgb(204, 204, 204); padding: 16px 16px 16px 20px;">I've
switched the plugin from m2r2 to sphinx_mdinclude,
works here as well.<br>
<br>
Note: I've kept the name consistent for the install
documentation, this works due to pip automatically
switching between underscore & dash as needed.<br>
<br>
@Mark: I guess this also needs some change to the
ReadTheDocs configuration?<br>
<br>
Regards,<br>
Michael<br>
<br>
<br>
<div class="moz-cite-prefix">Am 17.11.24 um 23:59
schrieb Michael Geddes:<br>
</div>
<blockquote type="cite"
cite="mid:CAH0p7uJKAipHO=ZmJePbTOnvZKw8tei1r0vXo39_GRXR9L-qow@mail.gmail.com">
<div dir="auto">
<div>Michael what do you think of switching over
to mdinclude?</div>
<div dir="auto"><br>
</div>
<div dir="auto">//.<br>
<br>
<div class="gmail_quote" dir="auto">
<div dir="ltr" class="gmail_attr">On Mon, 18
Nov 2024, 05:28 Craig Leres, <<a
href="mailto:leres@xse.com"
moz-do-not-send="true"
class="moz-txt-link-freetext">leres@xse.com</a>>
wrote:<br>
</div>
<blockquote class="gmail_quote"
style="margin: 0px 0px 0px 0.8ex; border-left-width: 1px; border-left-style: solid; border-left-color: rgb(204, 204, 204); padding-left: 1ex;">On
11/16/24 16:19, Michael Geddes via OvmsDev
wrote:<br>
> For some reason I was getting
run-time python errors with m2r2 which is<span
class="Apple-converted-space"> </span><br>
> why I tried switching to mdinclude.<br>
<br>
Over here in FreeBSD-land, I can "gmake
html" if I change conf.py to use<span
class="Apple-converted-space"> </span><br>
sphinx_mdinclude instead of m2r2.<br>
<br>
<span
class="Apple-converted-space"> </span>Craig<br>
<br>
ice 4003 % pkg info | fgrep sphinx<br>
py311-sphinx-5.3.0_3,1 Python
documentation generator<br>
py311-sphinx-mdinclude-0.6.2 Sphinx
extension that enables including<span
class="Apple-converted-space"> </span><br>
Markdown documents<br>
py311-sphinx_rtd_theme-1.0.0
Mobile-friendly py-sphinx theme<br>
py311-sphinxcontrib-applehelp-1.0.2
Extension which outputs Apple help books<br>
py311-sphinxcontrib-devhelp-1.0.2 Sphinx
extension which outputs Devhelp<span
class="Apple-converted-space"> </span><br>
document<br>
py311-sphinxcontrib-htmlhelp-2.1.0 Sphinx
extension which renders HTML<span
class="Apple-converted-space"> </span><br>
help files<br>
py311-sphinxcontrib-jsmath-1.0.1 Sphinx
extension which renders display<span
class="Apple-converted-space"> </span><br>
math in HTML via JavaScript<br>
py311-sphinxcontrib-qthelp-2.0.0 Sphinx
extension which outputs QtHelp<span
class="Apple-converted-space"> </span><br>
document<br>
py311-sphinxcontrib-serializinghtml-2.0.0
Sphinx extension which outputs<span
class="Apple-converted-space"> </span><br>
serialized HTML files (json and pickle)<br>
<br>
</blockquote>
</div>
</div>
</div>
</blockquote>
<br>
<pre class="moz-signature" cols="72">--
Michael Balzer * Am Rahmen 5 * D-58313 Herdecke
Fon 02330 9104094 * Handy 0176 20698926</pre>
</div>
</div>
<span
style="caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none; float: none; display: inline !important;">_______________________________________________</span><br
style="caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;">
<span
style="caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none; float: none; display: inline !important;">OvmsDev
mailing list</span><br
style="caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;">
<a href="mailto:OvmsDev@lists.openvehicles.com"
style="font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-stroke-width: 0px;"
moz-do-not-send="true" class="moz-txt-link-freetext">OvmsDev@lists.openvehicles.com</a><br
style="caret-color: rgb(0, 0, 0); font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; word-spacing: 0px; -webkit-text-stroke-width: 0px; text-decoration: none;">
<a
href="http://lists.openvehicles.com/mailman/listinfo/ovmsdev"
style="font-family: Helvetica; font-size: 18px; font-style: normal; font-variant-caps: normal; font-weight: 400; letter-spacing: normal; orphans: auto; text-align: start; text-indent: 0px; text-transform: none; white-space: normal; widows: auto; word-spacing: 0px; -webkit-text-stroke-width: 0px;"
moz-do-not-send="true" class="moz-txt-link-freetext">http://lists.openvehicles.com/mailman/listinfo/ovmsdev</a></div>
</div>
</blockquote>
</div>
<br>
</div>
</blockquote>
<br>
<pre class="moz-signature" cols="72">--
Michael Balzer * Am Rahmen 5 * D-58313 Herdecke
Fon 02330 9104094 * Handy 0176 20698926</pre>
</body>
</html>