Read the Docs build information
Build id: 4289972
Project: canonical-k8s-snap
Version: latest
Commit: 8fb07f4a444b8321b6fc27bdde45a82b5f804e60
Date: 2026-08-06T09:53:33.765009Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2026-08-06T09:54:31.954950Z, end-time: 2026-08-06T09:54:32.690806Z, duration: 0, exit-code: 0
git clone --depth 1 https://github.com/canonical/k8s-snap.git .
Cloning into '.'...

[rtd-command-info] start-time: 2026-08-06T09:54:32.778487Z, end-time: 2026-08-06T09:54:33.331488Z, duration: 0, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main


[rtd-command-info] start-time: 2026-08-06T09:54:34.108388Z, end-time: 2026-08-06T09:54:34.179697Z, duration: 0, exit-code: 0
git checkout --force origin/main
Note: switching to 'origin/main'.

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

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

  git switch -c <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 8fb07f4 Add related links to reference and explanation (#2657)

[rtd-command-info] start-time: 2026-08-06T09:54:34.261130Z, end-time: 2026-08-06T09:54:34.304410Z, duration: 0, exit-code: 0
cat docs/canonicalk8s/.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.12"
  jobs:
    post_checkout:
      # Cancel building pull requests when there aren't changed in the docs directory or YAML file.
      #
      # https://docs.readthedocs.io/en/latest/build-customization.html#cancel-build-based-on-a-condition
      # 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.
      - |
        git fetch --unshallow || true
        if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml;
        then
          exit 183;
        fi
        ls

# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: dirhtml
  configuration: docs/canonicalk8s/conf.py

# 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/canonicalk8s/requirements.txt

[rtd-command-info] start-time: 2026-08-06T09:54:34.377119Z, end-time: 2026-08-06T09:54:35.355977Z, duration: 0, exit-code: 0
git fetch --unshallow || true
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- docs/ .readthedocs.yaml;
then
  exit 183;
fi
ls
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
SECURITY.md
build-scripts
ci
docs
k8s
pyproject.toml
snap
tests

[rtd-command-info] start-time: 2026-08-06T09:54:39.483687Z, end-time: 2026-08-06T09:54:39.548885Z, duration: 0, exit-code: 0
asdf global python 3.12.13


[rtd-command-info] start-time: 2026-08-06T09:54:39.925288Z, end-time: 2026-08-06T09:54:40.606041Z, duration: 0, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.12.13.final.0-64 in 396ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/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: 2026-08-06T09:54:40.687520Z, end-time: 2026-08-06T09:54:46.492621Z, duration: 5, 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-k8s-snap/envs/latest/lib/python3.12/site-packages (23.1)
Collecting pip
  Downloading pip-26.2.1-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 14.5 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-83.0.0-py3-none-any.whl (1.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 27.4 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.2.1 setuptools-83.0.0

[rtd-command-info] start-time: 2026-08-06T09:54:46.570140Z, end-time: 2026-08-06T09:54:52.028593Z, duration: 5, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx
Collecting sphinx
  Downloading sphinx-9.1.0-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.20.0-py3-none-any.whl.metadata (2.5 kB)
Collecting docutils<0.23,>=0.21 (from sphinx)
  Downloading docutils-0.22.4-py3-none-any.whl.metadata (15 kB)
Collecting snowballstemmer>=2.2 (from sphinx)
  Downloading snowballstemmer-3.1.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-2.0.0-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting requests>=2.30.0 (from sphinx)
  Downloading requests-2.34.2-py3-none-any.whl.metadata (4.8 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.3-py3-none-any.whl.metadata (3.5 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx)
  Downloading markupsafe-3.0.3-cp312-cp312-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.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (41 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.18-py3-none-any.whl.metadata (6.1 kB)
Collecting urllib3<3,>=1.26 (from requests>=2.30.0->sphinx)
  Downloading urllib3-2.7.0-py3-none-any.whl.metadata (6.9 kB)
Collecting certifi>=2023.5.7 (from requests>=2.30.0->sphinx)
  Downloading certifi-2026.7.22-py3-none-any.whl.metadata (2.5 kB)
Downloading sphinx-9.1.0-py3-none-any.whl (3.9 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.9/3.9 MB 137.2 MB/s  0:00:00
Downloading docutils-0.22.4-py3-none-any.whl (633 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 633.2/633.2 kB 727.9 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 421.3 MB/s  0:00:00
Downloading imagesize-2.0.0-py2.py3-none-any.whl (9.4 kB)
Downloading jinja2-3.1.6-py3-none-any.whl (134 kB)
Downloading markupsafe-3.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (22 kB)
Downloading packaging-26.3-py3-none-any.whl (129 kB)
Downloading pygments-2.20.0-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 723.2 MB/s  0:00:00
Downloading requests-2.34.2-py3-none-any.whl (73 kB)
Downloading charset_normalizer-3.4.9-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (224 kB)
Downloading idna-3.18-py3-none-any.whl (65 kB)
Downloading urllib3-2.7.0-py3-none-any.whl (131 kB)
Downloading certifi-2026.7.22-py3-none-any.whl (136 kB)
Downloading roman_numerals-4.1.0-py3-none-any.whl (7.7 kB)
Downloading snowballstemmer-3.1.1-py3-none-any.whl (104 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.20.0 alabaster-1.0.0 babel-2.18.0 certifi-2026.7.22 charset_normalizer-3.4.9 docutils-0.22.4 idna-3.18 imagesize-2.0.0 packaging-26.3 requests-2.34.2 roman-numerals-4.1.0 snowballstemmer-3.1.1 sphinx-9.1.0 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.7.0

[rtd-command-info] start-time: 2026-08-06T09:54:52.127744Z, end-time: 2026-08-06T09:55:02.266774Z, duration: 10, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/canonicalk8s/requirements.txt
Collecting canonical-sphinx~=0.6 (from -r docs/canonicalk8s/requirements.txt (line 2))
  Downloading canonical_sphinx-0.6.0-py3-none-any.whl.metadata (5.8 kB)
Collecting myst-parser~=4.0 (from -r docs/canonicalk8s/requirements.txt (line 5))
  Downloading myst_parser-4.0.1-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx-autobuild (from -r docs/canonicalk8s/requirements.txt (line 6))
  Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl.metadata (8.5 kB)
Collecting sphinx-design==0.6.1 (from -r docs/canonicalk8s/requirements.txt (line 7))
  Downloading sphinx_design-0.6.1-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx-notfound-page~=1.1 (from -r docs/canonicalk8s/requirements.txt (line 8))
  Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-reredirects==0.1.6 (from -r docs/canonicalk8s/requirements.txt (line 9))
  Downloading sphinx_reredirects-0.1.6-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-tabs~=3.5 (from -r docs/canonicalk8s/requirements.txt (line 10))
  Downloading sphinx_tabs-3.5.0-py3-none-any.whl.metadata (6.6 kB)
Collecting sphinxcontrib-jquery~=4.1 (from -r docs/canonicalk8s/requirements.txt (line 11))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)
Collecting sphinxext-opengraph~=0.13 (from -r docs/canonicalk8s/requirements.txt (line 12))
  Downloading sphinxext_opengraph-0.13.0-py3-none-any.whl.metadata (2.7 kB)
Collecting sphinx-rerediraffe<1.0.0,>=0.0.3 (from -r docs/canonicalk8s/requirements.txt (line 13))
  Downloading sphinx_rerediraffe-0.0.4-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-config-options~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 16))
  Downloading sphinx_config_options-0.1.1-py3-none-any.whl.metadata (3.1 kB)
Collecting sphinx-contributor-listing~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 17))
  Downloading sphinx_contributor_listing-0.1.0-py3-none-any.whl.metadata (2.7 kB)
Collecting sphinx-filtered-toctree~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 18))
  Downloading sphinx_filtered_toctree-0.1.0-py3-none-any.whl.metadata (1.8 kB)
