Read the Docs build information Build id: 1461847 Project: openhw-group-cv32e40x-user-manual Version: latest Commit: c323c2fc9128ab28a04bde6ecc5600da6369abad Date: 2023-05-09T14:16:09.038284Z State: finished Success: False [rtd-command-info] start-time: 2023-05-09T14:19:39.203284Z, end-time: 2023-05-09T14:19:41.756642Z, duration: 2, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/openhwgroup/cv32e40x.git . Cloning into '.'... [rtd-command-info] start-time: 2023-05-09T14:19:42.065954Z, end-time: 2023-05-09T14:19:42.200769Z, 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 Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at c323c2f Merge pull request #850 from Silabs-ArjanB/ArjanB_mergedr [rtd-command-info] start-time: 2023-05-09T14:19:42.429868Z, end-time: 2023-05-09T14:19:42.493464Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-05-09T14:19:43.510139Z, end-time: 2023-05-09T14:19:48.349335Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-05-09T14:19:48.564397Z, end-time: 2023-05-09T14:19:49.711254Z, duration: 1, 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/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (23.1.2) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (67.7.2) [rtd-command-info] start-time: 2023-05-09T14:19:49.996740Z, end-time: 2023-05-09T14:19:57.634112Z, duration: 7, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.3 Collecting pillow Downloading Pillow-9.5.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 61.0 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 238.6 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 180.7 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 211.0 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 212.8 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 239.0 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 203.8 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 185.8 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 203.0 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml>=1.1.5 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 202.7 MB/s eta 0:00:00 Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 211.8 MB/s eta 0:00:00 Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 223.1 MB/s eta 0:00:00 Collecting Pygments>=2.12 (from sphinx) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 245.0 MB/s eta 0:00:00 Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 194.3 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 190.3 MB/s eta 0:00:00 Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.5.0 (from sphinx) Downloading requests-2.30.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.5/62.5 kB 171.0 MB/s eta 0:00:00 Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 156.3 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 (from sphinx) Downloading importlib_metadata-6.6.0-py3-none-any.whl (22 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 229.1 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery!=3.0.0,>=2.0.0 (from sphinx-rtd-theme) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 215.1 MB/s eta 0:00:00 Collecting pytz>=2015.7 (from babel>=2.9->sphinx) Downloading pytz-2023.3-py2.py3-none-any.whl (502 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 502.3/502.3 kB 229.6 MB/s eta 0:00:00 Collecting zipp>=0.5 (from importlib-metadata>=4.8->sphinx) Downloading zipp-3.15.0-py3-none-any.whl (6.8 kB) Collecting typing-extensions>=3.6.4 (from importlib-metadata>=4.8->sphinx) Downloading typing_extensions-4.5.0-py3-none-any.whl (27 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.5.0->sphinx) Downloading charset_normalizer-3.1.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (171 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 171.0/171.0 kB 131.2 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.5.0->sphinx) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 162.1 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.5.0->sphinx) Downloading urllib3-2.0.2-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.2/123.2 kB 209.1 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.5.0->sphinx) Downloading certifi-2023.5.7-py3-none-any.whl (156 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 221.6 MB/s eta 0:00:00 Building wheels for collected packages: mock Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23753 sha256=2e85730d0520b9ae4b4419638957b73e5df807b6f60bb31bbd8d09a577b7580b Stored in directory: /tmp/pip-ephem-wheel-cache-1i4kb2g_/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, zipp, urllib3, typing-extensions, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, importlib-metadata, sphinx, readthedocs-sphinx-ext, sphinxcontrib-jquery, recommonmark, sphinx-rtd-theme Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.2 Pygments-2.15.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.5.7 charset-normalizer-3.1.0 commonmark-0.9.1 docutils-0.18.1 idna-3.4 imagesize-1.4.1 importlib-metadata-6.6.0 mock-1.0.1 packaging-23.1 pillow-9.5.0 pytz-2023.3 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.30.0 snowballstemmer-2.2.0 sphinx-5.3.0 sphinx-rtd-theme-1.2.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jquery-4.1 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.5.0 urllib3-2.0.2 zipp-3.15.0 [rtd-command-info] start-time: 2023-05-09T14:19:57.845420Z, end-time: 2023-05-09T14:19:59.068852Z, duration: 1, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/user_manual/requirements.txt Requirement already satisfied: sphinx in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from -r docs/user_manual/requirements.txt (line 1)) (5.3.0) Requirement already satisfied: sphinx-rtd-theme in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from -r docs/user_manual/requirements.txt (line 2)) (1.2.0) Requirement already satisfied: recommonmark in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from -r docs/user_manual/requirements.txt (line 3)) (0.5.0) Collecting sphinxcontrib-svg2pdfconverter (from -r docs/user_manual/requirements.txt (line 4)) Downloading sphinxcontrib_svg2pdfconverter-1.2.2-py3-none-any.whl (8.1 kB) Collecting sphinx_github_changelog (from -r docs/user_manual/requirements.txt (line 5)) Downloading sphinx_github_changelog-1.2.1-py3-none-any.whl (8.2 kB) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.1.5) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.0.3) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.1.2) Requirement already satisfied: Pygments>=2.12 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.15.1) Requirement already satisfied: docutils<0.20,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (0.18.1) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.12.1) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (0.7.13) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.4.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.30.0) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (23.1) Requirement already satisfied: importlib-metadata>=4.8 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (6.6.0) Requirement already satisfied: sphinxcontrib-jquery!=3.0.0,>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from sphinx-rtd-theme->-r docs/user_manual/requirements.txt (line 2)) (4.1) Requirement already satisfied: commonmark>=0.7.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from recommonmark->-r docs/user_manual/requirements.txt (line 3)) (0.9.1) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from babel>=2.9->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2023.3) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.15.0) Requirement already satisfied: typing-extensions>=3.6.4 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx->-r docs/user_manual/requirements.txt (line 1)) (4.5.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from Jinja2>=3.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.1.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.1.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.4) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.2) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2023.5.7) Installing collected packages: sphinxcontrib-svg2pdfconverter, sphinx_github_changelog Successfully installed sphinx_github_changelog-1.2.1 sphinxcontrib-svg2pdfconverter-1.2.2 [rtd-command-info] start-time: 2023-05-09T14:20:01.139424Z, end-time: 2023-05-09T14:20:01.232448Z, duration: 0, exit-code: 0 cat docs/user_manual/source/conf.py # -*- coding: utf-8 -*- # # Copyright (c) 2020 OpenHW Group # # Licensed under the Solderpad Hardware Licence, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # https://solderpad.org/licenses/ # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. # # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.0 # ############################################################################### # # Configuration file for the Sphinx documentation builder. # # This file does only contain 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 = u'CORE-V CV32E40X User Manual' copyright = u'2020, OpenHW Group' author = u'PULP Platform and OpenHW Group' # The short X.Y version version = u'' # The full version, including alpha/beta/rc tags release = u'' # -- General configuration --------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # 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.ext.autodoc', 'sphinx.ext.todo', 'sphinx.ext.imgconverter', 'recommonmark', 'sphinxcontrib.inkscapeconverter', 'sphinx_github_changelog', # 'sphinxcontrib.wavedrom', ] #wavedrom_html_jsinline = False # Add any paths that contain templates here, relative to this directory. templates_path = ['ytemplates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = 'en' # 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 = [] # Numbering numfig=True numfig_format = {'figure': 'Figure %s', 'table': 'Table %s', 'code-block': 'Listing %s'} # The name of the Pygments (syntax highlighting) style to use. pygments_style = None # Entries for text replacement rst_epilog = """ .. |corev| replace:: CV32E40X .. |corev_lc| replace:: cv32e40x """ # Tags for conditional text tags.add('ZICNTR') tags.add('ZIHPM') # -- 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 = 'alabaster' html_theme = 'sphinx_rtd_theme' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. # html_theme_options = {'style_nav_header_background': '#DDDDDD'} html_logo = '../images/openhw-landscape.svg' # 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 = ['ystatic'] # Set html_static_path to null on the advice of RTDs: html_static_path = ['_static'] # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} html_css_files = [ 'css/custom.css', ] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = 'CORE-V_CV32E40X_User_Manual' # -- Options for LaTeX output ------------------------------------------------ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # # 'preamble': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, 'CV32E40X_User_Manual.tex', u'CV32E40X User Manual', u'OpenHW Group', 'manual'), ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ (master_doc, 'CV32E40X_User_Manual.tex', u'CORE-V-Docs Documentation', [author], 1) ] # -- Options for Texinfo output ---------------------------------------------- # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ (master_doc, 'CV32E40X_User_Manual.tex', u'CORE-V-Docs Documentation', author, 'UserManual', 'User Manual for CV32E40X CORE-V processor core.', 'Miscellaneous'), ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] # -- Extension configuration ------------------------------------------------- # -- Options for todo extension ---------------------------------------------- # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = True ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} # This following legacy behavior will gradually be sliced out until its deprecated and removed. # Skipped for Sphinx 6+ # Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH # Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023) if ( using_rtd_theme and version_info < (6,0) and not False ): theme = importlib.import_module('sphinx_rtd_theme') if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] # Define websupport2_base_url and websupport2_static_url if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'proxied_static_path': "/_/static/", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("0.9.0", "/en/0.9.0/"), ("0.8.0", "/en/0.8.0/"), ("0.7.0", "/en/0.7.0/"), ("0.6.0", "/en/0.6.0/"), ("0.5.0", "/en/0.5.0/"), ("0.4.0", "/en/0.4.0/"), ("0.3.0", "/en/0.3.0/"), ("0.2.0", "/en/0.2.0/"), ("0.1.0", "/en/0.1.0/"), ], 'downloads': [ ("pdf", "//docs.openhwgroup.org/_/downloads/cv32e40x-user-manual/en/latest/pdf/"), ("html", "//docs.openhwgroup.org/_/downloads/cv32e40x-user-manual/en/latest/htmlzip/"), ("epub", "//docs.openhwgroup.org/_/downloads/cv32e40x-user-manual/en/latest/epub/"), ], 'subprojects': [ ], 'slug': 'openhw-group-cv32e40x-user-manual', 'name': u'CV32E40X User Manual', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://docs.openhwgroup.org/projects/cv32e40x-user-manual/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/user_manual/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'openhwgroup', 'proxied_api_host': '/_', 'github_repo': 'cv32e40x', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': 'c323c2fc', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/openhw-group-cv32e40x-user-manual/builds/1461847/' project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' # Make sure our build directory is always excluded exclude_patterns = globals().get('exclude_patterns', []) exclude_patterns.extend(['_build']) [rtd-command-info] start-time: 2023-05-09T14:20:01.501699Z, end-time: 2023-05-09T14:20:01.968896Z, duration: 0, exit-code: 2 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v5.3.0 Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/registry.py", line 459, in load_extension mod = import_module(extname) File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/importlib/__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "", line 1006, in _gcd_import File "", line 983, in _find_and_load File "", line 967, in _find_and_load_unlocked File "", line 677, in _load_unlocked File "", line 728, in exec_module File "", line 219, in _call_with_frames_removed File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/builders/linkcheck.py", line 18, in from requests import Response File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/requests/__init__.py", line 43, in import urllib3 File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/urllib3/__init__.py", line 39, in "urllib3 v2.0 only supports OpenSSL 1.1.1+, currently " ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with OpenSSL 1.0.2n 7 Dec 2017. See: https://github.com/urllib3/urllib3/issues/2168 The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/cmd/build.py", line 280, in build_main args.pdb) File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 219, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 398, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.7/site-packages/sphinx/registry.py", line 463, in load_extension err) from err sphinx.errors.ExtensionError: Could not import extension sphinx.builders.linkcheck (exception: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with OpenSSL 1.0.2n 7 Dec 2017. See: https://github.com/urllib3/urllib3/issues/2168) Extension error: Could not import extension sphinx.builders.linkcheck (exception: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with OpenSSL 1.0.2n 7 Dec 2017. See: https://github.com/urllib3/urllib3/issues/2168)