Read the Docs build information Build id: 1580229 Project: openhw-group-core-v-mcu Version: latest Commit: 0f7942797cf983778fd560635a624e290e0095f6 Date: 2023-07-05T20:50:27.807492Z State: finished Success: True [rtd-command-info] start-time: 2023-07-05T20:50:35.993764Z, end-time: 2023-07-05T20:50:40.255233Z, duration: 4, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/openhwgroup/core-v-mcu.git . Cloning into '.'... [rtd-command-info] start-time: 2023-07-05T20:50:40.719014Z, end-time: 2023-07-05T20:50:41.082205Z, 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 0f79427 Fix up the Quick Start Guide (#312) [rtd-command-info] start-time: 2023-07-05T20:50:41.809564Z, end-time: 2023-07-05T20:50:41.895700Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-07-05T20:50:42.344691Z, end-time: 2023-07-05T20:50:42.411569Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # Copyright 2020 OpenHW Group # Solderpad Hardware License, Version 2.1, see LICENSE.md for details. # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1 # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # Optionally set the version of Python and requirements required to build your docs python: version: 3.8 install: - requirements: docs/requirements.txt [rtd-command-info] start-time: 2023-07-05T20:50:45.304267Z, end-time: 2023-07-05T20:50:50.581222Z, duration: 5, exit-code: 0 python3.8 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH Using base prefix '/home/docs/.pyenv/versions/3.8.6' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/bin/python3.8 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-07-05T20:50:50.973474Z, end-time: 2023-07-05T20:50:52.159203Z, 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-core-v-mcu/envs/latest/lib/python3.8/site-packages (23.1.2) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (68.0.0) [rtd-command-info] start-time: 2023-07-05T20:50:52.726148Z, end-time: 2023-07-05T20:51:00.549807Z, 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-10.0.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 71.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 232.2 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 193.1 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-7.0.1-py3-none-any.whl (3.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.0/3.0 MB 227.9 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.2.2-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 142.7 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.2-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 247.5 MB/s eta 0:00:00 Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.4-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.6/120.6 kB 222.9 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 192.9 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.1-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.8/99.8 kB 225.9 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 220.8 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 228.4 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 232.0 MB/s eta 0:00:00 Collecting Pygments>=2.13 (from sphinx) Downloading Pygments-2.15.1-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 257.5 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 216.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 208.6 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.25.0 (from sphinx) Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 193.8 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 197.2 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 (from sphinx) Downloading importlib_metadata-6.7.0-py3-none-any.whl (22 kB) Collecting sphinx Downloading sphinx-6.2.1-py3-none-any.whl (3.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.0/3.0 MB 214.8 MB/s eta 0:00:00 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 231.5 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 222.5 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 249.9 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 MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.3-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx) Downloading charset_normalizer-3.1.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (195 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 195.9/195.9 kB 235.5 MB/s eta 0:00:00 Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 172.9 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.0.3-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.6/123.6 kB 207.6 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2023.5.7-py3-none-any.whl (156 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 157.0/157.0 kB 239.2 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=e28d68b254489abf49efd48a1a10e2a5d482c1f21a52a7beef9606947176790c Stored in directory: /tmp/pip-ephem-wheel-cache-512cwicz/wheels/41/7c/21/90057f91c6ead7c77a90c52d6e85ca48bf82d8b0d3f8dfbb65 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, zipp, urllib3, 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.3 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.7.0 mock-1.0.1 packaging-23.1 pillow-10.0.0 pytz-2023.3 readthedocs-sphinx-ext-2.2.2 recommonmark-0.5.0 requests-2.31.0 snowballstemmer-2.2.0 sphinx-6.2.1 sphinx-rtd-theme-1.2.2 sphinxcontrib-applehelp-1.0.4 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.1 sphinxcontrib-jquery-4.1 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-2.0.3 zipp-3.15.0 [rtd-command-info] start-time: 2023-07-05T20:51:01.044950Z, end-time: 2023-07-05T20:51:02.381031Z, duration: 1, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Requirement already satisfied: recommonmark in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from -r docs/requirements.txt (line 5)) (0.5.0) Requirement already satisfied: sphinx>=4.3.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from -r docs/requirements.txt (line 6)) (6.2.1) Collecting sphinx_markdown_tables (from -r docs/requirements.txt (line 7)) Downloading sphinx_markdown_tables-0.0.17-py3-none-any.whl (28 kB) Requirement already satisfied: sphinx_rtd_theme>=0.5.1 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from -r docs/requirements.txt (line 8)) (1.2.2) Requirement already satisfied: commonmark>=0.7.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from recommonmark->-r docs/requirements.txt (line 5)) (0.9.1) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from recommonmark->-r docs/requirements.txt (line 5)) (0.18.1) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.0.4) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.0.2) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.0.1) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.1.5) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.0.3) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (3.1.2) Requirement already satisfied: Pygments>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.15.1) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.12.1) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (0.7.13) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (1.4.1) Requirement already satisfied: requests>=2.25.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.31.0) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (23.1) Requirement already satisfied: importlib-metadata>=4.8 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (6.7.0) Collecting markdown>=3.4 (from sphinx_markdown_tables->-r docs/requirements.txt (line 7)) Downloading Markdown-3.4.3-py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.9/93.9 kB 13.2 MB/s eta 0:00:00 Requirement already satisfied: sphinxcontrib-jquery<5,>=4 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx_rtd_theme>=0.5.1->-r docs/requirements.txt (line 8)) (4.1) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from babel>=2.9->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2023.3) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from importlib-metadata>=4.8->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (3.15.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from Jinja2>=3.0->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.1.3) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from requests>=2.25.0->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (3.1.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from requests>=2.25.0->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (3.4) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from requests>=2.25.0->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2.0.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from requests>=2.25.0->sphinx>=4.3.0->-r docs/requirements.txt (line 6)) (2023.5.7) Installing collected packages: markdown, sphinx_markdown_tables Successfully installed markdown-3.4.3 sphinx_markdown_tables-0.0.17 [rtd-command-info] start-time: 2023-07-05T20:51:09.160271Z, end-time: 2023-07-05T20:51:09.233165Z, duration: 0, exit-code: 0 cat docs/conf.py # Copyright 2022 OpenHW Group # Solderpad Hardware License, Version 2.1, see LICENSE.md for details. # SPDX-License-Identifier: Apache-2.0 WITH SHL-2.1 # 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: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- 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 = 'CORE-V MCU' copyright = '2022-present, OpenHW Group' author = 'OpenHW Group Contributors' # -- 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 = [ 'recommonmark', 'sphinx_markdown_tables', ] # 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 = ['_build', 'Thumbs.db', '.DS_Store', 'README.md'] # -- 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 = '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 = '_static/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 = [] # 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 = {} ########################################################################### # 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/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'openhw-group-core-v-mcu', 'name': u'core-v-mcu', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'openhwgroup', 'proxied_api_host': '/_', 'github_repo': 'core-v-mcu', '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': '0f794279', } # 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(): for key in context: if key not in html_context: html_context[key] = context[key] 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-core-v-mcu/builds/1580229/' 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-07-05T20:51:09.765648Z, end-time: 2023-07-05T20:51:14.651879Z, duration: 4, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v6.2.1 making output directory... done building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 33 source files that are out of date updating environment: [new config] 33 added, 0 changed, 0 removed reading sources... [ 3%] doc-src/apb_peripheral_interconnect reading sources... [ 6%] doc-src/clock_domains reading sources... [ 9%] doc-src/core_complex_subsystem reading sources... [ 12%] doc-src/debug_approach reading sources... [ 15%] doc-src/device_characteristics reading sources... [ 18%] doc-src/efpga_subsystem reading sources... [ 21%] doc-src/evaluation_kits reading sources... [ 24%] doc-src/high_level_architecture reading sources... [ 27%] doc-src/integration reading sources... [ 30%] doc-src/interrupts reading sources... [ 33%] doc-src/io_assignment_tables reading sources... [ 36%] doc-src/ip-blocks/apb_adv_timer reading sources... [ 39%] doc-src/ip-blocks/apb_event_cntrl reading sources... [ 42%] doc-src/ip-blocks/apb_fll_if reading sources... [ 45%] doc-src/ip-blocks/apb_gpio reading sources... [ 48%] doc-src/ip-blocks/apb_i2cs reading sources... [ 51%] doc-src/ip-blocks/apb_soc_ctrl reading sources... [ 54%] doc-src/ip-blocks/apb_timer reading sources... [ 57%] doc-src/ip-blocks/udma_cam reading sources... [ 60%] doc-src/ip-blocks/udma_i2cm reading sources... [ 63%] doc-src/ip-blocks/udma_qspim reading sources... [ 66%] doc-src/ip-blocks/udma_sdio reading sources... [ 69%] doc-src/ip-blocks/udma_uart reading sources... [ 72%] doc-src/mmap reading sources... [ 75%] doc-src/open-source-development-at-openhw reading sources... [ 78%] doc-src/overview reading sources... [ 81%] doc-src/package_information reading sources... [ 84%] doc-src/software_support reading sources... [ 87%] doc-src/startup reading sources... [ 90%] doc-src/tcdm_interconnect reading sources... [ 93%] doc-src/terminology reading sources... [ 96%] doc-src/udma_subsystem reading sources... [100%] index looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 3%] doc-src/apb_peripheral_interconnect writing output... [ 6%] doc-src/clock_domains writing output... [ 9%] doc-src/core_complex_subsystem writing output... [ 12%] doc-src/debug_approach writing output... [ 15%] doc-src/device_characteristics writing output... [ 18%] doc-src/efpga_subsystem writing output... [ 21%] doc-src/evaluation_kits writing output... [ 24%] doc-src/high_level_architecture writing output... [ 27%] doc-src/integration writing output... [ 30%] doc-src/interrupts writing output... [ 33%] doc-src/io_assignment_tables writing output... [ 36%] doc-src/ip-blocks/apb_adv_timer writing output... [ 39%] doc-src/ip-blocks/apb_event_cntrl writing output... [ 42%] doc-src/ip-blocks/apb_fll_if writing output... [ 45%] doc-src/ip-blocks/apb_gpio writing output... [ 48%] doc-src/ip-blocks/apb_i2cs writing output... [ 51%] doc-src/ip-blocks/apb_soc_ctrl writing output... [ 54%] doc-src/ip-blocks/apb_timer writing output... [ 57%] doc-src/ip-blocks/udma_cam writing output... [ 60%] doc-src/ip-blocks/udma_i2cm writing output... [ 63%] doc-src/ip-blocks/udma_qspim writing output... [ 66%] doc-src/ip-blocks/udma_sdio writing output... [ 69%] doc-src/ip-blocks/udma_uart writing output... [ 72%] doc-src/mmap writing output... [ 75%] doc-src/open-source-development-at-openhw writing output... [ 78%] doc-src/overview writing output... [ 81%] doc-src/package_information writing output... [ 84%] doc-src/software_support writing output... [ 87%] doc-src/startup writing output... [ 90%] doc-src/tcdm_interconnect writing output... [ 93%] doc-src/terminology writing output... [ 96%] doc-src/udma_subsystem writing output... [100%] index generating indices... genindex done writing additional pages... search done copying images... [ 10%] images/A2_MATH_UNIT.png copying images... [ 20%] images/CORE-V-MCU_Block_Diagram.png copying images... [ 30%] images/simple_spi_write_transfer.png copying images... [ 40%] images/simple_spi_read_transfer.png copying images... [ 50%] images/quad_spi_transfer.png copying images... [ 60%] images/udma_block_diagram.png copying images... [ 70%] images/udma_rx_chan_block_diagram.png copying images... [ 80%] images/udma_rx_chan_protocol.png copying images... [ 90%] images/udma_tx_chan_block_diagram.png copying images... [100%] images/udma_tx_chan_protocol.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded. The HTML pages are in ../_readthedocs/html.