Collecting sphinx-related-links~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 19))
  Downloading sphinx_related_links-0.1.2-py3-none-any.whl.metadata (2.5 kB)
Collecting sphinx-roles~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 20))
  Downloading sphinx_roles-0.1.0-py3-none-any.whl.metadata (1.5 kB)
Collecting sphinx-terminal~=1.0 (from -r docs/canonicalk8s/requirements.txt (line 21))
  Downloading sphinx_terminal-1.1.0-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-ubuntu-images~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 22))
  Downloading sphinx_ubuntu_images-0.2.0-py3-none-any.whl.metadata (4.5 kB)
Collecting sphinx-youtube-links~=0.1 (from -r docs/canonicalk8s/requirements.txt (line 23))
  Downloading sphinx_youtube_links-0.1.0-py3-none-any.whl.metadata (1.5 kB)
Requirement already satisfied: packaging~=26.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from -r docs/canonicalk8s/requirements.txt (line 26)) (26.3)
Collecting sphinxcontrib-svg2pdfconverter~=2.1 (from sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading sphinxcontrib_svg2pdfconverter-2.1.0-py3-none-any.whl.metadata (3.3 kB)
Collecting sphinx-last-updated-by-git~=0.3 (from -r docs/canonicalk8s/requirements.txt (line 28))
  Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl.metadata (7.1 kB)
Collecting sphinx-sitemap~=2.9 (from -r docs/canonicalk8s/requirements.txt (line 29))
  Downloading sphinx_sitemap-2.9.0-py3-none-any.whl.metadata (3.4 kB)
Collecting sphinx-llm~=0.4 (from -r docs/canonicalk8s/requirements.txt (line 30))
  Downloading sphinx_llm-0.4.1-py3-none-any.whl.metadata (25 kB)
Collecting rst2html (from -r docs/canonicalk8s/requirements.txt (line 33))
  Downloading rst2html-2020.7.4.tar.gz (1.5 kB)
  Installing build dependencies: started
  Installing build dependencies: finished with status 'done'
  Getting requirements to build wheel: started
  Getting requirements to build wheel: finished with status 'done'
  Preparing metadata (pyproject.toml): started
  Preparing metadata (pyproject.toml): finished with status 'done'
Collecting vale~=3.13 (from -r docs/canonicalk8s/requirements.txt (line 34))
  Downloading vale-3.13.0.0-py3-none-any.whl.metadata (3.0 kB)
Collecting sphinx<9,>=6 (from sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7))
  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 kB)
