Read the Docs build information
Build id: 2595026
Project: openhw-group-cv32e40x-user-manual
Version: latest
Commit: d952cd63bc1b4eb58cd893c28ef8283c781e345e
Date: 2024-11-06T11:20:01.468418Z
State: finished
Success: True


[rtd-command-info] start-time: 2024-11-06T11:20:02.745279Z, end-time: 2024-11-06T11:20:04.511066Z, duration: 1, exit-code: 0
git clone --depth 1 https://github.com/openhwgroup/cv32e40x.git .
Cloning into '.'...

[rtd-command-info] start-time: 2024-11-06T11:20:04.582389Z, end-time: 2024-11-06T11:20:05.836050Z, duration: 1, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master
From https://github.com/openhwgroup/cv32e40x
 * [new tag]         0.10.0     -> 0.10.0

[rtd-command-info] start-time: 2024-11-06T11:20:05.969858Z, end-time: 2024-11-06T11:20:06.060304Z, duration: 0, exit-code: 0
git checkout --force origin/master
Note: switching to 'origin/master'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at d952cd6 Merge pull request #989 from silabs-robin/user_manual_navigability_abbreviations

[rtd-command-info] start-time: 2024-11-06T11:20:06.143224Z, end-time: 2024-11-06T11:20:06.204985Z, duration: 0, exit-code: 0
cat .readthedocs.yaml
# Configuration file for ReadTheDocs, used to render the CV32E40X
# User Manual to https://docs.openhwgroup.org/projects/cv32e40x-user-manual.
# SPDX-License-Identifier:Apache-2.0 WITH SHL-2.1

version: 2

build:
  os: "ubuntu-20.04"
  tools:
    python: "3.9"

# Build from the docs/user_manual/source directory with Sphinx
sphinx:
  configuration: docs/user_manual/source/conf.py

# Explicitly set the Python requirements
python:
  install:
    - requirements: docs/user_manual/requirements.txt

[rtd-command-info] start-time: 2024-11-06T11:20:11.896555Z, end-time: 2024-11-06T11:20:11.977735Z, duration: 0, exit-code: 0
asdf global python 3.9.19


[rtd-command-info] start-time: 2024-11-06T11:20:12.410700Z, end-time: 2024-11-06T11:20:13.662176Z, duration: 1, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.9.19.final.0-64 in 906ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest, clear=False, no_vcs_ignore=False, global=False)
  seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv)
    added seed packages: pip==23.1, setuptools==67.6.1, wheel==0.40.0
  activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator

[rtd-command-info] start-time: 2024-11-06T11:20:13.732978Z, end-time: 2024-11-06T11:20:25.681673Z, duration: 11, 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.9/site-packages (23.1)
Collecting pip
  Downloading pip-24.3.1-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 33.8 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-75.3.0-py3-none-any.whl (1.3 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.3/1.3 MB 65.8 MB/s eta 0:00:00
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.6.1
    Uninstalling setuptools-67.6.1:
      Successfully uninstalled setuptools-67.6.1
  Attempting uninstall: pip
    Found existing installation: pip 23.1
    Uninstalling pip-23.1:
      Successfully uninstalled pip-23.1
Successfully installed pip-24.3.1 setuptools-75.3.0

[rtd-command-info] start-time: 2024-11-06T11:20:25.763997Z, end-time: 2024-11-06T11:20:34.203255Z, duration: 8, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx
Collecting sphinx
  Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB)
Collecting sphinxcontrib-applehelp (from sphinx)
  Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-devhelp (from sphinx)
  Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath (from sphinx)
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx)
  Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx)
  Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB)
Collecting sphinxcontrib-qthelp (from sphinx)
  Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting Jinja2>=3.1 (from sphinx)
  Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB)
Collecting Pygments>=2.17 (from sphinx)
  Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB)
Collecting docutils<0.22,>=0.20 (from sphinx)
  Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB)
Collecting snowballstemmer>=2.2 (from sphinx)
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB)
Collecting babel>=2.13 (from sphinx)
  Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB)
Collecting alabaster~=0.7.14 (from sphinx)
  Downloading alabaster-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.metadata (1.5 kB)
Collecting requests>=2.30.0 (from sphinx)
  Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB)
Collecting packaging>=23.0 (from sphinx)
  Downloading packaging-24.1-py3-none-any.whl.metadata (3.2 kB)
Collecting importlib-metadata>=6.0 (from sphinx)
  Downloading importlib_metadata-8.5.0-py3-none-any.whl.metadata (4.8 kB)
Collecting tomli>=2 (from sphinx)
  Downloading tomli-2.0.2-py3-none-any.whl.metadata (10.0 kB)
