Read the Docs build information
Build id: 2158320
Project: canonical-k8s-snap
Version: latest
Commit: 7eff7df50ef43f63180e16a1d1c8f6b7bde0bfef
Date: 2024-04-17T14:52:36.459447Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2024-04-17T14:52:37.798489Z, end-time: 2024-04-17T14:52:38.426766Z, duration: 0, exit-code: 0
git clone --depth 1 https://github.com/canonical/k8s-snap.git .
Cloning into '.'...

[rtd-command-info] start-time: 2024-04-17T14:52:38.495546Z, end-time: 2024-04-17T14:52:39.038984Z, 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: 2024-04-17T14:52:39.166929Z, end-time: 2024-04-17T14:52:39.253942Z, 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 7eff7df Ku 642/docs restructure attempt 2 (#345)

[rtd-command-info] start-time: 2024-04-17T14:52:39.325011Z, end-time: 2024-04-17T14:52:39.388451Z, duration: 0, exit-code: 0
git clean -d -f -f


[rtd-command-info] start-time: 2024-04-17T14:52:39.460571Z, end-time: 2024-04-17T14:52:39.521831Z, duration: 0, exit-code: 0
cat docs/tools/.readthedocs.yaml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
  jobs:
    pre_build:
      - cp -r docs/src/* docs/tools/
      
# Build documentation in the docs/ directory with Sphinx
sphinx:
  builder: dirhtml
  configuration: docs/tools/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/tools/.sphinx/requirements.txt

[rtd-command-info] start-time: 2024-04-17T14:52:45.491988Z, end-time: 2024-04-17T14:52:45.572951Z, duration: 0, exit-code: 0
asdf global python 3.11.6


[rtd-command-info] start-time: 2024-04-17T14:52:45.988840Z, end-time: 2024-04-17T14:52:47.055695Z, duration: 1, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.11.6.final.0-64 in 775ms
  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: 2024-04-17T14:52:47.160126Z, end-time: 2024-04-17T14:52:57.710158Z, duration: 10, 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.11/site-packages (23.1)
Collecting pip
  Downloading pip-24.0-py3-none-any.whl (2.1 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.1/2.1 MB 10.8 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.11/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-69.5.1-py3-none-any.whl (894 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 894.6/894.6 kB 22.5 MB/s eta 0:00:00
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.6.1
    Uninstalling setuptools-67.6.1:
      Successfully uninstalled setuptools-67.6.1
  Attempting uninstall: pip
    Found existing installation: pip 23.1
    Uninstalling pip-23.1:
      Successfully uninstalled pip-23.1
Successfully installed pip-24.0 setuptools-69.5.1

[rtd-command-info] start-time: 2024-04-17T14:52:57.795178Z, end-time: 2024-04-17T14:53:06.902517Z, duration: 9, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext
Collecting sphinx
  Downloading sphinx-7.3.5-py3-none-any.whl.metadata (6.0 kB)
Collecting readthedocs-sphinx-ext
  Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting sphinxcontrib-applehelp (from sphinx)
  Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-devhelp (from sphinx)
  Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath (from sphinx)
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx)
  Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx)
  Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl.metadata (2.4 kB)
Collecting sphinxcontrib-qthelp (from sphinx)
  Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl.metadata (2.2 kB)
Collecting Jinja2>=3.0 (from sphinx)
  Downloading Jinja2-3.1.3-py3-none-any.whl.metadata (3.3 kB)
Collecting Pygments>=2.14 (from sphinx)
  Downloading pygments-2.17.2-py3-none-any.whl.metadata (2.6 kB)
Collecting docutils<0.22,>=0.18.1 (from sphinx)
  Downloading docutils-0.21.1-py3-none-any.whl.metadata (2.7 kB)
Collecting snowballstemmer>=2.0 (from sphinx)
  Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB)
Collecting babel>=2.9 (from sphinx)
  Downloading Babel-2.14.0-py3-none-any.whl.metadata (1.6 kB)
Collecting alabaster~=0.7.14 (from sphinx)
  Downloading alabaster-0.7.16-py3-none-any.whl.metadata (2.9 kB)
Collecting imagesize>=1.3 (from sphinx)
  Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting requests>=2.25.0 (from sphinx)
  Downloading requests-2.31.0-py3-none-any.whl.metadata (4.6 kB)
Collecting packaging>=21.0 (from sphinx)
  Downloading packaging-24.0-py3-none-any.whl.metadata (3.2 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx)
  Downloading MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB)
Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx)
  Downloading charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB)
Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx)
  Downloading idna-3.7-py3-none-any.whl.metadata (9.9 kB)
Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx)
  Downloading urllib3-2.2.1-py3-none-any.whl.metadata (6.4 kB)
Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx)
  Downloading certifi-2024.2.2-py3-none-any.whl.metadata (2.2 kB)
Downloading sphinx-7.3.5-py3-none-any.whl (3.3 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 44.3 MB/s eta 0:00:00
Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl (11 kB)
Downloading alabaster-0.7.16-py3-none-any.whl (13 kB)
Downloading Babel-2.14.0-py3-none-any.whl (11.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.0/11.0 MB 174.7 MB/s eta 0:00:00
Downloading docutils-0.21.1-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 182.5 MB/s eta 0:00:00
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Downloading Jinja2-3.1.3-py3-none-any.whl (133 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.2/133.2 kB 172.1 MB/s eta 0:00:00
Downloading packaging-24.0-py3-none-any.whl (53 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 53.5/53.5 kB 151.2 MB/s eta 0:00:00
Downloading pygments-2.17.2-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 187.9 MB/s eta 0:00:00
Downloading requests-2.31.0-py3-none-any.whl (62 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 159.7 MB/s eta 0:00:00
Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 185.8 MB/s eta 0:00:00
Downloading sphinxcontrib_htmlhelp-2.0.5-py3-none-any.whl (99 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 99.2/99.2 kB 164.0 MB/s eta 0:00:00
Downloading sphinxcontrib_serializinghtml-1.1.10-py3-none-any.whl (92 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 92.7/92.7 kB 167.2 MB/s eta 0:00:00
Downloading sphinxcontrib_applehelp-1.0.8-py3-none-any.whl (120 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 120.0/120.0 kB 164.4 MB/s eta 0:00:00
Downloading sphinxcontrib_devhelp-1.0.6-py3-none-any.whl (83 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 83.5/83.5 kB 146.6 MB/s eta 0:00:00
Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB)
Downloading sphinxcontrib_qthelp-1.0.7-py3-none-any.whl (89 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 89.4/89.4 kB 170.1 MB/s eta 0:00:00
Downloading certifi-2024.2.2-py3-none-any.whl (163 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 163.8/163.8 kB 177.2 MB/s eta 0:00:00
Downloading charset_normalizer-3.3.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (140 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.3/140.3 kB 169.4 MB/s eta 0:00:00
Downloading idna-3.7-py3-none-any.whl (66 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 66.8/66.8 kB 155.8 MB/s eta 0:00:00
Downloading MarkupSafe-2.1.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (28 kB)
Downloading urllib3-2.2.1-py3-none-any.whl (121 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 162.2 MB/s eta 0:00:00
Installing collected packages: snowballstemmer, urllib3, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx, readthedocs-sphinx-ext
Successfully installed Jinja2-3.1.3 MarkupSafe-2.1.5 Pygments-2.17.2 alabaster-0.7.16 babel-2.14.0 certifi-2024.2.2 charset-normalizer-3.3.2 docutils-0.21.1 idna-3.7 imagesize-1.4.1 packaging-24.0 readthedocs-sphinx-ext-2.2.5 requests-2.31.0 snowballstemmer-2.2.0 sphinx-7.3.5 sphinxcontrib-applehelp-1.0.8 sphinxcontrib-devhelp-1.0.6 sphinxcontrib-htmlhelp-2.0.5 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.7 sphinxcontrib-serializinghtml-1.1.10 urllib3-2.2.1

[rtd-command-info] start-time: 2024-04-17T14:53:07.006105Z, end-time: 2024-04-17T14:53:31.228260Z, duration: 24, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/tools/.sphinx/requirements.txt
Collecting canonical-sphinx-extensions (from -r docs/tools/.sphinx/requirements.txt (line 1))
  Downloading canonical_sphinx_extensions-0.0.21-py3-none-any.whl.metadata (12 kB)
Collecting furo (from -r docs/tools/.sphinx/requirements.txt (line 2))
  Downloading furo-2024.1.29-py3-none-any.whl.metadata (5.9 kB)
Collecting linkify-it-py (from -r docs/tools/.sphinx/requirements.txt (line 3))
  Downloading linkify_it_py-2.0.3-py3-none-any.whl.metadata (8.5 kB)
Collecting matplotlib (from -r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading matplotlib-3.8.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (5.8 kB)
Collecting myst-parser (from -r docs/tools/.sphinx/requirements.txt (line 5))
  Downloading myst_parser-2.0.0-py3-none-any.whl.metadata (5.4 kB)
Collecting pyspelling (from -r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading pyspelling-2.10-py3-none-any.whl.metadata (3.8 kB)
Requirement already satisfied: sphinx in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from -r docs/tools/.sphinx/requirements.txt (line 7)) (7.3.5)
Collecting sphinx-autobuild (from -r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading sphinx_autobuild-2024.4.16-py3-none-any.whl.metadata (7.7 kB)
Collecting sphinx-copybutton (from -r docs/tools/.sphinx/requirements.txt (line 9))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-design (from -r docs/tools/.sphinx/requirements.txt (line 10))
  Downloading sphinx_design-0.5.0-py3-none-any.whl.metadata (5.1 kB)
Collecting sphinx-notfound-page (from -r docs/tools/.sphinx/requirements.txt (line 11))
  Downloading sphinx_notfound_page-1.0.0-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-reredirects (from -r docs/tools/.sphinx/requirements.txt (line 12))
  Downloading sphinx_reredirects-0.1.3-py3-none-any.whl.metadata (2.6 kB)
Collecting sphinx-tabs (from -r docs/tools/.sphinx/requirements.txt (line 13))
  Downloading sphinx_tabs-3.4.5-py3-none-any.whl.metadata (6.3 kB)
Collecting sphinxcontrib-jquery (from -r docs/tools/.sphinx/requirements.txt (line 14))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)
Collecting sphinxext-opengraph (from -r docs/tools/.sphinx/requirements.txt (line 15))
  Downloading sphinxext_opengraph-0.9.1-py3-none-any.whl.metadata (6.5 kB)
Collecting sphinxcontrib-plantuml (from -r docs/tools/.sphinx/requirements.txt (line 16))
  Downloading sphinxcontrib-plantuml-0.29.tar.gz (15 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'
  Installing backend dependencies: started
  Installing backend dependencies: finished with status 'done'
  Preparing metadata (pyproject.toml): started
  Preparing metadata (pyproject.toml): finished with status 'done'
Collecting sphinxcontrib-kroki (from -r docs/tools/.sphinx/requirements.txt (line 17))
  Downloading sphinxcontrib-kroki-1.3.0.tar.gz (7.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'
  Installing backend dependencies: started
  Installing backend dependencies: finished with status 'done'
  Preparing metadata (pyproject.toml): started
  Preparing metadata (pyproject.toml): finished with status 'done'
Requirement already satisfied: requests in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (2.31.0)
Collecting beautifulsoup4 (from canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1))
  Downloading beautifulsoup4-4.12.3-py3-none-any.whl.metadata (3.8 kB)
Requirement already satisfied: docutils in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (0.21.1)
Collecting sphinx-basic-ng (from furo->-r docs/tools/.sphinx/requirements.txt (line 2))
  Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB)
Requirement already satisfied: pygments>=2.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from furo->-r docs/tools/.sphinx/requirements.txt (line 2)) (2.17.2)
Collecting uc-micro-py (from linkify-it-py->-r docs/tools/.sphinx/requirements.txt (line 3))
  Downloading uc_micro_py-1.0.3-py3-none-any.whl.metadata (2.0 kB)
Collecting contourpy>=1.0.1 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading contourpy-1.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (5.8 kB)
Collecting cycler>=0.10 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading cycler-0.12.1-py3-none-any.whl.metadata (3.8 kB)
Collecting fonttools>=4.22.0 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading fonttools-4.51.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (159 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 159.5/159.5 kB 8.3 MB/s eta 0:00:00
Collecting kiwisolver>=1.3.1 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (6.4 kB)
Collecting numpy>=1.21 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading numpy-1.26.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (61 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.0/61.0 kB 255.4 MB/s eta 0:00:00
Requirement already satisfied: packaging>=20.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4)) (24.0)
Collecting pillow>=8 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading pillow-10.3.0-cp311-cp311-manylinux_2_28_x86_64.whl.metadata (9.2 kB)
Collecting pyparsing>=2.3.1 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading pyparsing-3.1.2-py3-none-any.whl.metadata (5.1 kB)
Collecting python-dateutil>=2.7 (from matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading python_dateutil-2.9.0.post0-py2.py3-none-any.whl.metadata (8.4 kB)
Collecting docutils (from canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1))
  Downloading docutils-0.20.1-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.11/site-packages (from myst-parser->-r docs/tools/.sphinx/requirements.txt (line 5)) (3.1.3)
Collecting markdown-it-py~=3.0 (from myst-parser->-r docs/tools/.sphinx/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 (from myst-parser->-r docs/tools/.sphinx/requirements.txt (line 5))
  Downloading mdit_py_plugins-0.4.0-py3-none-any.whl.metadata (2.7 kB)
Collecting pyyaml (from myst-parser->-r docs/tools/.sphinx/requirements.txt (line 5))
  Downloading PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB)
Collecting html5lib (from pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading html5lib-1.1-py2.py3-none-any.whl.metadata (16 kB)
Collecting lxml (from pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading lxml-5.2.1-cp311-cp311-manylinux_2_28_x86_64.whl.metadata (3.4 kB)
Collecting markdown (from pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading Markdown-3.6-py3-none-any.whl.metadata (7.0 kB)
Collecting soupsieve>=1.8 (from pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading soupsieve-2.5-py3-none-any.whl.metadata (4.7 kB)
Collecting wcmatch>=8.5 (from pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading wcmatch-8.5.1-py3-none-any.whl.metadata (4.8 kB)
Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (1.0.8)
Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (1.0.6)
Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/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.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (2.0.5)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (1.1.10)
Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (1.0.7)
Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (2.2.0)
Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (2.14.0)
Requirement already satisfied: alabaster~=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (0.7.16)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from sphinx->-r docs/tools/.sphinx/requirements.txt (line 7)) (1.4.1)
Collecting colorama (from sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB)
Collecting starlette>=0.35 (from sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading starlette-0.37.2-py3-none-any.whl.metadata (5.9 kB)
Collecting uvicorn>=0.25 (from sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading uvicorn-0.29.0-py3-none-any.whl.metadata (6.3 kB)
Collecting watchfiles>=0.20 (from sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading watchfiles-0.21.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.9 kB)
Collecting websockets>=11 (from sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading websockets-12.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (6.6 kB)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from jinja2->myst-parser->-r docs/tools/.sphinx/requirements.txt (line 5)) (2.1.5)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst-parser->-r docs/tools/.sphinx/requirements.txt (line 5))
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Collecting six>=1.5 (from python-dateutil>=2.7->matplotlib->-r docs/tools/.sphinx/requirements.txt (line 4))
  Downloading six-1.16.0-py2.py3-none-any.whl.metadata (1.8 kB)
Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from requests->canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (3.3.2)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from requests->canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (3.7)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from requests->canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (2.2.1)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-k8s-snap/envs/latest/lib/python3.11/site-packages (from requests->canonical-sphinx-extensions->-r docs/tools/.sphinx/requirements.txt (line 1)) (2024.2.2)
Collecting anyio<5,>=3.4.0 (from starlette>=0.35->sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading anyio-4.3.0-py3-none-any.whl.metadata (4.6 kB)
Collecting click>=7.0 (from uvicorn>=0.25->sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading click-8.1.7-py3-none-any.whl.metadata (3.0 kB)
Collecting h11>=0.8 (from uvicorn>=0.25->sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading h11-0.14.0-py3-none-any.whl.metadata (8.2 kB)
Collecting bracex>=2.1.1 (from wcmatch>=8.5->pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading bracex-2.4-py3-none-any.whl.metadata (3.6 kB)
Collecting webencodings (from html5lib->pyspelling->-r docs/tools/.sphinx/requirements.txt (line 6))
  Downloading webencodings-0.5.1-py2.py3-none-any.whl.metadata (2.1 kB)
Collecting sniffio>=1.1 (from anyio<5,>=3.4.0->starlette>=0.35->sphinx-autobuild->-r docs/tools/.sphinx/requirements.txt (line 8))
  Downloading sniffio-1.3.1-py3-none-any.whl.metadata (3.9 kB)
Downloading canonical_sphinx_extensions-0.0.21-py3-none-any.whl (34 kB)
Downloading furo-2024.1.29-py3-none-any.whl (325 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 325.2/325.2 kB 32.0 MB/s eta 0:00:00
Downloading linkify_it_py-2.0.3-py3-none-any.whl (19 kB)
Downloading matplotlib-3.8.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 11.6/11.6 MB 162.6 MB/s eta 0:00:00
Downloading myst_parser-2.0.0-py3-none-any.whl (77 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 77.2/77.2 kB 268.2 MB/s eta 0:00:00
Downloading pyspelling-2.10-py3-none-any.whl (45 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 45.0/45.0 kB 242.2 MB/s eta 0:00:00
Downloading sphinx_autobuild-2024.4.16-py3-none-any.whl (11 kB)
Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB)
Downloading sphinx_design-0.5.0-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 227.4 MB/s eta 0:00:00
Downloading sphinx_notfound_page-1.0.0-py3-none-any.whl (8.1 kB)
Downloading sphinx_reredirects-0.1.3-py3-none-any.whl (5.3 kB)
Downloading sphinx_tabs-3.4.5-py3-none-any.whl (9.9 kB)
Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.1/121.1 kB 275.5 MB/s eta 0:00:00
Downloading sphinxext_opengraph-0.9.1-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 307.6 MB/s eta 0:00:00
Downloading contourpy-1.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (306 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 306.0/306.0 kB 290.3 MB/s eta 0:00:00
Downloading cycler-0.12.1-py3-none-any.whl (8.3 kB)
Downloading docutils-0.20.1-py3-none-any.whl (572 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 309.0 MB/s eta 0:00:00
Downloading fonttools-4.51.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (4.9 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.9/4.9 MB 176.4 MB/s eta 0:00:00
Downloading kiwisolver-1.4.5-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 271.4 MB/s eta 0:00:00
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 87.5/87.5 kB 239.8 MB/s eta 0:00:00
Downloading mdit_py_plugins-0.4.0-py3-none-any.whl (54 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 54.1/54.1 kB 255.1 MB/s eta 0:00:00
Downloading numpy-1.26.4-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (18.3 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 18.3/18.3 MB 172.3 MB/s eta 0:00:00
Downloading pillow-10.3.0-cp311-cp311-manylinux_2_28_x86_64.whl (4.5 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.5/4.5 MB 208.7 MB/s eta 0:00:00
Downloading pyparsing-3.1.2-py3-none-any.whl (103 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 103.2/103.2 kB 161.9 MB/s eta 0:00:00
Downloading python_dateutil-2.9.0.post0-py2.py3-none-any.whl (229 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 229.9/229.9 kB 302.9 MB/s eta 0:00:00
Downloading soupsieve-2.5-py3-none-any.whl (36 kB)
Downloading starlette-0.37.2-py3-none-any.whl (71 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 71.9/71.9 kB 262.1 MB/s eta 0:00:00
Downloading uvicorn-0.29.0-py3-none-any.whl (60 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 60.8/60.8 kB 271.4 MB/s eta 0:00:00
Downloading watchfiles-0.21.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (1.3 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.3/1.3 MB 282.1 MB/s eta 0:00:00
Downloading wcmatch-8.5.1-py3-none-any.whl (39 kB)
Downloading websockets-12.0-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (130 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 130.9/130.9 kB 287.3 MB/s eta 0:00:00
Downloading beautifulsoup4-4.12.3-py3-none-any.whl (147 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 147.9/147.9 kB 290.7 MB/s eta 0:00:00
Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
Downloading html5lib-1.1-py2.py3-none-any.whl (112 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 112.2/112.2 kB 288.4 MB/s eta 0:00:00
Downloading lxml-5.2.1-cp311-cp311-manylinux_2_28_x86_64.whl (5.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.0/5.0 MB 183.7 MB/s eta 0:00:00
Downloading Markdown-3.6-py3-none-any.whl (105 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 105.4/105.4 kB 283.9 MB/s eta 0:00:00
Downloading PyYAML-6.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (757 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 757.7/757.7 kB 310.8 MB/s eta 0:00:00
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading uc_micro_py-1.0.3-py3-none-any.whl (6.2 kB)
Downloading anyio-4.3.0-py3-none-any.whl (85 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 85.6/85.6 kB 275.2 MB/s eta 0:00:00
Downloading bracex-2.4-py3-none-any.whl (11 kB)
Downloading click-8.1.7-py3-none-any.whl (97 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 97.9/97.9 kB 285.4 MB/s eta 0:00:00
Downloading h11-0.14.0-py3-none-any.whl (58 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 58.3/58.3 kB 256.1 MB/s eta 0:00:00
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Downloading six-1.16.0-py2.py3-none-any.whl (11 kB)
Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB)
Downloading sniffio-1.3.1-py3-none-any.whl (10 kB)
Building wheels for collected packages: sphinxcontrib-plantuml, sphinxcontrib-kroki
  Building wheel for sphinxcontrib-plantuml (pyproject.toml): started
  Building wheel for sphinxcontrib-plantuml (pyproject.toml): finished with status 'done'
  Created wheel for sphinxcontrib-plantuml: filename=sphinxcontrib_plantuml-0.29-py3-none-any.whl size=11555 sha256=9ceeabb9152e11243e0e0174d526134c06ac2e85e69c1eed61aaf59c00b1eb52
  Stored in directory: /tmp/pip-ephem-wheel-cache-3u8uvu84/wheels/41/b1/34/0b7f24f17490eaeb0c82a521fe96675c38a10ba1c4fc759a2a
  Building wheel for sphinxcontrib-kroki (pyproject.toml): started
  Building wheel for sphinxcontrib-kroki (pyproject.toml): finished with status 'done'
  Created wheel for sphinxcontrib-kroki: filename=sphinxcontrib_kroki-1.3.0-py3-none-any.whl size=7238 sha256=a5e0c80b17c10a7d56e07748ba6e54bab8582297e5ea6ec9ba299dd1faac30d8
  Stored in directory: /tmp/pip-ephem-wheel-cache-3u8uvu84/wheels/79/c4/0e/db26d209ccfd3fb2dce52678d9675c407a5000a825c7d6bc78
Successfully built sphinxcontrib-plantuml sphinxcontrib-kroki
Installing collected packages: webencodings, websockets, uc-micro-py, soupsieve, sniffio, six, pyyaml, pyparsing, pillow, numpy, mdurl, markdown, lxml, kiwisolver, h11, fonttools, docutils, cycler, colorama, click, bracex, wcmatch, uvicorn, python-dateutil, markdown-it-py, linkify-it-py, html5lib, contourpy, beautifulsoup4, anyio, watchfiles, starlette, sphinxext-opengraph, sphinxcontrib-plantuml, sphinxcontrib-kroki, sphinxcontrib-jquery, sphinx-tabs, sphinx-reredirects, sphinx-notfound-page, sphinx-design, sphinx-copybutton, sphinx-basic-ng, pyspelling, mdit-py-plugins, matplotlib, canonical-sphinx-extensions, sphinx-autobuild, myst-parser, furo
  Attempting uninstall: docutils
    Found existing installation: docutils 0.21.1
    Uninstalling docutils-0.21.1:
      Successfully uninstalled docutils-0.21.1
Successfully installed anyio-4.3.0 beautifulsoup4-4.12.3 bracex-2.4 canonical-sphinx-extensions-0.0.21 click-8.1.7 colorama-0.4.6 contourpy-1.2.1 cycler-0.12.1 docutils-0.20.1 fonttools-4.51.0 furo-2024.1.29 h11-0.14.0 html5lib-1.1 kiwisolver-1.4.5 linkify-it-py-2.0.3 lxml-5.2.1 markdown-3.6 markdown-it-py-3.0.0 matplotlib-3.8.4 mdit-py-plugins-0.4.0 mdurl-0.1.2 myst-parser-2.0.0 numpy-1.26.4 pillow-10.3.0 pyparsing-3.1.2 pyspelling-2.10 python-dateutil-2.9.0.post0 pyyaml-6.0.1 six-1.16.0 sniffio-1.3.1 soupsieve-2.5 sphinx-autobuild-2024.4.16 sphinx-basic-ng-1.0.0b2 sphinx-copybutton-0.5.2 sphinx-design-0.5.0 sphinx-notfound-page-1.0.0 sphinx-reredirects-0.1.3 sphinx-tabs-3.4.5 sphinxcontrib-jquery-4.1 sphinxcontrib-kroki-1.3.0 sphinxcontrib-plantuml-0.29 sphinxext-opengraph-0.9.1 starlette-0.37.2 uc-micro-py-1.0.3 uvicorn-0.29.0 watchfiles-0.21.0 wcmatch-8.5.1 webencodings-0.5.1 websockets-12.0

[rtd-command-info] start-time: 2024-04-17T14:53:31.421295Z, end-time: 2024-04-17T14:53:31.485536Z, duration: 0, exit-code: 0
cp -r docs/src/* docs/tools/


[rtd-command-info] start-time: 2024-04-17T14:53:31.972403Z, end-time: 2024-04-17T14:53:32.021691Z, duration: 0, exit-code: 0
cat docs/tools/conf.py
import sys

sys.path.append('./')
from custom_conf import *

# Configuration file for the Sphinx documentation builder.
# You should not do any modifications to this file. Put your custom
# configuration into the custom_conf.py file.
# If you need to change this file, contribute the changes upstream.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

############################################################
### Extensions
############################################################

extensions = [
    'sphinx_design',
    'sphinx_tabs.tabs',
    'sphinx_reredirects',
    'canonical.youtube-links',
    'canonical.related-links',
    'canonical.custom-rst-roles',
    'canonical.terminal-output',
    'sphinx_copybutton',
    'sphinxext.opengraph',
    'myst_parser',
    'sphinxcontrib.jquery',
    'notfound.extension'
]
extensions.extend(custom_extensions)

### Configuration for extensions

# Additional MyST syntax
myst_enable_extensions = [
    'substitution',
    'deflist',
    'linkify'
]
myst_enable_extensions.extend(custom_myst_extensions)

# Used for related links
if not 'discourse_prefix' in html_context and 'discourse' in html_context:
    html_context['discourse_prefix'] = html_context['discourse'] + '/t/'

# The default for notfound_urls_prefix usually works, but not for
# documentation on documentation.ubuntu.com
if slug:
    notfound_urls_prefix = '/' + slug + '/en/latest/'

notfound_context = {
    'title': 'Page not found',
    'body': '<h1>Page not found</h1>\n\n<p>Sorry, but the documentation page that you are looking for was not found.</p>\n<p>Documentation changes over time, and pages are moved around. We try to redirect you to the updated content where possible, but unfortunately, that didn\'t work this time (maybe because the content you were looking for does not exist in this version of the documentation).</p>\n<p>You can try to use the navigation to locate the content you\'re looking for, or search for a similar page.</p>\n',
}

# Default image for OGP (to prevent font errors, see
# https://github.com/canonical/sphinx-docs-starter-pack/pull/54 )
if not 'ogp_image' in locals():
    ogp_image = 'https://assets.ubuntu.com/v1/253da317-image-document-ubuntudocs.svg'

############################################################
### General configuration
############################################################

exclude_patterns = [
    '_build',
    'Thumbs.db',
    '.DS_Store',
    '.sphinx',
    '_parts'
]
exclude_patterns.extend(custom_excludes)

rst_epilog = '''
.. include:: /reuse/links.txt
'''
if 'custom_rst_epilog' in locals():
    rst_epilog = custom_rst_epilog

source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

if not 'conf_py_path' in html_context and 'github_folder' in html_context:
    html_context['conf_py_path'] = html_context['github_folder']

# For ignoring specific links
linkcheck_anchors_ignore_for_url = [
    r'https://github\.com/.*'
]
linkcheck_anchors_ignore_for_url.extend(custom_linkcheck_anchors_ignore_for_url)

# Tags cannot be added directly in custom_conf.py, so add them here
for tag in custom_tags:
    tags.add(tag)

############################################################
### Styling
############################################################

# Find the current builder
builder = 'dirhtml'
if '-b' in sys.argv:
    builder = sys.argv[sys.argv.index('-b')+1]

# Setting templates_path for epub makes the build fail
if builder == 'dirhtml' or builder == 'html':
    templates_path = ['.sphinx/_templates']

# Theme configuration
html_theme = 'furo'
html_last_updated_fmt = ''
html_permalinks_icon = '¶'

if html_title == '':
    html_theme_options = {
        'sidebar_hide_name': True
        }

############################################################
### Additional files
############################################################

html_static_path = ['.sphinx/_static']

html_css_files = [
    'custom.css',
    'header.css',
    'github_issue_links.css',
    'furo_colors.css'
]
html_css_files.extend(custom_html_css_files)

html_js_files = ['header-nav.js']
if 'github_issues' in html_context and html_context['github_issues'] and not disable_feedback_button:
    html_js_files.append('github_issue_links.js')
html_js_files.extend(custom_html_js_files)




###########################################################################
#          auto-created readthedocs.org specific configuration            #
###########################################################################


#
# The following code was added during an automated build on readthedocs.org
# It is auto created and injected for every build. The result is based on the
# conf.py.tmpl file found in the readthedocs.org codebase:
# https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl
#
# Note: this file shouldn't rely on extra dependencies.

import importlib
import sys
import os.path

# Borrowed from six.
PY3 = sys.version_info[0] == 3
string_types = str if PY3 else basestring

from sphinx import version_info

# Get suffix for proper linking to GitHub
# This is deprecated in Sphinx 1.3+,
# as each page can have its own suffix
if globals().get('source_suffix', False):
    if isinstance(source_suffix, string_types):
        SUFFIX = source_suffix
    elif isinstance(source_suffix, (list, tuple)):
        # Sphinx >= 1.3 supports list/tuple to define multiple suffixes
        SUFFIX = source_suffix[0]
    elif isinstance(source_suffix, dict):
        # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes
        SUFFIX = list(source_suffix.keys())[0]  # make a ``list()`` for py2/py3 compatibility
    else:
        # default to .rst
        SUFFIX = '.rst'
else:
    SUFFIX = '.rst'

# Add RTD Static Path. Add to the end because it overwrites previous files.
if not 'html_static_path' in globals():
    html_static_path = []
if os.path.exists('_static'):
    html_static_path.append('_static')

# Define this variable in case it's not defined by the user.
# It defaults to `alabaster` which is the default from Sphinx.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme
html_theme = globals().get('html_theme', 'alabaster')

#Add project information to the template context.
context = {
    'html_theme': html_theme,
    'current_version': "latest",
    'version_slug': "latest",
    'MEDIA_URL': "https://media.readthedocs.com/media/",
    'STATIC_URL': "https://assets.readthedocs.com/",
    'PRODUCTION_DOMAIN': "readthedocs.com",
    'proxied_static_path': "/_/static/",
    'versions': [
    ("latest", "/en/latest/"),
    ("staging", "/en/staging/"),
    ("main", "/en/main/"),
    ],
    'downloads': [ 
    ("pdf", "//documentation.ubuntu.com/_/downloads/canonical-kubernetes/en/latest/pdf/"),
    ],
    'subprojects': [ 
    ],
    'slug': 'canonical-k8s-snap',
    'name': u'k8s-snap',
    'rtd_language': u'en',
    'programming_language': u'go',
    'canonical_url': '',
    'analytics_code': 'None',
    'single_version': False,
    'conf_py_path': '/docs/tools/',
    'api_host': 'https://readthedocs.com',
    'github_user': 'canonical',
    'proxied_api_host': '/_',
    'github_repo': 'k8s-snap',
    'github_version': 'main',
    'display_github': True,
    'bitbucket_user': 'None',
    'bitbucket_repo': 'None',
    'bitbucket_version': 'main',
    'display_bitbucket': False,
    'gitlab_user': 'None',
    'gitlab_repo': 'None',
    'gitlab_version': 'main',
    'display_gitlab': False,
    'READTHEDOCS': True,
    'using_theme': (html_theme == "default"),
    'new_theme': (html_theme == "sphinx_rtd_theme"),
    'source_suffix': SUFFIX,
    'ad_free': False,
    'docsearch_disabled': False,
    'user_analytics_code': '',
    'global_analytics_code': 'UA-17997319-2',
    'commit': '7eff7df5',
}

# For sphinx >=1.8 we can use html_baseurl to set the canonical URL.
# https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl
if version_info >= (1, 8):
    if not globals().get('html_baseurl'):
        html_baseurl = context['canonical_url']
    context['canonical_url'] = None





if 'html_context' in globals():
    for key in context:
        if key not in html_context:
            html_context[key] = context[key]
else:
    html_context = context

# Add custom RTD extension
if 'extensions' in globals():
    # Insert at the beginning because it can interfere
    # with other extensions.
    # See https://github.com/rtfd/readthedocs.org/pull/4054
    extensions.insert(0, "readthedocs_ext.readthedocs")
else:
    extensions = ["readthedocs_ext.readthedocs"]

# Add External version warning banner to the external version documentation
if 'branch' == 'external':
    extensions.insert(1, "readthedocs_ext.external_version_warning")
    readthedocs_vcs_url = 'None'
    readthedocs_build_url = 'https://readthedocs.com/projects/canonical-k8s-snap/builds/2158320/'

project_language = 'en'

# User's Sphinx configurations
language_user = globals().get('language', None)
latex_engine_user = globals().get('latex_engine', None)
latex_elements_user = globals().get('latex_elements', None)

# Remove this once xindy gets installed in Docker image and XINDYOPS
# env variable is supported
# https://github.com/rtfd/readthedocs-docker-images/pull/98
latex_use_xindy = False

chinese = any([
    language_user in ('zh_CN', 'zh_TW'),
    project_language in ('zh_CN', 'zh_TW'),
])

japanese = any([
    language_user == 'ja',
    project_language == 'ja',
])

if chinese:
    latex_engine = latex_engine_user or 'xelatex'

    latex_elements_rtd = {
        'preamble': '\\usepackage[UTF8]{ctex}\n',
    }
    latex_elements = latex_elements_user or latex_elements_rtd
elif japanese:
    latex_engine = latex_engine_user or 'platex'

# Make sure our build directory is always excluded
exclude_patterns = globals().get('exclude_patterns', [])
exclude_patterns.extend(['_build'])