Collecting furo (from canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading furo-2025.12.19-py3-none-any.whl.metadata (4.9 kB)
Collecting linkify-it-py (from canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading linkify_it_py-2.1.0-py3-none-any.whl.metadata (8.5 kB)
Collecting docutils<0.22,>=0.19 (from myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5))
  Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB)
Requirement already satisfied: jinja2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5)) (3.1.6)
Collecting markdown-it-py~=3.0 (from myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5))
  Downloading markdown_it_py-3.0.0-py3-none-any.whl.metadata (6.9 kB)
Collecting mdit-py-plugins>=0.4.1,~=0.4 (from myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5))
  Downloading mdit_py_plugins-0.6.1-py3-none-any.whl.metadata (2.9 kB)
Collecting pyyaml (from myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5))
  Downloading pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (2.4 kB)
Requirement already satisfied: pygments in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx-tabs~=3.5->-r docs/canonicalk8s/requirements.txt (line 10)) (2.20.0)
Collecting sphinx<9,>=6 (from sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7))
  Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB)
Collecting GitPython (from sphinx-contributor-listing~=0.1->-r docs/canonicalk8s/requirements.txt (line 17))
  Downloading gitpython-3.1.58-py3-none-any.whl.metadata (13 kB)
Requirement already satisfied: requests in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19)) (2.34.2)
Collecting beautifulsoup4 (from sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19))
  Downloading beautifulsoup4-4.15.0-py3-none-any.whl.metadata (3.8 kB)
Collecting sphinx-copybutton>=0.5.2 (from sphinx-terminal~=1.0->-r docs/canonicalk8s/requirements.txt (line 21))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-markdown-builder>=0.6.8 (from sphinx-llm~=0.4->-r docs/canonicalk8s/requirements.txt (line 30))
  Downloading sphinx_markdown_builder-0.6.10-py3-none-any.whl.metadata (3.7 kB)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5))
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.0.0)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (1.0.1)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.1.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.0.0)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.0.0)
Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (3.1.1)
Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.18.0)
Collecting alabaster~=0.7.14 (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7))
  Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from sphinx<9,>=6->sphinx-design==0.6.1->-r docs/canonicalk8s/requirements.txt (line 7)) (2.0.0)