Collecting zipp>=3.20 (from importlib-metadata>=6.0->sphinx)
  Downloading zipp-3.20.2-py3-none-any.whl.metadata (3.7 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx)
  Downloading MarkupSafe-3.0.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB)
Collecting charset-normalizer<4,>=2 (from requests>=2.30.0->sphinx)
  Downloading charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.10-py3-none-any.whl.metadata (10 kB)
Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx)
  Downloading urllib3-2.2.3-py3-none-any.whl.metadata (6.5 kB)
Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx)
  Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB)
Downloading sphinx-7.4.7-py3-none-any.whl (3.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 74.0 MB/s eta 0:00:00
Downloading alabaster-0.7.16-py3-none-any.whl (13 kB)
Downloading babel-2.16.0-py3-none-any.whl (9.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 160.5 MB/s eta 0:00:00
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 303.8 MB/s eta 0:00:00
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Downloading importlib_metadata-8.5.0-py3-none-any.whl (26 kB)
Downloading jinja2-3.1.4-py3-none-any.whl (133 kB)
Downloading packaging-24.1-py3-none-any.whl (53 kB)
Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 366.1 MB/s eta 0:00:00
Downloading requests-2.32.3-py3-none-any.whl (64 kB)
Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl (98 kB)
Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB)
Downloading tomli-2.0.2-py3-none-any.whl (13 kB)
Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl (119 kB)
Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl (82 kB)
Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl (88 kB)
Downloading certifi-2024.8.30-py3-none-any.whl (167 kB)
Downloading charset_normalizer-3.4.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (144 kB)
Downloading idna-3.10-py3-none-any.whl (70 kB)
Downloading MarkupSafe-3.0.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (20 kB)
Downloading urllib3-2.2.3-py3-none-any.whl (126 kB)
Downloading zipp-3.20.2-py3-none-any.whl (9.2 kB)
Installing collected packages: snowballstemmer, zipp, urllib3, tomli, 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, importlib-metadata, sphinx
Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-0.7.16 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 importlib-metadata-8.5.0 packaging-24.1 requests-2.32.3 snowballstemmer-2.2.0 sphinx-7.4.7 sphinxcontrib-applehelp-2.0.0 sphinxcontrib-devhelp-2.0.0 sphinxcontrib-htmlhelp-2.1.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-2.0.0 sphinxcontrib-serializinghtml-2.0.0 tomli-2.0.2 urllib3-2.2.3 zipp-3.20.2

[rtd-command-info] start-time: 2024-11-06T11:20:34.278553Z, end-time: 2024-11-06T11:20:35.851297Z, 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.9/site-packages (from -r docs/user_manual/requirements.txt (line 1)) (7.4.7)
Collecting sphinx-rtd-theme (from -r docs/user_manual/requirements.txt (line 2))
  Downloading sphinx_rtd_theme-3.0.1-py2.py3-none-any.whl.metadata (4.4 kB)
Collecting recommonmark (from -r docs/user_manual/requirements.txt (line 3))
  Downloading recommonmark-0.7.1-py2.py3-none-any.whl.metadata (463 bytes)
Collecting sphinxcontrib-svg2pdfconverter (from -r docs/user_manual/requirements.txt (line 4))
  Downloading sphinxcontrib_svg2pdfconverter-1.2.3-py3-none-any.whl.metadata (3.3 kB)
Collecting sphinx_github_changelog (from -r docs/user_manual/requirements.txt (line 5))
  Downloading sphinx_github_changelog-1.4.0-py3-none-any.whl.metadata (10.0 kB)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/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.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.1.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.1.4)
Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.18.0)
Requirement already satisfied: docutils<0.22,>=0.20 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (0.21.2)
Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.2.0)
Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.16.0)
Requirement already satisfied: alabaster~=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (0.7.16)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.32.3)
Requirement already satisfied: packaging>=23.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (24.1)
Requirement already satisfied: importlib-metadata>=6.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (8.5.0)
Requirement already satisfied: tomli>=2 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.0.2)
Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme->-r docs/user_manual/requirements.txt (line 2))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)
Collecting commonmark>=0.8.1 (from recommonmark->-r docs/user_manual/requirements.txt (line 3))
  Downloading commonmark-0.9.1-py2.py3-none-any.whl.metadata (5.7 kB)
