Read the Docs build information
Build id: 4026932
Project: canonical-k8s-snap
Version: latest
Commit: 3b47e5499b30d49bc10883272942a04be1163e96
Date: 2026-05-19T20:08:57.594905Z
State: finished
Success: True


[rtd-command-info] start-time: 2026-05-19T20:08:58.380223Z, end-time: 2026-05-19T20:08:59.316850Z, duration: 0, exit-code: 0
git clone --depth 1 https://github.com/canonical/k8s-snap.git .
Cloning into '.'...

[rtd-command-info] start-time: 2026-05-19T20:08:59.392967Z, end-time: 2026-05-19T20:08:59.925150Z, 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-05-19T20:09:00.654653Z, end-time: 2026-05-19T20:09:00.726406Z, 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 3b47e54 docs: fix occured typo in k8s-status proposal (#2558)

[rtd-command-info] start-time: 2026-05-19T20:09:00.810094Z, end-time: 2026-05-19T20:09:00.851510Z, 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-05-19T20:09:00.936271Z, end-time: 2026-05-19T20:09:02.634691Z, duration: 1, 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-05-19T20:09:07.351401Z, end-time: 2026-05-19T20:09:07.412406Z, duration: 0, exit-code: 0
asdf global python 3.12.12


[rtd-command-info] start-time: 2026-05-19T20:09:07.770699Z, end-time: 2026-05-19T20:09:08.437380Z, duration: 0, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.12.12.final.0-64 in 405ms
  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-05-19T20:09:08.523922Z, end-time: 2026-05-19T20:09:14.586031Z, duration: 6, 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.1.1-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 16.1 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-82.0.1-py3-none-any.whl (1.0 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 32.2 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.1.1 setuptools-82.0.1

[rtd-command-info] start-time: 2026-05-19T20:09:14.670717Z, end-time: 2026-05-19T20:09:19.754490Z, 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.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-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.2-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.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl.metadata (40 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.15-py3-none-any.whl.metadata (7.7 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.4.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 193.7 MB/s  0:00:00
Downloading docutils-0.22.4-py3-none-any.whl (633 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 633.2/633.2 kB 739.4 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 454.9 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.2-py3-none-any.whl (100 kB)
Downloading pygments-2.20.0-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 869.3 MB/s  0:00:00
Downloading requests-2.34.2-py3-none-any.whl (73 kB)
Downloading charset_normalizer-3.4.7-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl (216 kB)
Downloading idna-3.15-py3-none-any.whl (72 kB)
Downloading urllib3-2.7.0-py3-none-any.whl (131 kB)
Downloading certifi-2026.4.22-py3-none-any.whl (135 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.20.0 alabaster-1.0.0 babel-2.18.0 certifi-2026.4.22 charset_normalizer-3.4.7 docutils-0.22.4 idna-3.15 imagesize-2.0.0 packaging-26.2 requests-2.34.2 roman-numerals-4.1.0 snowballstemmer-3.0.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-05-19T20:09:19.835876Z, end-time: 2026-05-19T20:09:28.735775Z, duration: 8, 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 (from -r docs/canonicalk8s/requirements.txt (line 7))
  Downloading sphinx_design-0.7.0-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx-notfound-page (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 (from -r docs/canonicalk8s/requirements.txt (line 9))
  Downloading sphinx_reredirects-1.1.0-py3-none-any.whl.metadata (4.7 kB)
Collecting sphinx-tabs (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 (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 (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 (from -r docs/canonicalk8s/requirements.txt (line 13))
  Downloading sphinx_rerediraffe-0.0.3-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-config-options>=0.1.0 (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.0 (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.0 (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.2 (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.0 (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.2 (from -r docs/canonicalk8s/requirements.txt (line 21))
  Downloading sphinx_terminal-1.0.3-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-ubuntu-images>=0.1.0 (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.0 (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 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.2)
Collecting sphinx-last-updated-by-git (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 (from -r docs/canonicalk8s/requirements.txt (line 29))
  Downloading sphinx_sitemap-2.9.0-py3-none-any.whl.metadata (3.4 kB)
Collecting sphinxext-rediraffe (from -r docs/canonicalk8s/requirements.txt (line 30))
  Downloading sphinxext_rediraffe-0.3.0-py3-none-any.whl.metadata (2.9 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 (from -r docs/canonicalk8s/requirements.txt (line 34))
  Downloading vale-3.13.0.0-py3-none-any.whl.metadata (3.0 kB)
Collecting sphinxcontrib-svg2pdfconverter[CairoSVG] (from -r docs/canonicalk8s/requirements.txt (line 27))
  Downloading sphinxcontrib_svg2pdfconverter-2.1.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-k8s-snap/envs/latest/lib/python3.12/site-packages (from canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (9.1.0)
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)
Collecting Sphinx>=7.1.2 (from canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 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>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.0.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>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.20.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>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (3.0.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>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.18.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (1.0.0)
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>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.0.0)
Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2.34.2)
Collecting roman-numerals-py>=1.0.0 (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading roman_numerals_py-4.1.0-py3-none-any.whl.metadata (561 bytes)
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.0.0-py3-none-any.whl.metadata (6.3 kB)
Collecting uvicorn>=0.25 (from sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading uvicorn-0.47.0-py3-none-any.whl.metadata (6.7 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-16.0-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl.metadata (6.8 kB)
Collecting Sphinx>=7.1.2 (from canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading sphinx-7.4.7-py3-none-any.whl.metadata (6.1 kB)
Collecting alabaster~=0.7.14 (from Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2))
  Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB)
Collecting GitPython (from sphinx-contributor-listing>=0.1.0->-r docs/canonicalk8s/requirements.txt (line 17))
  Downloading gitpython-3.1.50-py3-none-any.whl.metadata (14 kB)
Collecting beautifulsoup4 (from sphinx-related-links>=0.1.2->-r docs/canonicalk8s/requirements.txt (line 19))
  Downloading beautifulsoup4-4.14.3-py3-none-any.whl.metadata (3.8 kB)
Collecting sphinx-copybutton>=0.5.2 (from sphinx-terminal>=1.0.2->-r docs/canonicalk8s/requirements.txt (line 21))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting cairosvg>=1.0 (from sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cairosvg-2.9.0-py3-none-any.whl.metadata (2.7 kB)
Collecting cairocffi (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-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]->-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]->-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]->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading pillow-12.2.0-cp312-cp312-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/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>=2.30.0->Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (3.4.7)
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>=2.30.0->Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (3.15)
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>=2.30.0->Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (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>=2.30.0->Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (2026.4.22)
Collecting anyio<5,>=3.6.2 (from starlette>=0.35->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  Downloading anyio-4.13.0-py3-none-any.whl.metadata (4.5 kB)
Collecting typing-extensions>=4.10.0 (from starlette>=0.35->sphinx-autobuild->-r docs/canonicalk8s/requirements.txt (line 6))
  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/canonicalk8s/requirements.txt (line 6))
  Downloading click-8.4.0-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.2->-r docs/canonicalk8s/requirements.txt (line 19))
  Downloading soupsieve-2.8.3-py3-none-any.whl.metadata (4.6 kB)
Collecting cffi>=1.1.0 (from cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/canonicalk8s/requirements.txt (line 27))
  Downloading cffi-2.0.0-cp312-cp312-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/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]->-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.0->-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.0->-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)
Requirement already satisfied: roman-numerals==4.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.12/site-packages (from roman-numerals-py>=1.0.0->Sphinx>=7.1.2->canonical-sphinx~=0.6->-r docs/canonicalk8s/requirements.txt (line 2)) (4.1.0)
Downloading canonical_sphinx-0.6.0-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 70.6 MB/s  0:00:00
Downloading myst_parser-4.0.1-py3-none-any.whl (84 kB)
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 308.9 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_autobuild-2025.8.25-py3-none-any.whl (12 kB)
Downloading sphinx_design-0.7.0-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 220.3 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.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 813.6 MB/s  0:00:00
Downloading sphinx_rerediraffe-0.0.3-py3-none-any.whl (8.1 kB)
Downloading sphinx_config_options-0.1.1-py3-none-any.whl (23 kB)
Downloading sphinx-7.4.7-py3-none-any.whl (3.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.4/3.4 MB 282.1 MB/s  0:00:00
Downloading alabaster-0.7.16-py3-none-any.whl (13 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.0.3-py3-none-any.whl (20 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 sphinxext_rediraffe-0.3.0-py3-none-any.whl (7.2 kB)
Downloading vale-3.13.0.0-py3-none-any.whl (5.9 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 starlette-1.0.0-py3-none-any.whl (72 kB)
Downloading anyio-4.13.0-py3-none-any.whl (114 kB)
Downloading typing_extensions-4.15.0-py3-none-any.whl (44 kB)
Downloading uvicorn-0.47.0-py3-none-any.whl (71 kB)
Downloading click-8.4.0-py3-none-any.whl (116 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-16.0-cp312-cp312-manylinux1_x86_64.manylinux_2_28_x86_64.manylinux_2_5_x86_64.whl (184 kB)
Downloading beautifulsoup4-4.14.3-py3-none-any.whl (107 kB)
Downloading soupsieve-2.8.3-py3-none-any.whl (37 kB)
Downloading cairocffi-1.7.1-py3-none-any.whl (75 kB)
Downloading cffi-2.0.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl (219 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 690.8 MB/s  0:00:00
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading gitpython-3.1.50-py3-none-any.whl (212 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.2.0-cp312-cp312-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (7.1 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 7.1/7.1 MB 508.7 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 798.9 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-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=1472 sha256=b3db3c091e5c4f1f673aa75cc374038a0ac1479a5d9ac5a4dc257b84ad63d145
  Stored in directory: /tmp/pip-ephem-wheel-cache-519_e9fd/wheels/42/d2/79/966342e0075434bbb9c048f243a20a051299b9801097251222
Successfully built rst2html
Installing collected packages: webencodings, websockets, vale, uc-micro-py, typing-extensions, tinycss2, 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-rediraffe, 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-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-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.50 Sphinx-7.4.7 accessible-pygments-0.0.5 alabaster-0.7.16 anyio-4.13.0 beautifulsoup4-4.14.3 cairocffi-1.7.1 cairosvg-2.9.0 canonical-sphinx-0.6.0 cffi-2.0.0 click-8.4.0 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.2.0 pycparser-3.0 pyyaml-6.0.3 rst2html-2020.7.4 smmap-5.0.3 soupsieve-2.8.3 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.7.0 sphinx-filtered-toctree-0.1.0 sphinx-last-updated-by-git-0.3.8 sphinx-notfound-page-1.1.0 sphinx-related-links-0.1.2 sphinx-rerediraffe-0.0.3 sphinx-reredirects-1.1.0 sphinx-roles-0.1.0 sphinx-sitemap-2.9.0 sphinx-tabs-3.5.0 sphinx-terminal-1.0.3 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 sphinxext-rediraffe-0.3.0 starlette-1.0.0 tinycss2-1.5.1 typing-extensions-4.15.0 uc-micro-py-2.0.0 uvicorn-0.47.0 vale-3.13.0.0 watchfiles-1.2.0 webencodings-0.5.1 websockets-16.0

[rtd-command-info] start-time: 2026-05-19T20:09:28.891401Z, end-time: 2026-05-19T20:09:28.935244Z, duration: 0, exit-code: 0
cat docs/canonicalk8s/conf.py
import datetime
import os
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
#
# 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 = "Canonical Kubernetes"
author = "Canonical Ltd."

# The year in the copyright statement defaults to the current year, so
# individual document versions show when they were built.
# TODO: If the date must be a range, like in a software license, replace 
# 2026 with the starting year of development and use:
#
# copyright = f"2026-{datetime.date.today().year}"

copyright = f"{datetime.date.today().year}"

# 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"


# 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://documentation.ubuntu.com/canonical-kubernetes/latest/"


# 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": "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.
    #
    # 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/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
    #
    # Adding slack channel
    'slack': 'https://kubernetes.slack.com/archives/CG1V2CAMB',
    #
    # 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/k8s-snap",
    # 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/canonicalk8s/",
    # 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',

    # Inherit the author value
    "author": author,

    # The starter pack uses CC-BY-SA as the license
    #
    # TODO: If your docs need another license, specify it instead of 'CC-BY-SA'.
    # For the name, we recommend using the standard shorthand identifier from
    # https://spdx.org/licenses
    #
    # For the URL, link directly to the license statement, typically found on
    # the product's home page or in its GitHub project.
    #
    # 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'.

    "license": {
        "name": "GPL-3.0-only",
        "url": "https://github.com/canonical/k8s-snap/blob/main/LICENSE",
    },
}

# html_extra_path = []

# Allow opt-in build of the OpenAPI "Hello" example so docs stay clean by default.
# if os.getenv("OPENAPI", ""):
#     tags.add("openapi")
#     html_extra_path.append("how-to/assets/openapi.yaml")

# 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; 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 = 'canonical-kubernetes'

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

# Base URL of RTD hosted project

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"]

# When configured with RTD variables, check for RTD environment so manual runs succeed:

sitemap_url_scheme = '{link}'

# Include `lastmod` dates in the sitemap:

sitemap_show_lastmod = True

# Exclude generated pages from the sitemap:

sitemap_excludes = [
    '404/',
    'genindex/',
    'search/',
]

# TODO: Add more pages to sitemap_excludes if needed. Wildcards are supported.
#       For example, to exclude module pages generated by autodoc, add '_modules/*'.

################################
# 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

# Internal redirects
# Handled by rediraffe 

rediraffe_redirects = "redirects.txt"

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

# External redirects 
# Docs for sphinx_reredirect: https://documatt.gitlab.io/sphinx-reredirects/usage.html
# For example: 'explanation/old-name.html': '../how-to/prettify.html',

# NOTE: If undefined, set to None, or empty,
#       the sphinx_reredirects extension will be disabled.
redirects = {
}

###########################
# 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',
    '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/',
    ]

# 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.

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_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 under 'html_static_path'

html_css_files = [
        "github_issue_links.css",
        "cookie-banner.css"
        ]


# Adds custom JavaScript files, located under 'html_static_path'

html_js_files = [
        "bundle.js"
        ]


# Specifies a reST snippet to be appended to each .rst file
# If you have many entries, consider creating a reuse/substitutions.txt file
# and loading it here instead.
# rst_epilog = """
#     .. include:: reuse/substitutions.txt
#     """
rst_epilog = """
.. include:: /reuse/substitutions.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 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
"""

# 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"] = f"{html_context['discourse']}/t/"

# Workaround for substitutions.yaml
# If the user has a reuse/substitutions.yaml file, load from there.
# Otherwise, use the manual definitions below.

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 = {
    }

# Add configuration for intersphinx mapping
# Map only the Sphinx documentation sets that you need to link to from your docs set.
intersphinx_mapping = {
    'starter-pack': ('https://canonical-example-product-documentation.readthedocs-hosted.com/en/latest', None)
}

# html_copy_source = False
# html_show_sourcelink = False
suppress_warnings = ["myst.xref_missing", "myst.iref_ambiguous"]
# custom_required_modules = [
#     'sphinxcontrib-svg2pdfconverter[CairoSVG]',
# ]

[rtd-command-info] start-time: 2026-05-19T20:09:29.019606Z, end-time: 2026-05-19T20:09:59.435777Z, duration: 30, exit-code: 0
python -m sphinx -T -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v7.4.7
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 not found.
canonical.youtube-links will not be configured.
canonical.related-links not found.
canonical.related-links will not be configured.
canonical.custom-rst-roles not found.
canonical.custom-rst-roles will not be configured.
canonical.terminal-output not found.
canonical.terminal-output will not be configured.
canonical.contributor-listing not found.
canonical.contributor-listing will not be 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 v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'deflist', 'linkify', 'substitution'}, 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={product: ..., version: ..., channel: ..., multi_line_example: ...}, 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)
loading intersphinx inventory 'starter-pack' from https://canonical-example-product-documentation.readthedocs-hosted.com/en/latest/objects.inv...
building [mo]: targets for 0 po files that are out of date
writing output... 
building [dirhtml]: targets for 158 source files that are out of date
updating environment: [new config] 158 added, 0 changed, 0 removed
reading sources... [  1%] about
reading sources... [  1%] capi/explanation/capi-ck8s
reading sources... [  2%] capi/explanation/in-place-upgrades
reading sources... [  3%] capi/explanation/index
reading sources... [  3%] capi/explanation/installation-methods
reading sources... [  4%] capi/explanation/networking
reading sources... [  4%] capi/explanation/security
reading sources... [  5%] capi/howto/custom-bootstrap-config
reading sources... [  6%] capi/howto/custom-ck8s
reading sources... [  6%] capi/howto/external-etcd
reading sources... [  7%] capi/howto/in-place-upgrades
reading sources... [  8%] capi/howto/index
reading sources... [  8%] capi/howto/intermediate-ca
reading sources... [  9%] capi/howto/migrate-management
reading sources... [  9%] capi/howto/provision
reading sources... [ 10%] capi/howto/refresh-certs
reading sources... [ 11%] capi/howto/rollout-upgrades
reading sources... [ 11%] capi/howto/troubleshooting
reading sources... [ 12%] capi/howto/upgrade-providers
reading sources... [ 13%] capi/index
reading sources... [ 13%] capi/reference/annotations
reading sources... [ 14%] capi/reference/configs
reading sources... [ 15%] capi/reference/index
reading sources... [ 15%] capi/reference/ports-and-services
reading sources... [ 16%] capi/tutorial/getting-started
reading sources... [ 16%] capi/tutorial/index
reading sources... [ 17%] charm/explanation/architecture
reading sources... [ 18%] charm/explanation/channels
reading sources... [ 18%] charm/explanation/index
reading sources... [ 19%] charm/explanation/installation-methods
reading sources... [ 20%] charm/explanation/networking
reading sources... [ 20%] charm/explanation/security
reading sources... [ 21%] charm/explanation/upgrade
reading sources... [ 22%] charm/howto/ceph-csi
reading sources... [ 22%] charm/howto/configure-cluster
reading sources... [ 23%] charm/howto/contribute
reading sources... [ 23%] charm/howto/cos-lite
reading sources... [ 24%] charm/howto/custom-registry
reading sources... [ 25%] charm/howto/etcd
reading sources... [ 25%] charm/howto/hardening
reading sources... [ 26%] charm/howto/index
reading sources... [ 27%] charm/howto/install/charm
reading sources... [ 27%] charm/howto/install/custom-workers
reading sources... [ 28%] charm/howto/install/index
reading sources... [ 28%] charm/howto/install/install-custom
reading sources... [ 29%] charm/howto/install/install-lxd
reading sources... [ 30%] charm/howto/install/install-terraform
reading sources... [ 30%] charm/howto/openstack
reading sources... [ 31%] charm/howto/proxy
reading sources... [ 32%] charm/howto/report-security-issue
reading sources... [ 32%] charm/howto/troubleshooting
reading sources... [ 33%] charm/howto/upgrade
reading sources... [ 34%] charm/howto/validate
reading sources... [ 34%] charm/index
reading sources... [ 35%] charm/reference/actions
reading sources... [ 35%] charm/reference/az
reading sources... [ 36%] charm/reference/charm-configurations
reading sources... [ 37%] charm/reference/charms
reading sources... [ 37%] charm/reference/index
reading sources... [ 38%] charm/reference/ports-and-services
reading sources... [ 39%] charm/reference/proxy
reading sources... [ 39%] charm/reference/security
reading sources... [ 40%] charm/tutorial/basic-operations
reading sources... [ 41%] charm/tutorial/getting-started
reading sources... [ 41%] charm/tutorial/index
reading sources... [ 42%] community
reading sources... [ 42%] index
reading sources... [ 43%] releases/charm/1.32
reading sources... [ 44%] releases/charm/1.33
reading sources... [ 44%] releases/charm/1.34
reading sources... [ 45%] releases/charm/1.35
reading sources... [ 46%] releases/charm/index
reading sources... [ 46%] releases/index
reading sources... [ 47%] releases/snap/1.32
reading sources... [ 47%] releases/snap/1.33
reading sources... [ 48%] releases/snap/1.34
reading sources... [ 49%] releases/snap/1.35
reading sources... [ 49%] releases/snap/index
reading sources... [ 50%] releases/snap/upgrading
reading sources... [ 51%] snap/explanation/architecture
reading sources... [ 51%] snap/explanation/channels
reading sources... [ 52%] snap/explanation/clustering
reading sources... [ 53%] snap/explanation/documentation
reading sources... [ 53%] snap/explanation/epa
reading sources... [ 54%] snap/explanation/high-availability
reading sources... [ 54%] snap/explanation/index
reading sources... [ 55%] snap/explanation/installation-methods
reading sources... [ 56%] snap/explanation/networking
reading sources... [ 56%] snap/explanation/package-management
reading sources... [ 57%] snap/explanation/roles
reading sources... [ 58%] snap/explanation/security
reading sources... [ 58%] snap/explanation/upgrade
reading sources... [ 59%] snap/howto/backup-restore
reading sources... [ 59%] snap/howto/contribute
reading sources... [ 60%] snap/howto/epa
reading sources... [ 61%] snap/howto/external-datastore
reading sources... [ 61%] snap/howto/image-management
reading sources... [ 62%] snap/howto/index
reading sources... [ 63%] snap/howto/install/custom-bootstrap-config
reading sources... [ 63%] snap/howto/install/custom-worker
reading sources... [ 64%] snap/howto/install/dev-env
reading sources... [ 65%] snap/howto/install/disa-stig
reading sources... [ 65%] snap/howto/install/fips
reading sources... [ 66%] snap/howto/install/index
reading sources... [ 66%] snap/howto/install/lxd
reading sources... [ 67%] snap/howto/install/multipass
reading sources... [ 68%] snap/howto/install/offline
reading sources... [ 68%] snap/howto/install/snap
reading sources... [ 69%] snap/howto/install/uninstall
reading sources... [ 70%] snap/howto/networking/alternative-cni
reading sources... [ 70%] snap/howto/networking/default-dns
reading sources... [ 71%] snap/howto/networking/default-gateway
reading sources... [ 72%] snap/howto/networking/default-ingress
reading sources... [ 72%] snap/howto/networking/default-loadbalancer
reading sources... [ 73%] snap/howto/networking/default-network
reading sources... [ 73%] snap/howto/networking/dualstack
reading sources... [ 74%] snap/howto/networking/index
reading sources... [ 75%] snap/howto/networking/ipv6
reading sources... [ 75%] snap/howto/networking/proxy
reading sources... [ 76%] snap/howto/networking/ufw
reading sources... [ 77%] snap/howto/observability
reading sources... [ 77%] snap/howto/restore-quorum
reading sources... [ 78%] snap/howto/security/cis-assessment
reading sources... [ 78%] snap/howto/security/hardening
reading sources... [ 79%] snap/howto/security/index
reading sources... [ 80%] snap/howto/security/intermediate-ca
reading sources... [ 80%] snap/howto/security/refresh-certs
reading sources... [ 81%] snap/howto/security/refresh-external-certs
reading sources... [ 82%] snap/howto/security/report-security-issue
reading sources... [ 82%] snap/howto/storage/ceph
reading sources... [ 83%] snap/howto/storage/cloud
reading sources... [ 84%] snap/howto/storage/index
reading sources... [ 84%] snap/howto/storage/storage
reading sources... [ 85%] snap/howto/support
reading sources... [ 85%] snap/howto/troubleshooting
reading sources... [ 86%] snap/howto/upgrades
reading sources... [ 87%] snap/index
reading sources... [ 87%] snap/reference/annotations
reading sources... [ 88%] snap/reference/certificates
reading sources... [ 89%] snap/reference/cis-audit
reading sources... [ 89%] snap/reference/commands
reading sources... [ 90%] snap/reference/config-files/bootstrap-config
reading sources... [ 91%] snap/reference/config-files/disa-stig-config
reading sources... [ 91%] snap/reference/config-files/index
reading sources... [ 92%] snap/reference/config-files/node-join-config
reading sources... [ 92%] snap/reference/config-files/refresh-external-certs-config
reading sources... [ 93%] snap/reference/disa-stig-audit
reading sources... [ 94%] snap/reference/dqlite
reading sources... [ 94%] snap/reference/etcd
reading sources... [ 95%] snap/reference/index
reading sources... [ 96%] snap/reference/inspection-reports
reading sources... [ 96%] snap/reference/ports-and-services
reading sources... [ 97%] snap/reference/proxy
reading sources... [ 97%] snap/reference/security
reading sources... [ 98%] snap/tutorial/add-remove-nodes
reading sources... [ 99%] snap/tutorial/getting-started
reading sources... [ 99%] snap/tutorial/index
reading sources... [100%] snap/tutorial/kubectl

getting Git timestamps for source files... [  4%] .
getting Git timestamps for source files... [  8%] capi/explanation
getting Git timestamps for source files... [ 12%] capi/howto
getting Git timestamps for source files... [ 16%] capi
getting Git timestamps for source files... [ 20%] capi/reference
getting Git timestamps for source files... [ 24%] capi/tutorial
getting Git timestamps for source files... [ 28%] charm/explanation
getting Git timestamps for source files... [ 32%] charm/howto
getting Git timestamps for source files... [ 36%] charm/howto/install
getting Git timestamps for source files... [ 40%] charm
getting Git timestamps for source files... [ 44%] charm/reference
getting Git timestamps for source files... [ 48%] charm/tutorial
getting Git timestamps for source files... [ 52%] releases/charm
getting Git timestamps for source files... [ 56%] releases
getting Git timestamps for source files... [ 60%] releases/snap
getting Git timestamps for source files... [ 64%] snap/explanation
getting Git timestamps for source files... [ 68%] snap/howto
getting Git timestamps for source files... [ 72%] snap/howto/install
getting Git timestamps for source files... [ 76%] snap/howto/networking
getting Git timestamps for source files... [ 80%] snap/howto/security
getting Git timestamps for source files... [ 84%] snap/howto/storage
getting Git timestamps for source files... [ 88%] snap
getting Git timestamps for source files... [ 92%] snap/reference
getting Git timestamps for source files... [ 96%] snap/reference/config-files
getting Git timestamps for source files... [100%] snap/tutorial

getting Git timestamps for dependencies... [ 14%] assets
getting Git timestamps for dependencies... [ 29%] snap/explanation
getting Git timestamps for dependencies... [ 43%] _parts
getting Git timestamps for dependencies... [ 57%] snap/reference
getting Git timestamps for dependencies... [ 71%] snap/howto
getting Git timestamps for dependencies... [ 86%] snap/howto/security
getting Git timestamps for dependencies... [100%] _parts/commands

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying downloadable files... [ 33%] assets/how-to-epa-maas-cloud-init
copying downloadable files... [ 67%] assets/configuration.yaml
copying downloadable files... [100%] assets/example-bootstrap-config.yaml

copying static files... done
copying extra files... done
copying assets: done
writing output... [  1%] about
writing output... [  1%] capi/explanation/capi-ck8s
writing output... [  2%] capi/explanation/in-place-upgrades
writing output... [  3%] capi/explanation/index
writing output... [  3%] capi/explanation/installation-methods
writing output... [  4%] capi/explanation/networking
writing output... [  4%] capi/explanation/security
writing output... [  5%] capi/howto/custom-bootstrap-config
writing output... [  6%] capi/howto/custom-ck8s
writing output... [  6%] capi/howto/external-etcd
writing output... [  7%] capi/howto/in-place-upgrades
writing output... [  8%] capi/howto/index
writing output... [  8%] capi/howto/intermediate-ca
writing output... [  9%] capi/howto/migrate-management
writing output... [  9%] capi/howto/provision
writing output... [ 10%] capi/howto/refresh-certs
writing output... [ 11%] capi/howto/rollout-upgrades
writing output... [ 11%] capi/howto/troubleshooting
writing output... [ 12%] capi/howto/upgrade-providers
writing output... [ 13%] capi/index
writing output... [ 13%] capi/reference/annotations
writing output... [ 14%] capi/reference/configs
writing output... [ 15%] capi/reference/index
writing output... [ 15%] capi/reference/ports-and-services
writing output... [ 16%] capi/tutorial/getting-started
writing output... [ 16%] capi/tutorial/index
writing output... [ 17%] charm/explanation/architecture
writing output... [ 18%] charm/explanation/channels
writing output... [ 18%] charm/explanation/index
writing output... [ 19%] charm/explanation/installation-methods
writing output... [ 20%] charm/explanation/networking
writing output... [ 20%] charm/explanation/security
writing output... [ 21%] charm/explanation/upgrade
writing output... [ 22%] charm/howto/ceph-csi
writing output... [ 22%] charm/howto/configure-cluster
writing output... [ 23%] charm/howto/contribute
writing output... [ 23%] charm/howto/cos-lite
writing output... [ 24%] charm/howto/custom-registry
writing output... [ 25%] charm/howto/etcd
writing output... [ 25%] charm/howto/hardening
writing output... [ 26%] charm/howto/index
writing output... [ 27%] charm/howto/install/charm
writing output... [ 27%] charm/howto/install/custom-workers
writing output... [ 28%] charm/howto/install/index
writing output... [ 28%] charm/howto/install/install-custom
writing output... [ 29%] charm/howto/install/install-lxd
writing output... [ 30%] charm/howto/install/install-terraform
writing output... [ 30%] charm/howto/openstack
writing output... [ 31%] charm/howto/proxy
writing output... [ 32%] charm/howto/report-security-issue
writing output... [ 32%] charm/howto/troubleshooting
writing output... [ 33%] charm/howto/upgrade
writing output... [ 34%] charm/howto/validate
writing output... [ 34%] charm/index
writing output... [ 35%] charm/reference/actions
writing output... [ 35%] charm/reference/az
writing output... [ 36%] charm/reference/charm-configurations
writing output... [ 37%] charm/reference/charms
writing output... [ 37%] charm/reference/index
writing output... [ 38%] charm/reference/ports-and-services
writing output... [ 39%] charm/reference/proxy
writing output... [ 39%] charm/reference/security
writing output... [ 40%] charm/tutorial/basic-operations
writing output... [ 41%] charm/tutorial/getting-started
writing output... [ 41%] charm/tutorial/index
writing output... [ 42%] community
writing output... [ 42%] index
writing output... [ 43%] releases/charm/1.32
writing output... [ 44%] releases/charm/1.33
writing output... [ 44%] releases/charm/1.34
writing output... [ 45%] releases/charm/1.35
writing output... [ 46%] releases/charm/index
writing output... [ 46%] releases/index
writing output... [ 47%] releases/snap/1.32
writing output... [ 47%] releases/snap/1.33
writing output... [ 48%] releases/snap/1.34
writing output... [ 49%] releases/snap/1.35
writing output... [ 49%] releases/snap/index
writing output... [ 50%] releases/snap/upgrading
writing output... [ 51%] snap/explanation/architecture
writing output... [ 51%] snap/explanation/channels
writing output... [ 52%] snap/explanation/clustering
writing output... [ 53%] snap/explanation/documentation
writing output... [ 53%] snap/explanation/epa
writing output... [ 54%] snap/explanation/high-availability
writing output... [ 54%] snap/explanation/index
writing output... [ 55%] snap/explanation/installation-methods
writing output... [ 56%] snap/explanation/networking
writing output... [ 56%] snap/explanation/package-management
writing output... [ 57%] snap/explanation/roles
writing output... [ 58%] snap/explanation/security
writing output... [ 58%] snap/explanation/upgrade
writing output... [ 59%] snap/howto/backup-restore
writing output... [ 59%] snap/howto/contribute
writing output... [ 60%] snap/howto/epa
writing output... [ 61%] snap/howto/external-datastore
writing output... [ 61%] snap/howto/image-management
writing output... [ 62%] snap/howto/index
writing output... [ 63%] snap/howto/install/custom-bootstrap-config
writing output... [ 63%] snap/howto/install/custom-worker
writing output... [ 64%] snap/howto/install/dev-env
writing output... [ 65%] snap/howto/install/disa-stig
writing output... [ 65%] snap/howto/install/fips
writing output... [ 66%] snap/howto/install/index
writing output... [ 66%] snap/howto/install/lxd
writing output... [ 67%] snap/howto/install/multipass
writing output... [ 68%] snap/howto/install/offline
writing output... [ 68%] snap/howto/install/snap
writing output... [ 69%] snap/howto/install/uninstall
writing output... [ 70%] snap/howto/networking/alternative-cni
writing output... [ 70%] snap/howto/networking/default-dns
writing output... [ 71%] snap/howto/networking/default-gateway
writing output... [ 72%] snap/howto/networking/default-ingress
writing output... [ 72%] snap/howto/networking/default-loadbalancer
writing output... [ 73%] snap/howto/networking/default-network
writing output... [ 73%] snap/howto/networking/dualstack
writing output... [ 74%] snap/howto/networking/index
writing output... [ 75%] snap/howto/networking/ipv6
writing output... [ 75%] snap/howto/networking/proxy
writing output... [ 76%] snap/howto/networking/ufw
writing output... [ 77%] snap/howto/observability
writing output... [ 77%] snap/howto/restore-quorum
writing output... [ 78%] snap/howto/security/cis-assessment
writing output... [ 78%] snap/howto/security/hardening
writing output... [ 79%] snap/howto/security/index
writing output... [ 80%] snap/howto/security/intermediate-ca
writing output... [ 80%] snap/howto/security/refresh-certs
writing output... [ 81%] snap/howto/security/refresh-external-certs
writing output... [ 82%] snap/howto/security/report-security-issue
writing output... [ 82%] snap/howto/storage/ceph
writing output... [ 83%] snap/howto/storage/cloud
writing output... [ 84%] snap/howto/storage/index
writing output... [ 84%] snap/howto/storage/storage
writing output... [ 85%] snap/howto/support
writing output... [ 85%] snap/howto/troubleshooting
writing output... [ 86%] snap/howto/upgrades
writing output... [ 87%] snap/index
writing output... [ 87%] snap/reference/annotations
writing output... [ 88%] snap/reference/certificates
writing output... [ 89%] snap/reference/cis-audit
writing output... [ 89%] snap/reference/commands
writing output... [ 90%] snap/reference/config-files/bootstrap-config
writing output... [ 91%] snap/reference/config-files/disa-stig-config
writing output... [ 91%] snap/reference/config-files/index
writing output... [ 92%] snap/reference/config-files/node-join-config
writing output... [ 92%] snap/reference/config-files/refresh-external-certs-config
writing output... [ 93%] snap/reference/disa-stig-audit
writing output... [ 94%] snap/reference/dqlite
writing output... [ 94%] snap/reference/etcd
writing output... [ 95%] snap/reference/index
writing output... [ 96%] snap/reference/inspection-reports
writing output... [ 96%] snap/reference/ports-and-services
writing output... [ 97%] snap/reference/proxy
writing output... [ 97%] snap/reference/security
writing output... [ 98%] snap/tutorial/add-remove-nodes
writing output... [ 99%] snap/tutorial/getting-started
writing output... [ 99%] snap/tutorial/index
writing output... [100%] snap/tutorial/kubectl

generating indices... genindex done
writing additional pages... search done
copying images... [100%] assets/capi-ck8s.svg

dumping search index in English (code: en)... done
dumping object inventory... done
Writing redirects...
(good) snap/explanation/about/index.html --> about
(good) charm/explanation/about/index.html --> about
(good) capi/explanation/about/index.html --> about
(good) reference/community/index.html --> community
(good) snap/reference/community/index.html --> community
(good) charm/reference/community/index.html --> community
(good) capi/reference/community/index.html --> community
(good) reference/roadmap/index.html --> index.html
(good) snap/reference/roadmap/index.html --> index.html
(good) charm/reference/architecture/index.html --> charm/explanation/architecture
(good) snap/reference/architecture/index.html --> snap/explanation/architecture
(good) snap/reference/config-files/control-plane-join-config/index.html --> snap/reference/config-files/node-join-config
(good) snap/reference/config-files/worker-join-config/index.html --> snap/reference/config-files/node-join-config
(good) snap/reference/troubleshooting/index.html --> snap/howto/troubleshooting
(good) charm/reference/troubleshooting/index.html --> charm/howto/troubleshooting
(good) snap/howto/security/disa-stig-hardening/index.html --> snap/reference/disa-stig-audit
(good) snap/howto/security/disa-stig-assessment/index.html --> snap/reference/disa-stig-audit
(good) snap/explanation/security/security-overview/index.html --> snap/explanation/security
(good) snap/explanation/security/crypto/index.html --> snap/explanation/security
(good) snap/explanation/security/cis/index.html --> snap/explanation/security
(good) snap/explanation/security/certificates/index.html --> snap/explanation/security
(good) snap/explanation/security/auth/index.html --> snap/explanation/security
(good) snap/howto/intermediate-ca/index.html --> snap/howto/security/intermediate-ca
(good) snap/howto/refresh-certs/index.html --> snap/howto/security/refresh-certs
(good) snap/explanation/certificates/index.html --> snap/explanation/security
(good) snap/explanation/cis/index.html --> snap/explanation/security
(good) snap/howto/proxy/index.html --> snap/howto/networking/proxy
(good) snap/explanation/load-balancer/index.html --> snap/explanation/networking
(good) snap/explanation/default-dns/index.html --> snap/explanation/networking
(good) snap/explanation/ingress/index.html --> snap/explanation/networking
(good) capi/explanation/ingress/index.html --> capi/explanation/networking
(good) capi/explanation/load-balancer/index.html --> capi/explanation/networking
(good) charm/explanation/ingress/index.html --> charm/explanation/networking
(good) charm/explanation/load-balancer/index.html --> charm/explanation/networking
(good) snap/reference/releases/index.html --> releases/snap
(good) snap/reference/versions/1.35/index.html --> releases/snap/1.35
(good) snap/reference/versions/1.34/index.html --> releases/snap/1.34
(good) snap/reference/versions/1.33/index.html --> releases/snap/1.33
(good) snap/reference/versions/1.32/index.html --> releases/snap/1.32
(good) snap/reference/upgrading/index.html --> releases/snap/upgrading
(good) charm/reference/releases/index.html --> releases/charm
(good) charm/reference/versions/1.35/index.html --> releases/charm/1.35
(good) charm/reference/versions/1.34/index.html --> releases/charm/1.34
(good) charm/reference/versions/1.33/index.html --> releases/charm/1.33
(good) charm/reference/versions/1.32/index.html --> releases/charm/1.32
(good) capi/reference/releases/index.html --> releases/snap
(good) snap/reference/bootstrap-config-reference/index.html --> snap/reference/config-files/bootstrap-config
(good) snap/howto/two-node-ha/index.html --> index.html
(good) snap/howto/networking/load-balancer/index.html --> snap/howto/networking/default-loadbalancer
(good) charm/howto/upgrade-minor/index.html --> charm/howto/upgrade
(good) charm/howto/upgrade-patch/index.html --> charm/howto/upgrade
sphinx-sitemap: sitemap.xml was generated for URL https://documentation.ubuntu.com/canonical-kubernetes/latest/ in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/checkouts/latest/_readthedocs/html/sitemap.xml
build succeeded.

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