Collecting cairosvg>=1.0 (from sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cairosvg-2.9.0-py3-none-any.whl.metadata (2.7 kB)
Collecting colorama>=0.4.6 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB)
Collecting starlette>=0.35 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading starlette-1.4.1-py3-none-any.whl.metadata (6.4 kB)
Collecting uvicorn>=0.25 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading uvicorn-0.52.1-py3-none-any.whl.metadata (6.6 kB)
Collecting watchfiles>=0.20 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading watchfiles-1.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.9 kB)
Collecting websockets>=11 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading websockets-17.0.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.metadata (6.3 kB)
Collecting cairocffi (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cairocffi-1.7.1-py3-none-any.whl.metadata (3.3 kB)
Collecting cssselect2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cssselect2-0.9.0-py3-none-any.whl.metadata (2.9 kB)
Collecting defusedxml (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading defusedxml-0.7.1-py2.py3-none-any.whl.metadata (32 kB)
Collecting pillow (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading pillow-12.3.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.metadata (9.1 kB)
Collecting tinycss2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading tinycss2-1.5.1-py3-none-any.whl.metadata (3.0 kB)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from jinja2->myst-parser~=4.0->-r docs/canonicalk8s/requirements.txt (line 5)) (3.0.3)
Requirement already satisfied: charset_normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from requests->sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19)) (3.4.9)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from requests->sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19)) (3.18)
Requirement already satisfied: urllib3<3,>=1.26 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from requests->sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19)) (2.7.0)
Requirement already satisfied: certifi>=2023.5.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from requests->sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19)) (2026.7.22)
Collecting tabulate (from sphinx-markdown-builder>=0.6.8->sphinx-llm~=0.4->-r docs/canonicalk8s/requirements.txt (line 30))
  Downloading tabulate-0.10.0-py3-none-any.whl.metadata (40 kB)