Requirement already satisfied: zipp>=3.20 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from importlib-metadata>=6.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.20.2)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from Jinja2>=3.1->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.0.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.9/site-packages (from requests>=2.30.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.4.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.9/site-packages (from requests>=2.30.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (3.10)
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.9/site-packages (from requests>=2.30.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2.2.3)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/openhw-group-cv32e40x-user-manual/envs/latest/lib/python3.9/site-packages (from requests>=2.30.0->sphinx->-r docs/user_manual/requirements.txt (line 1)) (2024.8.30)
Downloading sphinx_rtd_theme-3.0.1-py2.py3-none-any.whl (7.7 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.7/7.7 MB 177.6 MB/s eta 0:00:00
Downloading recommonmark-0.7.1-py2.py3-none-any.whl (10 kB)
Downloading sphinxcontrib_svg2pdfconverter-1.2.3-py3-none-any.whl (8.2 kB)
Downloading sphinx_github_changelog-1.4.0-py3-none-any.whl (8.5 kB)
Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB)
Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
Installing collected packages: commonmark, sphinxcontrib-svg2pdfconverter, sphinxcontrib-jquery, sphinx_github_changelog, recommonmark, sphinx-rtd-theme
Successfully installed commonmark-0.9.1 recommonmark-0.7.1 sphinx-rtd-theme-3.0.1 sphinx_github_changelog-1.4.0 sphinxcontrib-jquery-4.1 sphinxcontrib-svg2pdfconverter-1.2.3

[rtd-command-info] start-time: 2024-11-06T11:20:36.046465Z, end-time: 2024-11-06T11:20:36.109647Z, 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

[rtd-command-info] start-time: 2024-11-06T11:20:36.178031Z, end-time: 2024-11-06T11:20:42.417733Z, duration: 6, exit-code: 0
python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v7.4.7
loading translations [en]... done
making output directory... done
Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`.
building [mo]: targets for 0 po files that are out of date
writing output... 
building [html]: targets for 22 source files that are out of date
updating environment: [new config] 22 added, 0 changed, 0 removed
reading sources... [  5%] atomics
reading sources... [  9%] control_status_registers
reading sources... [ 14%] core_versions
reading sources... [ 18%] debug
reading sources... [ 23%] exceptions_interrupts
reading sources... [ 27%] fencei
reading sources... [ 32%] getting_started
reading sources... [ 36%] glossary
reading sources... [ 41%] index
reading sources... [ 45%] instruction_fetch
reading sources... [ 50%] instruction_set_extensions
reading sources... [ 55%] integration
reading sources... [ 59%] intro
reading sources... [ 64%] load_store_unit
reading sources... [ 68%] perf_counters
reading sources... [ 73%] pipeline
reading sources... [ 77%] pma
reading sources... [ 82%] preface
reading sources... [ 86%] register_file
reading sources... [ 91%] rvfi
reading sources... [ 95%] sleep
reading sources... [100%] x_ext

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying static files... done
copying extra files... done
copying assets: done
writing output... [  5%] atomics
writing output... [  9%] control_status_registers
writing output... [ 14%] core_versions
writing output... [ 18%] debug
writing output... [ 23%] exceptions_interrupts
writing output... [ 27%] fencei
writing output... [ 32%] getting_started
writing output... [ 36%] glossary
writing output... [ 41%] index
writing output... [ 45%] instruction_fetch
writing output... [ 50%] instruction_set_extensions
writing output... [ 55%] integration
writing output... [ 59%] intro
writing output... [ 64%] load_store_unit
writing output... [ 68%] perf_counters
writing output... [ 73%] pipeline
writing output... [ 77%] pma
writing output... [ 82%] preface
writing output... [ 86%] register_file
writing output... [ 91%] rvfi
writing output... [ 95%] sleep
writing output... [100%] x_ext

generating indices... genindex done
writing additional pages... search done
copying images... [  7%] ../images/obi_instruction_basic.svg
copying images... [ 14%] ../images/obi_instruction_basic_err.svg
copying images... [ 21%] ../images/obi_instruction_multiple_outstanding.svg
copying images... [ 29%] ../images/obi_instruction_multiple_outstanding_err.svg
copying images... [ 36%] ../images/CV32E40X_Block_Diagram.png
copying images... [ 43%] ../images/obi_data_basic.svg
copying images... [ 50%] ../images/obi_data_back_to_back.svg
copying images... [ 57%] ../images/obi_data_slow_response.svg
copying images... [ 64%] ../images/obi_data_multiple_outstanding.svg
copying images... [ 71%] ../images/CV32E40X_Pipeline.png
copying images... [ 79%] ../images/rvfi_trace.png
copying images... [ 86%] ../images/wfi.svg
copying images... [ 93%] ../images/xif_integration.png
copying images... [100%] ../images/xif_timing_budget.png

dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded.

The HTML pages are in ../../../_readthedocs/html.