Read the Docs build information Build id: 3720782 Project: canonical-kernel-docs Version: 78 Commit: 9d630ac7e3eb6e13eaa1d8dfa4dc09d8de855b56 Date: 2026-02-04T10:13:34.282365Z State: finished Success: False [rtd-command-info] start-time: 2026-02-04T10:13:35.263209Z, end-time: 2026-02-04T10:13:36.632644Z, duration: 1, exit-code: 0 git clone --depth 1 git@github.com:canonical/kernel-docs.git . Cloning into '.'... Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2026-02-04T10:13:36.735524Z, end-time: 2026-02-04T10:13:39.609338Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 pull/78/head:external-78 Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. From github.com:canonical/kernel-docs * [new ref] refs/pull/78/head -> external-78 Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. * [new tag] v2024.12.17-01.00 -> v2024.12.17-01.00 [rtd-command-info] start-time: 2026-02-04T10:13:40.601423Z, end-time: 2026-02-04T10:13:40.651690Z, duration: 0, exit-code: 0 git checkout --force 9d630ac7e3eb6e13eaa1d8dfa4dc09d8de855b56 Note: switching to '9d630ac7e3eb6e13eaa1d8dfa4dc09d8de855b56'. 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 9d630ac reference: snap lifecycle documentation [rtd-command-info] start-time: 2026-02-04T10:13:40.737899Z, end-time: 2026-02-04T10:13:40.777675Z, duration: 0, exit-code: 0 cat docs/.readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" jobs: pre_install: - git fetch --unshallow || true post_checkout: # Cancel building pull requests when there aren't changed in the docs directory. # If there are no changes (git diff exits with 0) we force the command to return with 183. # This is a special exit code on Read the Docs that will cancel the build immediately. # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition - | if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml'; then exit 183; fi # Build documentation in the docs/ directory with Sphinx sphinx: builder: dirhtml configuration: docs/conf.py fail_on_warning: true # If using Sphinx, optionally build your docs in additional formats such as PDF formats: - pdf # Optionally declare the Python requirements required to build your docs python: install: - requirements: docs/.sphinx/requirements.txt [rtd-command-info] start-time: 2026-02-04T10:13:40.865705Z, end-time: 2026-02-04T10:13:40.910991Z, duration: 0, exit-code: 0 if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml'; then exit 183; fi [rtd-command-info] start-time: 2026-02-04T10:13:47.585192Z, end-time: 2026-02-04T10:13:47.648557Z, duration: 0, exit-code: 0 asdf global python 3.11.12 [rtd-command-info] start-time: 2026-02-04T10:13:48.121909Z, end-time: 2026-02-04T10:13:49.229669Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.12.final.0-64 in 814ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78, 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: 2026-02-04T10:13:49.323293Z, end-time: 2026-02-04T10:13:50.824603Z, duration: 1, exit-code: 0 git fetch --unshallow || true Warning: Permanently added 'github.com' (ED25519) to the list of known hosts. [rtd-command-info] start-time: 2026-02-04T10:13:50.918576Z, end-time: 2026-02-04T10:14:01.967077Z, 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/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (23.1) Collecting pip Downloading pip-26.0-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.6 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (67.6.1) Collecting setuptools Downloading setuptools-80.10.2-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 19.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-26.0 setuptools-80.10.2 [rtd-command-info] start-time: 2026-02-04T10:14:02.099217Z, end-time: 2026-02-04T10:14:07.948247Z, duration: 5, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-9.0.4-py3-none-any.whl.metadata (5.8 kB) Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx) Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB) Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx) Downloading sphinxcontrib_qthelp-2.0.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 Jinja2>=3.1 (from sphinx) Downloading jinja2-3.1.6-py3-none-any.whl.metadata (2.9 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.19.2-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.23,>=0.20 (from sphinx) Downloading docutils-0.22.4-py3-none-any.whl.metadata (15 kB) Collecting snowballstemmer>=2.2 (from sphinx) Downloading snowballstemmer-3.0.1-py3-none-any.whl.metadata (7.9 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.18.0-py3-none-any.whl.metadata (2.2 kB) Collecting alabaster>=0.7.14 (from sphinx) Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 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.5-py3-none-any.whl.metadata (4.9 kB) Collecting roman-numerals>=1.0.0 (from sphinx) Downloading roman_numerals-4.1.0-py3-none-any.whl.metadata (3.3 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-26.0-py3-none-any.whl.metadata (3.3 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading markupsafe-3.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.7 kB) Collecting charset_normalizer<4,>=2 (from requests>=2.30.0->sphinx) Downloading charset_normalizer-3.4.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (37 kB) Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx) Downloading idna-3.11-py3-none-any.whl.metadata (8.4 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx) Downloading urllib3-2.6.3-py3-none-any.whl.metadata (6.9 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2026.1.4-py3-none-any.whl.metadata (2.5 kB) Downloading sphinx-9.0.4-py3-none-any.whl (3.9 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.9/3.9 MB 100.9 MB/s 0:00:00 Downloading docutils-0.22.4-py3-none-any.whl (633 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 633.2/633.2 kB 448.5 MB/s 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.18.0-py3-none-any.whl (10.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.2/10.2 MB 304.7 MB/s 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.6-py3-none-any.whl (134 kB) Downloading markupsafe-3.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (22 kB) Downloading packaging-26.0-py3-none-any.whl (74 kB) Downloading pygments-2.19.2-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 348.4 MB/s 0:00:00 Downloading requests-2.32.5-py3-none-any.whl (64 kB) Downloading charset_normalizer-3.4.4-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (151 kB) Downloading idna-3.11-py3-none-any.whl (71 kB) Downloading urllib3-2.6.3-py3-none-any.whl (131 kB) Downloading certifi-2026.1.4-py3-none-any.whl (152 kB) Downloading roman_numerals-4.1.0-py3-none-any.whl (7.7 kB) Downloading snowballstemmer-3.0.1-py3-none-any.whl (103 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_htmlhelp-2.1.0-py3-none-any.whl (98 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 sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl (92 kB) Installing collected packages: urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, roman-numerals, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset_normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx Successfully installed Jinja2-3.1.6 MarkupSafe-3.0.3 Pygments-2.19.2 alabaster-1.0.0 babel-2.18.0 certifi-2026.1.4 charset_normalizer-3.4.4 docutils-0.22.4 idna-3.11 imagesize-1.4.1 packaging-26.0 requests-2.32.5 roman-numerals-4.1.0 snowballstemmer-3.0.1 sphinx-9.0.4 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 urllib3-2.6.3 [rtd-command-info] start-time: 2026-02-04T10:14:08.038321Z, end-time: 2026-02-04T10:14:14.263897Z, duration: 6, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/.sphinx/requirements.txt Collecting sphinx-autobuild (from -r docs/.sphinx/requirements.txt (line 2)) Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl.metadata (8.5 kB) Collecting sphinx-last-updated-by-git (from -r docs/.sphinx/requirements.txt (line 4)) Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl.metadata (7.1 kB) Collecting canonical-sphinx[full] (from -r docs/.sphinx/requirements.txt (line 1)) Downloading canonical_sphinx-0.5.2-py3-none-any.whl.metadata (5.8 kB) Collecting sphinxcontrib-svg2pdfconverter[CairoSVG] (from -r docs/.sphinx/requirements.txt (line 3)) Downloading sphinxcontrib_svg2pdfconverter-2.0.0-py3-none-any.whl.metadata (3.3 kB) Requirement already satisfied: Sphinx>=7.1.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (9.0.4) Collecting furo (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading furo-2025.12.19-py3-none-any.whl.metadata (4.9 kB) Collecting myst-parser (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading myst_parser-5.0.0-py3-none-any.whl.metadata (5.6 kB) Collecting linkify-it-py (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading linkify_it_py-2.0.3-py3-none-any.whl.metadata (8.5 kB) Collecting canonical-sphinx-extensions (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading canonical_sphinx_extensions-0.0.34-py3-none-any.whl.metadata (16 kB) Collecting sphinx-copybutton (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB) Collecting sphinx-design (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_design-0.7.0-py3-none-any.whl.metadata (5.5 kB) Collecting sphinx-notfound-page (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl.metadata (2.9 kB) Collecting sphinx-reredirects (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_reredirects-1.1.0-py3-none-any.whl.metadata (4.7 kB) Collecting sphinx-tabs (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_tabs-3.4.7-py3-none-any.whl.metadata (6.3 kB) Collecting sphinxcontrib-jquery (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) Collecting sphinxext-opengraph (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinxext_opengraph-0.13.0-py3-none-any.whl.metadata (2.7 kB) Collecting pyspelling (from canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading pyspelling-2.12.1-py3-none-any.whl.metadata (3.7 kB) Collecting colorama>=0.4.6 (from sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB) Collecting starlette>=0.35 (from sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading starlette-0.52.1-py3-none-any.whl.metadata (6.3 kB) Collecting uvicorn>=0.25 (from sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading uvicorn-0.40.0-py3-none-any.whl.metadata (6.7 kB) Collecting watchfiles>=0.20 (from sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading watchfiles-1.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.9 kB) Collecting websockets>=11 (from sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading websockets-16.0-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.metadata (6.8 kB) Collecting cairosvg>=1.0 (from sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading cairosvg-2.8.2-py3-none-any.whl.metadata (2.7 kB) Collecting cairocffi (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading cairocffi-1.7.1-py3-none-any.whl.metadata (3.3 kB) Collecting cssselect2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading cssselect2-0.8.0-py3-none-any.whl.metadata (2.9 kB) Collecting defusedxml (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading defusedxml-0.7.1-py2.py3-none-any.whl.metadata (32 kB) Collecting pillow (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading pillow-12.1.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.metadata (8.8 kB) Collecting tinycss2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading tinycss2-1.5.1-py3-none-any.whl.metadata (3.0 kB) Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.1.0) Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (3.1.6) Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.19.2) Requirement already satisfied: docutils<0.23,>=0.20 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (0.22.4) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (3.0.1) Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.18.0) Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (1.0.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (1.4.1) Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.32.5) Requirement already satisfied: roman-numerals>=1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (4.1.0) Requirement already satisfied: packaging>=23.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (26.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from Jinja2>=3.1->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (3.0.3) Requirement already satisfied: charset_normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (3.4.4) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (3.11) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2.6.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) (2026.1.4) Collecting anyio<5,>=3.6.2 (from starlette>=0.35->sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading anyio-4.12.1-py3-none-any.whl.metadata (4.3 kB) Collecting typing-extensions>=4.10.0 (from starlette>=0.35->sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading typing_extensions-4.15.0-py3-none-any.whl.metadata (3.3 kB) Collecting click>=7.0 (from uvicorn>=0.25->sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading click-8.3.1-py3-none-any.whl.metadata (2.6 kB) Collecting h11>=0.8 (from uvicorn>=0.25->sphinx-autobuild->-r docs/.sphinx/requirements.txt (line 2)) Downloading h11-0.16.0-py3-none-any.whl.metadata (8.3 kB) Collecting cffi>=1.1.0 (from cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading cffi-2.0.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.metadata (2.6 kB) Collecting pycparser (from cffi>=1.1.0->cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading pycparser-3.0-py3-none-any.whl.metadata (8.2 kB) Collecting beautifulsoup4 (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading beautifulsoup4-4.14.3-py3-none-any.whl.metadata (3.8 kB) Collecting gitpython (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading gitpython-3.1.46-py3-none-any.whl.metadata (13 kB) Collecting soupsieve>=1.6.1 (from beautifulsoup4->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading soupsieve-2.8.3-py3-none-any.whl.metadata (4.6 kB) Collecting webencodings (from cssselect2->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/.sphinx/requirements.txt (line 3)) Downloading webencodings-0.5.1-py2.py3-none-any.whl.metadata (2.1 kB) Collecting sphinx-basic-ng>=1.0.0.beta2 (from furo->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB) Collecting accessible-pygments>=0.0.5 (from furo->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading accessible_pygments-0.0.5-py3-none-any.whl.metadata (10 kB) Collecting gitdb<5,>=4.0.1 (from gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading gitdb-4.0.12-py3-none-any.whl.metadata (1.2 kB) Collecting smmap<6,>=3.0.1 (from gitdb<5,>=4.0.1->gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading smmap-5.0.2-py3-none-any.whl.metadata (4.3 kB) Collecting uc-micro-py (from linkify-it-py->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading uc_micro_py-1.0.3-py3-none-any.whl.metadata (2.0 kB) Collecting markdown-it-py~=4.0 (from myst-parser->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading markdown_it_py-4.0.0-py3-none-any.whl.metadata (7.3 kB) Collecting mdit-py-plugins~=0.5 (from myst-parser->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading mdit_py_plugins-0.5.0-py3-none-any.whl.metadata (2.8 kB) Collecting pyyaml (from myst-parser->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading pyyaml-6.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.4 kB) Collecting mdurl~=0.1 (from markdown-it-py~=4.0->myst-parser->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB) Collecting html5lib (from pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading html5lib-1.1-py2.py3-none-any.whl.metadata (16 kB) Collecting lxml (from pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading lxml-6.0.2-cp311-cp311-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl.metadata (3.6 kB) Collecting markdown (from pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading markdown-3.10.1-py3-none-any.whl.metadata (5.1 kB) Collecting wcmatch>=8.5 (from pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading wcmatch-10.1-py3-none-any.whl.metadata (5.1 kB) Collecting bracex>=2.1.1 (from wcmatch>=8.5->pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading bracex-2.6-py3-none-any.whl.metadata (3.6 kB) Collecting six>=1.9 (from html5lib->pyspelling->canonical-sphinx[full]->-r docs/.sphinx/requirements.txt (line 1)) Downloading six-1.17.0-py2.py3-none-any.whl.metadata (1.7 kB) Downloading canonical_sphinx-0.5.2-py3-none-any.whl (1.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 58.9 MB/s 0:00:00 Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl (12 kB) Downloading sphinxcontrib_svg2pdfconverter-2.0.0-py3-none-any.whl (8.3 kB) Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl (8.6 kB) Downloading cairosvg-2.8.2-py3-none-any.whl (45 kB) Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB) Downloading starlette-0.52.1-py3-none-any.whl (74 kB) Downloading anyio-4.12.1-py3-none-any.whl (113 kB) Downloading typing_extensions-4.15.0-py3-none-any.whl (44 kB) Downloading uvicorn-0.40.0-py3-none-any.whl (68 kB) Downloading click-8.3.1-py3-none-any.whl (108 kB) Downloading h11-0.16.0-py3-none-any.whl (37 kB) Downloading watchfiles-1.1.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (456 kB) Downloading websockets-16.0-cp311-cp311-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (184 kB) Downloading cairocffi-1.7.1-py3-none-any.whl (75 kB) Downloading cffi-2.0.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (215 kB) Downloading canonical_sphinx_extensions-0.0.34-py3-none-any.whl (67 kB) Downloading beautifulsoup4-4.14.3-py3-none-any.whl (107 kB) Downloading soupsieve-2.8.3-py3-none-any.whl (37 kB) Downloading cssselect2-0.8.0-py3-none-any.whl (15 kB) Downloading defusedxml-0.7.1-py2.py3-none-any.whl (25 kB) Downloading furo-2025.12.19-py3-none-any.whl (339 kB) Downloading accessible_pygments-0.0.5-py3-none-any.whl (1.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 119.1 MB/s 0:00:00 Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB) Downloading gitpython-3.1.46-py3-none-any.whl (208 kB) Downloading gitdb-4.0.12-py3-none-any.whl (62 kB) Downloading smmap-5.0.2-py3-none-any.whl (24 kB) Downloading linkify_it_py-2.0.3-py3-none-any.whl (19 kB) Downloading myst_parser-5.0.0-py3-none-any.whl (84 kB) Downloading markdown_it_py-4.0.0-py3-none-any.whl (87 kB) Downloading mdit_py_plugins-0.5.0-py3-none-any.whl (57 kB) Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB) Downloading pillow-12.1.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.0/7.0 MB 282.2 MB/s 0:00:00 Downloading pycparser-3.0-py3-none-any.whl (48 kB) Downloading pyspelling-2.12.1-py3-none-any.whl (45 kB) Downloading wcmatch-10.1-py3-none-any.whl (39 kB) Downloading bracex-2.6-py3-none-any.whl (11 kB) Downloading html5lib-1.1-py2.py3-none-any.whl (112 kB) Downloading six-1.17.0-py2.py3-none-any.whl (11 kB) Downloading lxml-6.0.2-cp311-cp311-manylinux_2_26_x86_64.manylinux_2_28_x86_64.whl (5.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.2/5.2 MB 248.4 MB/s 0:00:00 Downloading markdown-3.10.1-py3-none-any.whl (107 kB) Downloading pyyaml-6.0.3-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (806 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 806.6/806.6 kB 675.3 MB/s 0:00:00 Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB) Downloading sphinx_design-0.7.0-py3-none-any.whl (2.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 614.8 MB/s 0:00:00 Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl (8.2 kB) Downloading sphinx_reredirects-1.1.0-py3-none-any.whl (6.4 kB) Downloading sphinx_tabs-3.4.7-py3-none-any.whl (9.7 kB) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Downloading sphinxext_opengraph-0.13.0-py3-none-any.whl (1.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 609.4 MB/s 0:00:00 Downloading tinycss2-1.5.1-py3-none-any.whl (28 kB) Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB) Downloading uc_micro_py-1.0.3-py3-none-any.whl (6.2 kB) Installing collected packages: webencodings, websockets, uc-micro-py, typing-extensions, tinycss2, soupsieve, smmap, six, pyyaml, pycparser, pillow, mdurl, markdown, lxml, h11, defusedxml, colorama, click, bracex, accessible-pygments, wcmatch, uvicorn, markdown-it-py, linkify-it-py, html5lib, gitdb, cssselect2, cffi, beautifulsoup4, anyio, watchfiles, starlette, sphinxext-opengraph, sphinxcontrib-svg2pdfconverter, sphinxcontrib-jquery, sphinx-tabs, sphinx-reredirects, sphinx-notfound-page, sphinx-last-updated-by-git, sphinx-design, sphinx-copybutton, sphinx-basic-ng, pyspelling, mdit-py-plugins, gitpython, cairocffi, sphinx-autobuild, myst-parser, furo, canonical-sphinx-extensions, cairosvg, canonical-sphinx Successfully installed accessible-pygments-0.0.5 anyio-4.12.1 beautifulsoup4-4.14.3 bracex-2.6 cairocffi-1.7.1 cairosvg-2.8.2 canonical-sphinx-0.5.2 canonical-sphinx-extensions-0.0.34 cffi-2.0.0 click-8.3.1 colorama-0.4.6 cssselect2-0.8.0 defusedxml-0.7.1 furo-2025.12.19 gitdb-4.0.12 gitpython-3.1.46 h11-0.16.0 html5lib-1.1 linkify-it-py-2.0.3 lxml-6.0.2 markdown-3.10.1 markdown-it-py-4.0.0 mdit-py-plugins-0.5.0 mdurl-0.1.2 myst-parser-5.0.0 pillow-12.1.0 pycparser-3.0 pyspelling-2.12.1 pyyaml-6.0.3 six-1.17.0 smmap-5.0.2 soupsieve-2.8.3 sphinx-autobuild-2025.8.25 sphinx-basic-ng-1.0.0b2 sphinx-copybutton-0.5.2 sphinx-design-0.7.0 sphinx-last-updated-by-git-0.3.8 sphinx-notfound-page-1.1.0 sphinx-reredirects-1.1.0 sphinx-tabs-3.4.7 sphinxcontrib-jquery-4.1 sphinxcontrib-svg2pdfconverter-2.0.0 sphinxext-opengraph-0.13.0 starlette-0.52.1 tinycss2-1.5.1 typing-extensions-4.15.0 uc-micro-py-1.0.3 uvicorn-0.40.0 watchfiles-1.1.1 wcmatch-10.1 webencodings-0.5.1 websockets-16.0 [rtd-command-info] start-time: 2026-02-04T10:14:14.411768Z, end-time: 2026-02-04T10:14:14.456367Z, duration: 0, exit-code: 0 cat docs/conf.py import datetime import ast import os # Configuration for the Sphinx documentation builder. # All configuration specific to your project should be done in this file. # # If you're new to Sphinx and don't want any advanced or custom features, # just go through the items marked 'TODO'. # # A complete list of built-in Sphinx configuration values: # https://www.sphinx-doc.org/en/master/usage/configuration.html # # Our starter pack uses the custom Canonical Sphinx extension # to keep all documentation based on it consistent and on brand: # https://github.com/canonical/canonical-sphinx ####################### # Project information # ####################### # Project name # # TODO: Update with the official name of your project or product project = "Ubuntu Kernel" author = "Canonical Kernel team" # Sidebar documentation title; best kept reasonably short # # TODO: To include a version number, add it here (hardcoded or automated). # # TODO: To disable the title, set to an empty string. html_title = project + " documentation" # Copyright string; shown at the bottom of the page # # Now, the starter pack uses CC-BY-SA as the license # and the current year as the copyright year. # # TODO: If your docs need another license, specify it instead of 'CC-BY-SA'. # # TODO: If your documentation is a part of the code repository of your project, # it inherits the code license instead; specify it instead of 'CC-BY-SA'. # # NOTE: For static works, it is common to provide the first publication year. # Another option is to provide both the first year of publication # and the current year, especially for docs that frequently change, # e.g. 2022–2023 (note the en-dash). # # A way to check a repo's creation date is to get a classic GitHub token # with 'repo' permissions; see https://github.com/settings/tokens # Next, use 'curl' and 'jq' to extract the date from the API's output: # # curl -H 'Authorization: token ' \ # -H 'Accept: application/vnd.github.v3.raw' \ # https://api.github.com/repos/canonical/ | jq '.created_at' copyright = "%s CC-BY-SA, %s" % (datetime.date.today().year, author) # Documentation website URL # # TODO: Update with the official URL of your docs or leave empty if unsure. # # NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph # and is used by social media platforms; see https://ogp.me/ ogp_site_url = "https://canonical-kernel-docs.readthedocs-hosted.com/" # Preview name of the documentation website # # TODO: To use a different name for the project in previews, update as needed. ogp_site_name = project # Preview image URL # # TODO: To customise the preview image, update as needed. ogp_image = "https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg" # Product favicon; shown in bookmarks, browser tabs, etc. # TODO: To customise the favicon, uncomment and update as needed. # html_favicon = '.sphinx/_static/favicon.png' # Dictionary of values to pass into the Sphinx context for all pages: # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_context html_context = { # Product page URL; can be different from product docs URL # # TODO: Change to your product website URL, # dropping the 'https://' prefix, e.g. 'ubuntu.com/lxd'. # # TODO: If there's no such website, # remove the {{ product_page }} link from the page header template # (usually .sphinx/_templates/header.html; also, see README.rst). "product_page": "kernel.ubuntu.com", # Product tag image; the orange part of your logo, shown in the page header # # TODO: To add a tag image, uncomment and update as needed. # 'product_tag': '_static/tag.png', # Your Discourse instance URL # # TODO: Change to your Discourse instance URL or leave empty. # # NOTE: If set, adding ':discourse: 123' to an .rst file # will add a link to Discourse topic 123 at the bottom of the page. "discourse": "https://discourse.ubuntu.com/t/ask-us-anything-about-ubuntu-kernels/27664", # Your Mattermost channel URL # # TODO: Change to your Mattermost channel URL or leave empty. "mattermost": "https://chat.canonical.com/canonical/channels/kernel", # Your Matrix channel URL # # TODO: Change to your Matrix channel URL or leave empty. "matrix": "", # Your documentation GitHub repository URL # # TODO: Change to your documentation GitHub repository URL or leave empty. # # NOTE: If set, links for viewing the documentation source files # and creating GitHub issues are added at the bottom of each page. "github_url": "https://github.com/canonical/kernel-docs", # Docs branch in the repo; used in links for viewing the source files # # TODO: To customise the branch, uncomment and update as needed. 'repo_default_branch': 'main', # Docs location in the repo; used in links for viewing the source files # # TODO: To customise the directory, uncomment and update as needed. "repo_folder": "/docs/", # TODO: To enable or disable the Previous / Next buttons at the bottom of pages # Valid options: none, prev, next, both # "sequential_nav": "both", # TODO: To enable listing contributors on individual pages, set to True "display_contributors": False, # Required for feedback button 'github_issues': 'enabled', } # Project slug; see https://meta.discourse.org/t/what-is-category-slug/87897 # # TODO: If your documentation is hosted on https://docs.ubuntu.com/, # uncomment and update as needed. # slug = '' # Template and asset locations html_static_path = [".sphinx/_static"] templates_path = [".sphinx/_templates"] ############# # Redirects # ############# # To set up redirects: https://documatt.gitlab.io/sphinx-reredirects/usage.html # For example: 'explanation/old-name.html': '../how-to/prettify.html', # To set up redirects in the Read the Docs project dashboard: # https://docs.readthedocs.io/en/stable/guides/redirects.html # NOTE: If undefined, set to None, or empty, # the sphinx_reredirects extension will be disabled. redirects = { "reference/patch_acceptance_criteria/index.html": "../patch-acceptance-criteria/", "how-to/develop-customize/": "how-to/develop-customise/", "how-to/develop-customize/build-kernel/": "how-to/develop-customise/build-kernel/", "how-to/develop-customize/build-kernel-snap/": "how-to/develop-customise/build-kernel-snap/", } ########################### # Link checker exceptions # ########################### # A regex list of URLs that are ignored by 'make linkcheck' # # TODO: Remove or adjust the ACME entry after you update the contributing guide linkcheck_ignore = [ "http://127.0.0.1:8000", "https://github.com/canonical/ACME/*" ] # A regex list of URLs where anchors are ignored by 'make linkcheck' linkcheck_anchors_ignore_for_url = [ r"https://github\.com/.*", r"https://ubuntu.com/about/release-cycle", r"https://snapcraft.io/docs/", ] # give linkcheck multiple tries on failure # linkcheck_timeout = 30 linkcheck_retries = 3 ######################## # Configuration extras # ######################## # Custom MyST syntax extensions; see # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html # # NOTE: By default, the following MyST extensions are enabled: # substitution, deflist, linkify # myst_enable_extensions = set() # Custom Sphinx extensions; see # https://www.sphinx-doc.org/en/master/usage/extensions/index.html # NOTE: The canonical_sphinx extension is required for the starter pack. # It automatically enables the following extensions: # - custom-rst-roles # - myst_parser # - notfound.extension # - related-links # - sphinx_copybutton # - sphinx_design # - sphinx_reredirects # - sphinx_tabs.tabs # - sphinxcontrib.jquery # - sphinxext.opengraph # - terminal-output # - youtube-links extensions = [ "canonical_sphinx", "sphinxcontrib.cairosvgconverter", ] # Excludes files or directories from processing exclude_patterns = [ "doc-cheat-sheet*", "how-to-backup/*", ] # Adds custom CSS files, located under 'html_static_path' html_css_files = [ "css/pdf.css", ] # Adds custom JavaScript files, located under 'html_static_path' # html_js_files = [] # Specifies a reST snippet to be appended to each .rst file rst_epilog = """ .. include:: /reuse/links.txt """ # Feedback button at the top; enabled by default # # TODO: To disable the button, uncomment this. # disable_feedback_button = True # Your manpage URL # # TODO: To enable manpage links, uncomment and update as needed. # # NOTE: If set, adding ':manpage:' to an .rst file # adds a link to the corresponding man section at the bottom of the page. manpages_url = ( "https://manpages.ubuntu.com/manpages/noble/en/" + "man{section}/{page}.{section}.html" ) # Specifies a reST snippet to be prepended to each .rst file # This defines a :center: role that centers table cell content. # This defines a :h2: role that styles content for use with PDF generation. rst_prolog = """ .. role:: center :class: align-center .. role:: h2 :class: hclass2 .. role:: woke-ignore :class: woke-ignore .. role:: vale-ignore :class: vale-ignore """ # Workaround for https://github.com/canonical/canonical-sphinx/issues/34 if "discourse_prefix" not in html_context and "discourse" in html_context: html_context["discourse_prefix"] = html_context["discourse"] + "/t/" ###################### # DOCX configuration # ###################### docx_documents = [ ('index', 'docxbuilder.docx', { 'title': 'Docxbuilder documentation', 'created': 'author', 'subject': 'Sphinx builder extension', 'keywords': ['sphinx'] }, 'true'), ] ############## # Tags setup # ############## if ('DEFAULT' in os.environ) and (os.environ['DEFAULT'] == 'True'): tags.add('default') else: os.environ['DEFAULT'] = 'False' tags.add('docx') [rtd-command-info] start-time: 2026-02-04T10:14:14.545519Z, end-time: 2026-02-04T10:14:16.621084Z, duration: 2, exit-code: 2 python -m sphinx -T -W --keep-going -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v9.0.4 loading translations [en]... done sphinx_design found. sphinx_design is now configured. sphinx_tabs.tabs found. sphinx_tabs.tabs is now configured. sphinx_reredirects found. sphinx_reredirects is now configured. canonical.youtube-links found. canonical.youtube-links is now configured. canonical.related-links found. canonical.related-links is now configured. canonical.custom-rst-roles found. canonical.custom-rst-roles is now configured. canonical.terminal-output found. canonical.terminal-output is now configured. canonical.contributor-listing found. canonical.contributor-listing is now configured. sphinx_copybutton found. sphinx_copybutton is now configured. sphinxext.opengraph found. sphinxext.opengraph is now configured. sphinxcontrib.jquery found. sphinxcontrib.jquery is now configured. notfound.extension found. notfound.extension is now configured. sphinxcontrib.cairosvgconverter found. sphinxcontrib.cairosvgconverter is now configured. sphinx_last_updated_by_git found. sphinx_last_updated_by_git is now configured. matplotlib is not installed, social cards will not be generated making output directory... done myst v5.0.0: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'deflist', 'substitution', 'linkify'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True) building [mo]: targets for 0 po files that are out of date writing output... building [dirhtml]: targets for 24 source files that are out of date updating environment: [new config] 24 added, 0 changed, 0 removed reading sources... [ 4%] explanation/index reading sources... [ 8%] explanation/post-release-updates reading sources... [ 12%] explanation/stable-release-updates reading sources... [ 17%] explanation/ubuntu-linux-kernel-sources reading sources... [ 21%] how-to/contribute reading sources... [ 25%] how-to/develop-customise/build-kernel reading sources... [ 29%] how-to/develop-customise/build-kernel-snap reading sources... [ 33%] how-to/develop-customise/index reading sources... [ 38%] how-to/index reading sources... [ 42%] how-to/source-code/enable-source-repositories reading sources... [ 46%] how-to/source-code/index reading sources... [ 50%] how-to/source-code/obtain-kernel-source-git reading sources... [ 54%] how-to/source-code/send-patches reading sources... [ 58%] how-to/testing-verification/test-kernel-in-proposed reading sources... [ 62%] index reading sources... [ 67%] reference/dkms-upload-rights reading sources... [ 71%] reference/glossary reading sources... [ 75%] reference/hwe-kernels reading sources... [ 79%] reference/index reading sources... [ 83%] reference/kernel-upload-rights reading sources... [ 88%] reference/oem-kernels reading sources... [ 92%] reference/patch-acceptance-criteria reading sources... [ 96%] reference/snap-lifecycle reading sources... [100%] reference/stable-patch-format getting Git timestamps for source files... [ 14%] explanation getting Git timestamps for source files... [ 29%] how-to getting Git timestamps for source files... [ 43%] how-to/develop-customise getting Git timestamps for source files... [ 57%] how-to/source-code getting Git timestamps for source files... [ 71%] how-to/testing-verification getting Git timestamps for source files... [ 86%] . getting Git timestamps for source files... [100%] reference getting Git timestamps for dependencies... [ 50%] _images getting Git timestamps for dependencies... [100%] reuse looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/checkouts/78/_readthedocs/html/_static/language_data.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/checkouts/78/_readthedocs/html/_static/basic.css Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/checkouts/78/_readthedocs/html/_static/documentation_options.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/checkouts/78/_readthedocs/html/_static/copybutton.js copying static files: done copying extra files... copying extra files: done copying assets: done writing output... [ 4%] explanation/index writing output... [ 8%] explanation/post-release-updates writing output... [ 12%] explanation/stable-release-updates writing output... [ 17%] explanation/ubuntu-linux-kernel-sources writing output... [ 21%] how-to/contribute writing output... [ 25%] how-to/develop-customise/build-kernel writing output... [ 29%] how-to/develop-customise/build-kernel-snap writing output... [ 33%] how-to/develop-customise/index writing output... [ 38%] how-to/index writing output... [ 42%] how-to/source-code/enable-source-repositories writing output... [ 46%] how-to/source-code/index writing output... [ 50%] how-to/source-code/obtain-kernel-source-git writing output... [ 54%] how-to/source-code/send-patches writing output... [ 58%] how-to/testing-verification/test-kernel-in-proposed writing output... [ 62%] index writing output... [ 67%] reference/dkms-upload-rights writing output... [ 71%] reference/glossary writing output... [ 75%] reference/hwe-kernels Versions ======== * Platform: linux; (Linux-6.8.0-1021-aws-x86_64-with-glibc2.35) * Python version: 3.11.12 (CPython) * Sphinx version: 9.0.4 * Docutils version: 0.22.4 * Jinja2 version: 3.1.6 * Pygments version: 2.19.2 Last Messages ============= writing output... [ 67%] reference/dkms-upload-rights writing output... [ 71%] reference/glossary writing output... [ 75%] reference/hwe-kernels Loaded Extensions ================= * sphinx.ext.mathjax (9.0.4) * alabaster (1.0.0) * sphinxcontrib.applehelp (2.0.0) * sphinxcontrib.devhelp (2.0.0) * sphinxcontrib.htmlhelp (2.1.0) * sphinxcontrib.serializinghtml (2.0.0) * sphinxcontrib.qthelp (2.0.0) * myst_parser (5.0.0) * sphinx_design (0.7.0) * sphinx_tabs.tabs (unknown version) * sphinx_reredirects (unknown version) * canonical.youtube-links (0.1) * canonical.related-links (0.1) * canonical.custom-rst-roles (unknown version) * canonical.terminal-output (0.1) * canonical.contributor-listing (1.0.0) * sphinx_copybutton (0.5.2) * sphinxext.opengraph (0.13.0) * sphinxcontrib.jquery (4.1) * notfound.extension (1.1.0) * sphinx_last_updated_by_git (0.3.8) * canonical_sphinx.config (0.1) * canonical_sphinx (unknown version) * canonical_sphinx.theme (unknown version) * furo (2025.12.19) * sphinx_basic_ng (1.0.0.beta2) Traceback ========= Traceback (most recent call last): File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/cmd/build.py", line 432, in build_main app.build(args.force_all, args.filenames) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/application.py", line 442, in build self.builder.build_update() File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 380, in build_update self.build( File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 459, in build self.write(docnames, updated_docnames, method) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 747, in write self.write_documents(docnames) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 761, in write_documents self._write_serial(sorted_docnames) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 776, in _write_serial _write_docname(docname, env=self.env, builder=self, tags=self.tags) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/__init__.py", line 889, in _write_docname builder.write_doc(docname, doctree) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/builders/html/__init__.py", line 659, in write_doc doctree.walkabout(visitor) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/docutils/nodes.py", line 232, in walkabout if child.walkabout(visitor): ^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/docutils/nodes.py", line 232, in walkabout if child.walkabout(visitor): ^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/docutils/nodes.py", line 232, in walkabout if child.walkabout(visitor): ^^^^^^^^^^^^^^^^^^^^^^^^ [Previous line repeated 1 more time] File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/docutils/nodes.py", line 224, in walkabout visitor.dispatch_visit(self) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx/util/docutils.py", line 783, in dispatch_visit method(node) File "/home/docs/checkouts/readthedocs.org/user_builds/canonical-kernel-docs/envs/78/lib/python3.11/site-packages/sphinx_tabs/tabs.py", line 69, in visit attrs.pop("backrefs") KeyError: 'backrefs' The full traceback has been saved in: /tmp/sphinx-err-srt4z17r.log To report this error to the developers, please open an issue at . Thanks! Please also report this if it was a user error, so that a better error message can be provided next time.