Collecting anyio<5,>=3.6.2 (from starlette>=0.35->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading anyio-4.14.2-py3-none-any.whl.metadata (4.6 kB)
Collecting typing-extensions>=4.10.0 (from starlette>=0.35->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading typing_extensions-4.16.0-py3-none-any.whl.metadata (3.3 kB)
Collecting click>=7.0 (from uvicorn>=0.25->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading click-8.4.2-py3-none-any.whl.metadata (2.6 kB)
Collecting h11>=0.8 (from uvicorn>=0.25->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading h11-0.16.0-py3-none-any.whl.metadata (8.3 kB)
Collecting soupsieve>=1.6.1 (from beautifulsoup4->sphinx-related-links~=0.1->-r docs/canonicalk8s/requirements.txt (line 19))
  Downloading soupsieve-2.9.1-py3-none-any.whl.metadata (4.6 kB)
Collecting cffi>=1.1.0 (from cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cffi-2.1.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl.metadata (2.5 kB)
Collecting pycparser (from cffi>=1.1.0->cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading pycparser-3.0-py3-none-any.whl.metadata (8.2 kB)
Collecting webencodings (from cssselect2->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]~=2.1->-r docs/canonicalk8s/requirements.txt (line 27))
  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~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  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~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading accessible_pygments-0.0.5-py3-none-any.whl.metadata (10 kB)
Collecting gitdb<5,>=4.0.1 (from GitPython->sphinx-contributor-listing~=0.1->-r docs/canonicalk8s/requirements.txt (line 17))
  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->sphinx-contributor-listing~=0.1->-r docs/canonicalk8s/requirements.txt (line 17))
  Downloading smmap-5.0.3-py3-none-any.whl.metadata (4.6 kB)
Collecting uc-micro-py (from linkify-it-py->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading uc_micro_py-2.0.0-py3-none-any.whl.metadata (2.2 kB)
Downloading sphinx_design-0.6.1-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 96.9 MB/s  0:00:00
Downloading sphinx_reredirects-0.1.6-py3-none-any.whl (5.7 kB)
Downloading canonical_sphinx-0.6.0-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 769.2 MB/s  0:00:00
Downloading myst_parser-4.0.1-py3-none-any.whl (84 kB)
Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl (8.2 kB)
Downloading sphinx_tabs-3.5.0-py3-none-any.whl (9.9 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 803.5 MB/s  0:00:00
Downloading sphinx_rerediraffe-0.0.4-py3-none-any.whl (8.1 kB)
Downloading sphinx_config_options-0.1.1-py3-none-any.whl (23 kB)
Downloading sphinx_contributor_listing-0.1.0-py3-none-any.whl (19 kB)
Downloading sphinx_filtered_toctree-0.1.0-py3-none-any.whl (16 kB)
Downloading sphinx_related_links-0.1.2-py3-none-any.whl (19 kB)
Downloading sphinx_roles-0.1.0-py3-none-any.whl (17 kB)
Downloading sphinx_terminal-1.1.0-py3-none-any.whl (21 kB)
Downloading sphinx_ubuntu_images-0.2.0-py3-none-any.whl (29 kB)
Downloading sphinx_youtube_links-0.1.0-py3-none-any.whl (17 kB)
Downloading sphinxcontrib_svg2pdfconverter-2.1.0-py3-none-any.whl (9.3 kB)
Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl (8.6 kB)
Downloading sphinx_sitemap-2.9.0-py3-none-any.whl (6.2 kB)
Downloading sphinx_llm-0.4.1-py3-none-any.whl (28 kB)
Downloading vale-3.13.0.0-py3-none-any.whl (5.9 kB)
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 640.1 MB/s  0:00:00
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
Downloading mdit_py_plugins-0.6.1-py3-none-any.whl (66 kB)
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Downloading sphinx-7.4.7-py3-none-any.whl (3.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 263.8 MB/s  0:00:00
Downloading alabaster-0.7.16-py3-none-any.whl (13 kB)
Downloading sphinx_autobuild-2025.8.25-py3-none-any.whl (12 kB)
Downloading cairosvg-2.9.0-py3-none-any.whl (45 kB)
Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB)
Downloading sphinx_markdown_builder-0.6.10-py3-none-any.whl (16 kB)
Downloading starlette-1.4.1-py3-none-any.whl (74 kB)
Downloading anyio-4.14.2-py3-none-any.whl (125 kB)
Downloading typing_extensions-4.16.0-py3-none-any.whl (45 kB)
Downloading uvicorn-0.52.1-py3-none-any.whl (79 kB)
Downloading click-8.4.2-py3-none-any.whl (119 kB)
Downloading h11-0.16.0-py3-none-any.whl (37 kB)
Downloading watchfiles-1.2.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (456 kB)
Downloading websockets-17.0.1-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (220 kB)
Downloading beautifulsoup4-4.15.0-py3-none-any.whl (109 kB)
Downloading soupsieve-2.9.1-py3-none-any.whl (37 kB)
Downloading cairocffi-1.7.1-py3-none-any.whl (75 kB)
Downloading cffi-2.1.1-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (221 kB)
Downloading cssselect2-0.9.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 718.2 MB/s  0:00:00
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading gitpython-3.1.58-py3-none-any.whl (220 kB)
Downloading gitdb-4.0.12-py3-none-any.whl (62 kB)
Downloading smmap-5.0.3-py3-none-any.whl (24 kB)
Downloading linkify_it_py-2.1.0-py3-none-any.whl (19 kB)
Downloading pillow-12.3.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (6.9 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.9/6.9 MB 340.0 MB/s  0:00:00
Downloading pycparser-3.0-py3-none-any.whl (48 kB)
Downloading pyyaml-6.0.3-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (807 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 807.9/807.9 kB 688.1 MB/s  0:00:00
Downloading tabulate-0.10.0-py3-none-any.whl (39 kB)
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-2.0.0-py3-none-any.whl (6.4 kB)
Building wheels for collected packages: rst2html
  Building wheel for rst2html (pyproject.toml): started
  Building wheel for rst2html (pyproject.toml): finished with status 'done'
  Created wheel for rst2html: filename=rst2html-2020.7.4-py3-none-any.whl size=1471 sha256=19b9d13b1a949f2c2e0f6623a59896fc4d0ed3d6cc405ed80a81b23eaad40f3f
  Stored in directory: /tmp/pip-ephem-wheel-cache-rm0c17da/wheels/42/d2/79/966342e0075434bbb9c048f243a20a051299b9801097251222
Successfully built rst2html
Installing collected packages: webencodings, websockets, vale, uc-micro-py, typing-extensions, tinycss2, tabulate, soupsieve, smmap, pyyaml, pycparser, pillow, mdurl, h11, docutils, defusedxml, colorama, click, alabaster, accessible-pygments, uvicorn, sphinx, rst2html, markdown-it-py, linkify-it-py, gitdb, cssselect2, cffi, beautifulsoup4, anyio, watchfiles, starlette, sphinxext-opengraph, sphinxcontrib-svg2pdfconverter, sphinxcontrib-jquery, sphinx-youtube-links, sphinx-ubuntu-images, sphinx-tabs, sphinx-roles, sphinx-reredirects, sphinx-rerediraffe, sphinx-related-links, sphinx-notfound-page, sphinx-markdown-builder, sphinx-last-updated-by-git, sphinx-filtered-toctree, sphinx-design, sphinx-copybutton, sphinx-config-options, sphinx-basic-ng, mdit-py-plugins, GitPython, cairocffi, sphinx-terminal, sphinx-sitemap, sphinx-llm, sphinx-contributor-listing, sphinx-autobuild, myst-parser, furo, cairosvg, canonical-sphinx
  Attempting uninstall: docutils
    Found existing installation: docutils 0.22.4
    Uninstalling docutils-0.22.4:
      Successfully uninstalled docutils-0.22.4
  Attempting uninstall: alabaster
    Found existing installation: alabaster 1.0.0
    Uninstalling alabaster-1.0.0:
      Successfully uninstalled alabaster-1.0.0
  Attempting uninstall: sphinx
    Found existing installation: Sphinx 9.1.0
    Uninstalling Sphinx-9.1.0:
      Successfully uninstalled Sphinx-9.1.0

Successfully installed GitPython-3.1.58 accessible-pygments-0.0.5 alabaster-0.7.16 anyio-4.14.2 beautifulsoup4-4.15.0 cairocffi-1.7.1 cairosvg-2.9.0 canonical-sphinx-0.6.0 cffi-2.1.1 click-8.4.2 colorama-0.4.6 cssselect2-0.9.0 defusedxml-0.7.1 docutils-0.21.2 furo-2025.12.19 gitdb-4.0.12 h11-0.16.0 linkify-it-py-2.1.0 markdown-it-py-3.0.0 mdit-py-plugins-0.6.1 mdurl-0.1.2 myst-parser-4.0.1 pillow-12.3.0 pycparser-3.0 pyyaml-6.0.3 rst2html-2020.7.4 smmap-5.0.3 soupsieve-2.9.1 sphinx-7.4.7 sphinx-autobuild-2025.8.25 sphinx-basic-ng-1.0.0b2 sphinx-config-options-0.1.1 sphinx-contributor-listing-0.1.0 sphinx-copybutton-0.5.2 sphinx-design-0.6.1 sphinx-filtered-toctree-0.1.0 sphinx-last-updated-by-git-0.3.8 sphinx-llm-0.4.1 sphinx-markdown-builder-0.6.10 sphinx-notfound-page-1.1.0 sphinx-related-links-0.1.2 sphinx-rerediraffe-0.0.4 sphinx-reredirects-0.1.6 sphinx-roles-0.1.0 sphinx-sitemap-2.9.0 sphinx-tabs-3.5.0 sphinx-terminal-1.1.0 sphinx-ubuntu-images-0.2.0 sphinx-youtube-links-0.1.0 sphinxcontrib-jquery-4.1 sphinxcontrib-svg2pdfconverter-2.1.0 sphinxext-opengraph-0.13.0 starlette-1.4.1 tabulate-0.10.0 tinycss2-1.5.1 typing-extensions-4.16.0 uc-micro-py-2.0.0 uvicorn-0.52.1 vale-3.13.0.0 watchfiles-1.2.0 webencodings-0.5.1 websockets-17.0.1

[rtd-command-info] start-time: 2026-08-06T09:55:02.430202Z, end-time: 2026-08-06T09:55:02.473452Z, duration: 0, exit-code: 0
cat docs/canonicalk8s/conf.py
import datetime
import os
import textwrap
import yaml

# 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
#
# The Sphinx Stack uses the Canonical Sphinx theme to keep all documentation 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 (e.g., "Ubuntu Server")
project = "Canonical Kubernetes"

# Author name; used in the default copyright statement in the page footer
author = "Canonical Ltd."

# The year in the copyright statement
copyright = f"{datetime.date.today().year}"

# Sidebar documentation title
# To disable the title, set it to an empty string.
html_title = project + " documentation"

# Documentation website URL
ogp_site_url = "https://documentation.ubuntu.com/canonical-kubernetes/latest/"

# Preview name of the documentation website
# TODO: To use a different name for the project in previews, update the next line.
ogp_site_name = project

# Preview image URL
# TODO: To customise the preview image, update the next line.
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 the next line.
# 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'). If there's no such website, remove the {{ product_page }}
    #       link from the _templates/header.html file.
    "product_page": "ubuntu.com/kubernetes",
    # 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.
    "discourse": "https://discourse.ubuntu.com/c/kubernetes/180",
    # Your Mattermost channel URL
    # TODO: Change to your Mattermost channel URL or leave empty.
    # "mattermost": "https://chat.canonical.com/canonical/channels/documentation",
    # Your Matrix channel URL
    # TODO: Change to your Matrix channel URL or leave empty.
    # "matrix": "https://matrix.to/#/#documentation:ubuntu.com",
    # Your documentation GitHub repository URL If set, links for viewing the
    # documentation source files and creating GitHub issues are added at the bottom of
    # each page.

    # Adding slack channel
    'slack': 'https://kubernetes.slack.com/archives/CG1V2CAMB',
    #
    # TODO: Change to your documentation GitHub repository URL or leave empty.
    "github_url": "https://github.com/canonical/k8s-snap",
    # Docs branch in the repo; used in links for viewing the source files
    "repo_default_branch": "main",
    # Docs location in the repo; used in links for viewing the source files
    "repo_folder": "/docs/canonicalk8s/",
    # TODO: To enable or disable the Previous / Next buttons at the bottom of pages
    # Valid options: none, prev, next, both
    # "sequential_nav": "",
    # TODO: To enable listing contributors on individual pages, set to True
    "display_contributors": False,
    # Required for feedback button
    "github_issues": "enabled",
    # Passes the top-level 'author' value to the theme
    "author": author,
    # Documentation license information
    "license": {
        # TODO: Specify your project's license.
        # For the name, we recommend using the standard shorthand identifier from
        # https://spdx.org/licenses
        "name": "GPL-3.0-only",
        # TODO: Link directly to your project's license statement.
        "url": "https://github.com/canonical/k8s-snap/blob/main/LICENSE",
    },
}

# TODO: To enable the edit button on pages, uncomment and change the link to a
# public repository on GitHub or Launchpad. Any of the following link domains
# are accepted:
# - https://github.com/example-org/example"
# - https://launchpad.net/example
# - https://git.launchpad.net/example
#
html_theme_options = {
 'source_edit_link': 'https://github.com/canonical/k8s-snap',
}

# Project slug
# TODO: If your documentation is hosted on https://documentation.ubuntu.com/,
#       uncomment and set to the RTD slug.
slug = 'canonical-kubernetes'

#######################
# Sitemap configuration: https://sphinx-sitemap.readthedocs.io/
#######################

# Use RTD canonical URL to ensure duplicate pages have a specific canonical URL
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")

# sphinx-sitemap uses html_baseurl to generate the full URL for each page:
html_extra_path = ["sitemapindex.xml", "robots.txt"]
sitemap_url_scheme = "{link}"

# Include `lastmod` dates in the sitemap:
sitemap_show_lastmod = True

# TODO: Exclude pages that aren't user-facing from the sitemap (e.g., module pages
# generated by autodoc).
# Pages excluded from the sitemap:
sitemap_excludes = [
    "404/",
    "genindex/",
    "search/",
]

################################
# Template and asset locations #
################################

# html_static_path = ["_static"]
templates_path = ["_templates"]

#############
# Redirects #
#############

# Add redirects to the 'redirects.txt' file
# https://sphinxext-rediraffe.readthedocs.io/en/latest/

# To set up redirects in the Read the Docs project dashboard:
# https://docs.readthedocs.io/en/stable/guides/redirects.html

rediraffe_redirects = "redirects.txt"

# Strips '/index.html' from destination URLs when building with 'dirhtml'
rediraffe_dir_only = True


############################
# sphinx-llm configuration #
############################

# This description is included in llms.txt to provide some initial context for your
# product docs.
# TODO: Add a description in the form "This is the documentation for <product name>,
# <first sentence of home page>".
llms_txt_description = textwrap.dedent(
    """\
    This is the documentation for the Canonical Kubernetes, a performant, lightweight, secure and opinionated distribution of Kubernetes which includes everything needed to create and manage a scalable cluster suitable for all use cases.
    """
)

# The base URL for references built by sphinx-markdown-builder.
if os.environ.get("READTHEDOCS"):
    markdown_http_base = html_baseurl

###########################
# Link checker exceptions #
###########################

# A regex list of URLs that are ignored by 'make linkcheck'
linkcheck_ignore = [
    'http://127.0.0.1:8000',
    'http://rocks.canonical.com',
    'about',
    'https://ceph.io/',
    'https://charmhub.io/k8s/',
    'https://charmhub.io/k8s-worker/',
    'http://slack.kubernetes.io/',
    r'https://www\.stigviewer\.com/.*',
    'https://www.squid-cache.org/',
    'https://www.esd.whs.mil/portals/54/documents/dd/issuances/dodi/855101p.pdf',
    r'https://stigviewer.com/stigs/kubernetes/2024-06-10/finding/V-24',
    'https://kubernetes.io/docs/concepts/configuration/pod-priority-preemption/',
    'https://kubernetes.io/docs/concepts/extend-kubernetes/compute-storage-net/',
    'https://developer.hashicorp.com/vault/docs',
    'https://assets.ubuntu.com/v1/843c77b6-juju-at-a-glace.svg',
]

# A regex list of URLs where anchors are ignored by 'make linkcheck'
linkcheck_anchors_ignore_for_url = [
    r'https://github\.com/.*',
    'https://github.com/kubernetes/kubernetes/issues',
    'https://github.com/kubernetes/kubernetes/blob/master/CHANGELOG',
    'https://github.com/canonical/k8s-operator',
    'https://github.com/vmware-tanzu/velero-plugin-for-aws?tab=readme-ov-file',
    'https://juju.is/docs/juju/relation',
    'https://github.com/kubernetes/kubernetes/blob/master/cmd/kube-apiserver/app/options/validation_test.go',
    'https://matrix.to',
    'https://ubuntu.com/about/release-cycle',
    'https://canonical.com/multipass/docs/tutorial',
    'https://microk8s.io/docs/how-to-cis-harden',
    'https://registry.terraform.io/providers/juju/juju/latest/docs',
    'https://snapcraft.io/docs/managing-updates',
    'https://documentation.ubuntu.com/juju/latest/reference/constraint/',]

# How long the link checker will wait for a response for each request
# TODO: Decrease to improve run time or increase if links frequently time out.
# linkcheck_timeout = 30

# Give linkcheck multiple tries on failure
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
extensions = [
    "canonical_sphinx",
    "notfound.extension",
    "sphinx_design",
    "sphinx_rerediraffe",
    "sphinx_reredirects",
    "sphinx_tabs.tabs",
    "sphinxcontrib.jquery",
    "sphinxext.opengraph",
    "sphinx_config_options",
    "sphinx_contributor_listing",
    "sphinx_filtered_toctree",
    "sphinx_llm.txt",
    "sphinx_related_links",
    "sphinx_roles",
    "sphinx_terminal",
    "sphinx_ubuntu_images",
    "sphinx_youtube_links",
    "sphinxcontrib.cairosvgconverter",
    "sphinx_last_updated_by_git",
    "sphinx.ext.intersphinx",
    "sphinx_sitemap",
]

# Excludes files or directories from processing
exclude_patterns = [
    "doc-cheat-sheet*",
    ".venv*",
    '_parts/*',
    '/_parts'
]

# Adds custom CSS files, located remotely or in 'html_static_path'.
html_css_files = [
    "https://assets.ubuntu.com/v1/d86746ef-cookie_banner.css",
]

# Adds custom JavaScript files, located remotely or in 'html_static_path'.
html_js_files = [
    "https://assets.ubuntu.com/v1/287a5e8f-bundle.js",
]

myst_heading_anchors = 3

# Appends extra markup to the end of every document written in reST
rst_epilog = """
"""

# Feedback button at the top; enabled by default
# TODO: Disable the button if your project is unsuitable for public feedback.
# disable_feedback_button = True

# Your manpage URL
# TODO: To enable manpage links, uncomment and replace {codename} with required
#       release, preferably an LTS release (e.g. noble). Do *not* substitute
#       {section} or {page}; these will be replaced by sphinx at build time
#
# 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/{codename}/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
"""

# Configuration for Intersphinx projects
#
intersphinx_mapping = {
    "snap": ("https://snapcraft.io/docs/", None),
}

if os.path.exists('./reuse/substitutions.yaml'):
    with open('./reuse/substitutions.yaml', 'r') as fd:
        myst_substitutions = yaml.safe_load(fd.read())
else:
    myst_substitutions = {
    }

[rtd-command-info] start-time: None, end-time: None, duration: None, exit-code: None
python -m sphinx -T -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html