Read the Docs build information Build id: 781280 Project: openhw-group-core-v-mcu Version: latest Commit: 30b02bd25590ca3dd79d8a4b7148c63b8002a933 Date: 2021-11-23T15:29:33.710437Z State: finished Success: True [rtd-command-info] start-time: 2021-11-23T15:29:35.665879Z, end-time: 2021-11-23T15:29:37.697013Z, duration: 2, 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: 2021-11-23T15:29:37.855171Z, end-time: 2021-11-23T15:29:38.171037Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out '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 performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 30b02bd Fixed mem_init files for simulation (#202) [rtd-command-info] start-time: 2021-11-23T15:29:38.275845Z, end-time: 2021-11-23T15:29:38.346099Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-11-23T15:29:39.674412Z, end-time: 2021-11-23T15:29:45.136524Z, duration: 5, exit-code: 0 python3.8 -mvirtualenv 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: 2021-11-23T15:29:45.264941Z, end-time: 2021-11-23T15:29:46.404391Z, 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 (21.3.1) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (59.2.0) [rtd-command-info] start-time: 2021-11-23T15:29:46.524640Z, end-time: 2021-11-23T15:30:13.415869Z, duration: 26, exit-code: 0 python -m pip install --upgrade --no-cache-dir mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.2 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pillow==5.4.1 Downloading Pillow-5.4.1.tar.gz (16.0 MB) 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.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading Sphinx-4.3.0-py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting docutils>=0.11 Downloading docutils-0.18-py2.py3-none-any.whl (569 kB) Collecting Pygments>=2.0 Downloading Pygments-2.10.0-py3-none-any.whl (1.0 MB) Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Collecting babel>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting imagesize Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) Collecting requests>=2.5.0 Downloading requests-2.26.0-py2.py3-none-any.whl (62 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx) (59.2.0) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting pytz>=2015.7 Downloading pytz-2021.3-py2.py3-none-any.whl (503 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) Collecting idna<4,>=2.5 Downloading idna-3.3-py3-none-any.whl (61 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.7-py3-none-any.whl (38 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.7-py2.py3-none-any.whl (138 kB) Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.6-py3-none-any.whl (97 kB) Building wheels for collected packages: mock, pillow, future 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=23772 sha256=4f3626e682bf3d89b861509cab2419ef984bd31310281997afc91d233fbc4cfc Stored in directory: /tmp/pip-ephem-wheel-cache-p6dm3mwp/wheels/41/7c/21/90057f91c6ead7c77a90c52d6e85ca48bf82d8b0d3f8dfbb65 Building wheel for pillow (setup.py): started Building wheel for pillow (setup.py): finished with status 'done' Created wheel for pillow: filename=Pillow-5.4.1-cp38-cp38-linux_x86_64.whl size=1260092 sha256=74d959634659d7c8bf18b262f560799f30c38d689959fbea348bc24b0f460a70 Stored in directory: /tmp/pip-ephem-wheel-cache-p6dm3mwp/wheels/5f/a8/6b/5b7b3f764d879214eb03570f74d2b086201eb514e6ffa68d6d Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=0165245ee9dc60312071578a79729f7e5388132c15ad6f0012f376c3b95997f8 Stored in directory: /tmp/pip-ephem-wheel-cache-p6dm3mwp/wheels/8e/70/28/3d6ccd6e315f65f245da085482a2e1c7d14b90b30f239e2cf4 Successfully built mock pillow future Installing collected packages: urllib3, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.3 MarkupSafe-2.0.1 Pygments-2.10.0 alabaster-0.7.12 babel-2.9.1 certifi-2021.10.8 charset-normalizer-2.0.7 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-3.3 imagesize-1.3.0 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.6 pytz-2021.3 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.26.0 snowballstemmer-2.2.0 sphinx-4.3.0 sphinx-rtd-theme-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-1.26.7 [rtd-command-info] start-time: 2021-11-23T15:30:13.556737Z, end-time: 2021-11-23T15:30:14.882725Z, 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 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)) (4.3.0) Collecting sphinx_markdown_tables Downloading sphinx_markdown_tables-0.0.15-py3-none-any.whl (28 kB) Requirement already satisfied: sphinx_rtd_theme 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.0.0) 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.8.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.17.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->-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->-r docs/requirements.txt (line 6)) (1.0.1) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (2.9.1) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (2.10.0) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (1.3.0) 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->-r docs/requirements.txt (line 6)) (0.7.12) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (3.0.3) 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->-r docs/requirements.txt (line 6)) (2.0.0) 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->-r docs/requirements.txt (line 6)) (1.0.2) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (2.26.0) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (2.2.0) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (59.2.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from sphinx->-r docs/requirements.txt (line 6)) (21.3) 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->-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->-r docs/requirements.txt (line 6)) (1.0.3) Collecting markdown>=3.0.1 Downloading Markdown-3.3.6-py3-none-any.whl (97 kB) 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>=1.3->sphinx->-r docs/requirements.txt (line 6)) (2021.3) Requirement already satisfied: future in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from commonmark>=0.7.3->recommonmark->-r docs/requirements.txt (line 5)) (0.18.2) 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>=2.3->sphinx->-r docs/requirements.txt (line 6)) (2.0.1) Collecting importlib-metadata>=4.4 Downloading importlib_metadata-4.8.2-py3-none-any.whl (17 kB) Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from requests>=2.5.0->sphinx->-r docs/requirements.txt (line 6)) (2.0.7) Requirement already satisfied: urllib3<1.27,>=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.5.0->sphinx->-r docs/requirements.txt (line 6)) (1.26.7) 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.5.0->sphinx->-r docs/requirements.txt (line 6)) (3.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.5.0->sphinx->-r docs/requirements.txt (line 6)) (2021.10.8) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages (from packaging->sphinx->-r docs/requirements.txt (line 6)) (3.0.6) Collecting zipp>=0.5 Downloading zipp-3.6.0-py3-none-any.whl (5.3 kB) Installing collected packages: zipp, importlib-metadata, markdown, sphinx-markdown-tables Successfully installed importlib-metadata-4.8.2 markdown-3.3.6 sphinx-markdown-tables-0.0.15 zipp-3.6.0 [rtd-command-info] start-time: 2021-11-23T15:30:15.819431Z, end-time: 2021-11-23T15:30:15.884521Z, duration: 0, exit-code: 0 cat docs/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # 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 = '2020-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/master/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: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] 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", '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': 'https://docs.openhwgroup.org/projects/core-v-mcu/', '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': '30b02bd2', } # 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-core-v-mcu/builds/781280/' 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: 2021-11-23T15:30:16.003603Z, end-time: 2021-11-23T15:30:17.136750Z, duration: 1, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.3.0 loading translations [en]... done making output directory... done building [mo]: targets for 0 po files that are out of date building [html]: targets for 4 source files that are out of date updating environment: [new config] 4 added, 0 changed, 0 removed reading sources... [ 25%] doc-src/mmap reading sources... [ 50%] doc-src/overview reading sources... [ 75%] github reading sources... [100%] index /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/envs/latest/lib/python3.8/site-packages/recommonmark/parser.py:65: UserWarning: Container node skipped: type=document warn("Container node skipped: type={0}".format(mdnode.t)) /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:29: WARNING: toctree contains reference to nonexisting document 'auto-docs/pin-table' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/apb_soc_ctrl_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/apb_event_cntrl_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/apb_timer_unit_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/apb_gpio_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/apb_i2cs_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/efpga_template_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:36: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_ctrl_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:50: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_uart_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:50: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_i2cm_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:50: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_qspi_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:50: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_sdio_reg_defs' /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-core-v-mcu/checkouts/latest/docs/index.rst:50: WARNING: toctree contains reference to nonexisting document 'auto-docs/udma_camera_reg_defs' looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 25%] doc-src/mmap writing output... [ 50%] doc-src/overview writing output... [ 75%] github writing output... [100%] index generating indices... genindex done writing additional pages... search done copying images... [100%] images/core-v-mcu-block-diagram.png copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done build succeeded, 13 warnings. The HTML pages are in _build/html. Updating searchtools for Read the Docs search...