Read the Docs build information Build id: 1960190 Project: arm-oss-shrinkwrap Version: latest Commit: 24adf7d925520999cf6bcda3990a965983226d35 Date: 2024-01-19T08:40:22.861430Z State: finished Success: False [rtd-command-info] start-time: 2024-01-19T08:40:39.371814Z, end-time: 2024-01-19T08:40:40.357748Z, duration: 0, exit-code: 0 git clone --depth 1 git@git.gitlab.arm.com:tooling/shrinkwrap.git . Cloning into '.'... Warning: Permanently added 'git.gitlab.arm.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2024-01-19T08:40:40.433423Z, end-time: 2024-01-19T08:40:41.046982Z, duration: 0, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main Warning: Permanently added 'git.gitlab.arm.com' (ED25519) to the list of known hosts. Warning: Permanently added 'git.gitlab.arm.com' (ED25519) to the list of known hosts. From git.gitlab.arm.com:tooling/shrinkwrap * [new tag] v1.0.0 -> v1.0.0 [rtd-command-info] start-time: 2024-01-19T08:40:41.191538Z, end-time: 2024-01-19T08:40:41.258698Z, duration: 0, exit-code: 0 git checkout --force origin/main Note: switching to 'origin/main'. 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 24adf7d Merge branch 'od/cca-4world-fixes' into 'main' [rtd-command-info] start-time: 2024-01-19T08:40:41.333163Z, end-time: 2024-01-19T08:40:41.391159Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2024-01-19T08:40:41.462248Z, end-time: 2024-01-19T08:40:41.518410Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # ReadTheDocs configuration file. # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details. version: 2 build: os: ubuntu-22.04 tools: python: "3.11" sphinx: configuration: documentation/conf.py formats: - pdf python: install: - requirements: documentation/requirements.txt [rtd-command-info] start-time: 2024-01-19T08:40:47.884888Z, end-time: 2024-01-19T08:40:47.968774Z, duration: 0, exit-code: 0 asdf global python 3.11.6 [rtd-command-info] start-time: 2024-01-19T08:40:48.436008Z, end-time: 2024-01-19T08:40:49.584040Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.6.final.0-64 in 825ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/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-01-19T08:40:49.651436Z, end-time: 2024-01-19T08:41:00.611984Z, duration: 10, 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/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-23.3.2-py3-none-any.whl (2.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 14.2 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-69.0.3-py3-none-any.whl (819 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 819.5/819.5 kB 34.0 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-23.3.2 setuptools-69.0.3 [rtd-command-info] start-time: 2024-01-19T08:41:00.677622Z, end-time: 2024-01-19T08:41:06.960541Z, duration: 6, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext Collecting sphinx Downloading sphinx-7.2.6-py3-none-any.whl.metadata (5.9 kB) Collecting readthedocs-sphinx-ext Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl.metadata (1.5 kB) Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl.metadata (2.3 kB) 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.5-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl.metadata (2.4 kB) Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl.metadata (2.2 kB) Collecting Jinja2>=3.0 (from sphinx) Downloading Jinja2-3.1.3-py3-none-any.whl.metadata (3.3 kB) Collecting Pygments>=2.14 (from sphinx) Downloading pygments-2.17.2-py3-none-any.whl.metadata (2.6 kB) Collecting docutils<0.21,>=0.18.1 (from sphinx) Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 7.0 MB/s eta 0:00:00 Collecting babel>=2.9 (from sphinx) Downloading Babel-2.14.0-py3-none-any.whl.metadata (1.6 kB) Collecting alabaster<0.8,>=0.7 (from sphinx) Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB) 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.metadata (4.6 kB) Collecting packaging>=21.0 (from sphinx) Downloading packaging-23.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx) Downloading charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB) Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx) Downloading idna-3.6-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.1.0-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2023.11.17-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-7.2.6-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 20.2 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl (11 kB) Downloading alabaster-0.7.16-py3-none-any.whl (13 kB) Downloading Babel-2.14.0-py3-none-any.whl (11.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 MB 68.8 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 248.1 MB/s eta 0:00:00 Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.2/133.2 kB 276.6 MB/s eta 0:00:00 Downloading packaging-23.2-py3-none-any.whl (53 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.0/53.0 kB 239.1 MB/s eta 0:00:00 Downloading pygments-2.17.2-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 145.8 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 237.4 MB/s eta 0:00:00 Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 264.0 MB/s eta 0:00:00 Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 258.5 MB/s eta 0:00:00 Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 273.1 MB/s eta 0:00:00 Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 224.1 MB/s eta 0:00:00 Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 262.0 MB/s eta 0:00:00 Downloading certifi-2023.11.17-py3-none-any.whl (162 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 162.5/162.5 kB 282.5 MB/s eta 0:00:00 Downloading charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.3/140.3 kB 275.8 MB/s eta 0:00:00 Downloading idna-3.6-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.6/61.6 kB 241.7 MB/s eta 0:00:00 Downloading MarkupSafe-2.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (28 kB) Downloading urllib3-2.1.0-py3-none-any.whl (104 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 104.6/104.6 kB 257.4 MB/s eta 0:00:00 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, readthedocs-sphinx-ext Successfully installed Jinja2-3.1.3 MarkupSafe-2.1.3 Pygments-2.17.2 alabaster-0.7.16 babel-2.14.0 certifi-2023.11.17 charset-normalizer-3.3.2 docutils-0.20.1 idna-3.6 imagesize-1.4.1 packaging-23.2 readthedocs-sphinx-ext-2.2.5 requests-2.31.0 snowballstemmer-2.2.0 sphinx-7.2.6 sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6 sphinxcontrib-htmlhelp-2.0.5 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.7 sphinxcontrib-serializinghtml-1.1.10 urllib3-2.1.0 [rtd-command-info] start-time: 2024-01-19T08:41:07.034345Z, end-time: 2024-01-19T08:41:10.305702Z, duration: 3, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r documentation/requirements.txt Collecting jinja2==3.1.1 (from -r documentation/requirements.txt (line 6)) Downloading Jinja2-3.1.1-py3-none-any.whl (132 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 132.6/132.6 kB 4.6 MB/s eta 0:00:00 Collecting sphinx==4.5.0 (from -r documentation/requirements.txt (line 9)) Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 20.4 MB/s eta 0:00:00 Collecting sphinx_rtd_theme==1.0.0 (from -r documentation/requirements.txt (line 10)) Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 43.0 MB/s eta 0:00:00 Collecting sphinx-copybutton==0.5.0 (from -r documentation/requirements.txt (line 11)) Downloading sphinx_copybutton-0.5.0-py3-none-any.whl (12 kB) Collecting docutils==0.17.1 (from -r documentation/requirements.txt (line 12)) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 66.1 MB/s eta 0:00:00 Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from jinja2==3.1.1->-r documentation/requirements.txt (line 6)) (2.1.3) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.0.8) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.0.6) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.0.5) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.1.10) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.0.7) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.17.2) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.2.0) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.14.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (0.7.16) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (1.4.1) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.31.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (23.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (3.6) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2.1.0) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages (from requests>=2.5.0->sphinx==4.5.0->-r documentation/requirements.txt (line 9)) (2023.11.17) Installing collected packages: jinja2, docutils, sphinx, sphinx_rtd_theme, sphinx-copybutton Attempting uninstall: jinja2 Found existing installation: Jinja2 3.1.3 Uninstalling Jinja2-3.1.3: Successfully uninstalled Jinja2-3.1.3 Attempting uninstall: docutils Found existing installation: docutils 0.20.1 Uninstalling docutils-0.20.1: Successfully uninstalled docutils-0.20.1 Attempting uninstall: sphinx Found existing installation: Sphinx 7.2.6 Uninstalling Sphinx-7.2.6: Successfully uninstalled Sphinx-7.2.6 Successfully installed docutils-0.17.1 jinja2-3.1.1 sphinx-4.5.0 sphinx-copybutton-0.5.0 sphinx_rtd_theme-1.0.0 [rtd-command-info] start-time: 2024-01-19T08:41:10.836267Z, end-time: 2024-01-19T08:41:10.902337Z, duration: 0, exit-code: 0 cat documentation/conf.py # Copyright (c) 2022, Arm Limited. # # SPDX-License-Identifier: MIT # 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 = 'Shrinkwrap' copyright = '2022, Arm Limited' author = 'Arm Limited' # -- General configuration --------------------------------------------------- #import sphinx_rtd_theme # 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.autosectionlabel', 'sphinx_rtd_theme', 'sphinx_copybutton', 'sphinx.ext.todo', ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # 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 = ['_build', 'Thumbs.db', '.DS_Store'] # -- 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' # 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_css_files = [ 'css/custom.css', ] # Don't show the "Built with Sphinx" footer html_show_sphinx = False html_theme_options = { 'collapse_navigation': False, 'navigation_depth': 5, 'prev_next_buttons_location': "both" } # -- Extension configuration ------------------------------------------------- # Display todos by setting to True todo_include_todos = True # -- Options for autosectionlabel -------------------------------------------- # Prefix each section label with the name of the document it is in autosectionlabel_prefix_document = True # Only generate automatic section labels for document titles autosectionlabel_maxdepth = 2 # -- Options for copybutton -------------------------------------------------- copybutton_prompt_text = r'\$ ' copybutton_prompt_is_regexp = True copybutton_remove_prompts = True copybutton_only_copy_prompt_lines = True copybutton_copy_empty_lines = False copybutton_line_continuation_character = "\\" ########################################################################### # 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') # Define this variable in case it's not defined by the user. # It defaults to `alabaster` which is the default from Sphinx. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme html_theme = globals().get('html_theme', 'alabaster') #Add project information to the template context. context = { '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/"), ("v1.0.0", "/en/v1.0.0/"), ], 'downloads': [ ("pdf", "//shrinkwrap.docs.arm.com/_/downloads/en/latest/pdf/"), ], 'subprojects': [ ], 'slug': 'arm-oss-shrinkwrap', 'name': u'shrinkwrap', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/documentation/', 'api_host': 'https://readthedocs.com', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'main', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'main', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'main', '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': '24adf7d9', } # 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/arm-oss-shrinkwrap/builds/1960190/' 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: 2024-01-19T08:41:10.969381Z, end-time: 2024-01-19T08:41:11.487121Z, duration: 0, exit-code: 2 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v4.5.0 loading translations [en]... done Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 438, in load_extension metadata = setup(app) ^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinxcontrib/applehelp/__init__.py", line 230, in setup app.require_sphinx('5.0') File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 393, in require_sphinx raise VersionRequirementError(version) sphinx.errors.VersionRequirementError: 5.0 The above exception was the direct cause of the following exception: Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/cmd/build.py", line 272, in build_main app = Sphinx(args.sourcedir, args.confdir, args.outputdir, ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 219, in __init__ self.setup_extension(extension) File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/application.py", line 380, in setup_extension self.registry.load_extension(self, extname) File "/home/docs/checkouts/readthedocs.org/user_builds/arm-oss-shrinkwrap/envs/latest/lib/python3.11/site-packages/sphinx/registry.py", line 441, in load_extension raise VersionRequirementError( sphinx.errors.VersionRequirementError: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version. Sphinx version error: The sphinxcontrib.applehelp extension used by this project needs at least Sphinx v5.0; it therefore cannot be built with this version.