Read the Docs build information
Build id: 3258395
Project: canonical-microceph
Version: latest
Commit: 28fa8b650dc5fde1b0ee937e139cc25c635ec3b0
Date: 2025-08-07T13:03:08.641677Z
State: cancelled
Success: False


[rtd-command-info] start-time: 2025-08-07T13:05:40.407640Z, end-time: 2025-08-07T13:05:43.250440Z, duration: 2, exit-code: 0
git clone --depth 1 https://github.com/canonical/microceph.git .
Cloning into '.'...

[rtd-command-info] start-time: 2025-08-07T13:05:43.353269Z, end-time: 2025-08-07T13:05:44.349715Z, duration: 0, exit-code: 0
git fetch origin --force --prune --prune-tags --depth 50 refs/heads/main:refs/remotes/origin/main
From https://github.com/canonical/microceph
 * [new tag]         v19.2.0+squid -> v19.2.0+squid

[rtd-command-info] start-time: 2025-08-07T13:05:45.062643Z, end-time: 2025-08-07T13:05:45.126767Z, 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 28fa8b6 test: speed up test (#599)

[rtd-command-info] start-time: 2025-08-07T13:05:45.215367Z, end-time: 2025-08-07T13:05:45.258514Z, duration: 0, exit-code: 0
cat docs/.readthedocs.yaml
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2

# Set the version of Python and other tools you might need
build:
  os: ubuntu-22.04
  tools:
    python: "3.11"
  jobs:
    post_checkout:
    - git fetch --unshallow || true
    # Cancel building pull requests when there aren't changed in the docs directory.
    # If there are no changes (git diff exits with 0) we force the command to return with 183.
    # This is a special exit code on Read the Docs that will cancel the build immediately.
    # https://docs.readthedocs.io/en/stable/build-customization.html#cancel-build-based-on-a-condition
    - |
      if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
      then
        exit 183;
      fi

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

# If using Sphinx, optionally build your docs in additional formats such as PDF
formats:
- pdf

# Optionally declare the Python requirements required to build your docs
python:
  install:
  - requirements: docs/requirements.txt

[rtd-command-info] start-time: 2025-08-07T13:05:45.373967Z, end-time: 2025-08-07T13:05:46.438714Z, duration: 1, exit-code: 0
git fetch --unshallow || true
From https://github.com/canonical/microceph
 * [new tag]         v17.2.7+quincy -> v17.2.7+quincy

[rtd-command-info] start-time: 2025-08-07T13:05:46.529513Z, end-time: 2025-08-07T13:05:46.570932Z, duration: 0, exit-code: 0
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/main -- 'docs/' '.readthedocs.yaml';
then
  exit 183;
fi


[rtd-command-info] start-time: 2025-08-07T13:05:51.912749Z, end-time: 2025-08-07T13:05:51.976121Z, duration: 0, exit-code: 0
asdf global python 3.11.12


[rtd-command-info] start-time: 2025-08-07T13:05:52.475118Z, end-time: 2025-08-07T13:05:53.492818Z, duration: 1, exit-code: 0
python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH
created virtual environment CPython3.11.12.final.0-64 in 725ms
  creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/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: 2025-08-07T13:05:53.628603Z, end-time: 2025-08-07T13:06:02.458142Z, duration: 8, 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-microceph/envs/latest/lib/python3.11/site-packages (23.1)
Collecting pip
  Downloading pip-25.2-py3-none-any.whl (1.8 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 12.3 MB/s eta 0:00:00
Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (67.6.1)
Collecting setuptools
  Downloading setuptools-80.9.0-py3-none-any.whl (1.2 MB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 26.8 MB/s eta 0:00:00
Installing collected packages: setuptools, pip
  Attempting uninstall: setuptools
    Found existing installation: setuptools 67.6.1
    Uninstalling setuptools-67.6.1:
      Successfully uninstalled setuptools-67.6.1
  Attempting uninstall: pip
    Found existing installation: pip 23.1
    Uninstalling pip-23.1:
      Successfully uninstalled pip-23.1
Successfully installed pip-25.2 setuptools-80.9.0

[rtd-command-info] start-time: 2025-08-07T13:06:02.552767Z, end-time: 2025-08-07T13:06:07.608994Z, duration: 5, exit-code: 0
python -m pip install --upgrade --no-cache-dir sphinx
Collecting sphinx
  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 kB)
Collecting sphinxcontrib-applehelp>=1.0.7 (from sphinx)
  Downloading sphinxcontrib_applehelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-devhelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_devhelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-htmlhelp>=2.0.6 (from sphinx)
  Downloading sphinxcontrib_htmlhelp-2.1.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-jsmath>=1.0.1 (from sphinx)
  Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB)
Collecting sphinxcontrib-qthelp>=1.0.6 (from sphinx)
  Downloading sphinxcontrib_qthelp-2.0.0-py3-none-any.whl.metadata (2.3 kB)
Collecting sphinxcontrib-serializinghtml>=1.1.9 (from sphinx)
  Downloading sphinxcontrib_serializinghtml-2.0.0-py3-none-any.whl.metadata (2.4 kB)
Collecting Jinja2>=3.1 (from sphinx)
  Downloading jinja2-3.1.6-py3-none-any.whl.metadata (2.9 kB)
Collecting Pygments>=2.17 (from sphinx)
  Downloading pygments-2.19.2-py3-none-any.whl.metadata (2.5 kB)
Collecting docutils<0.22,>=0.20 (from sphinx)
  Downloading docutils-0.21.2-py3-none-any.whl.metadata (2.8 kB)
Collecting snowballstemmer>=2.2 (from sphinx)
  Downloading snowballstemmer-3.0.1-py3-none-any.whl.metadata (7.9 kB)
Collecting babel>=2.13 (from sphinx)
  Downloading babel-2.17.0-py3-none-any.whl.metadata (2.0 kB)
Collecting alabaster>=0.7.14 (from sphinx)
  Downloading alabaster-1.0.0-py3-none-any.whl.metadata (2.8 kB)
Collecting imagesize>=1.3 (from sphinx)
  Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB)
Collecting requests>=2.30.0 (from sphinx)
  Downloading requests-2.32.4-py3-none-any.whl.metadata (4.9 kB)
Collecting roman-numerals-py>=1.0.0 (from sphinx)
  Downloading roman_numerals_py-3.1.0-py3-none-any.whl.metadata (3.6 kB)
Collecting packaging>=23.0 (from sphinx)
  Downloading packaging-25.0-py3-none-any.whl.metadata (3.3 kB)
Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx)
  Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.0 kB)
Collecting charset_normalizer<4,>=2 (from requests>=2.30.0->sphinx)
  Downloading charset_normalizer-3.4.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (35 kB)
Collecting idna<4,>=2.5 (from requests>=2.30.0->sphinx)
  Downloading idna-3.10-py3-none-any.whl.metadata (10 kB)
Collecting urllib3<3,>=1.21.1 (from requests>=2.30.0->sphinx)
  Downloading urllib3-2.5.0-py3-none-any.whl.metadata (6.5 kB)
Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx)
  Downloading certifi-2025.8.3-py3-none-any.whl.metadata (2.4 kB)
Downloading sphinx-8.2.3-py3-none-any.whl (3.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.6/3.6 MB 166.7 MB/s  0:00:00
Downloading docutils-0.21.2-py3-none-any.whl (587 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 614.7 MB/s  0:00:00
Downloading alabaster-1.0.0-py3-none-any.whl (13 kB)
Downloading babel-2.17.0-py3-none-any.whl (10.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.2/10.2 MB 511.2 MB/s  0:00:00
Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB)
Downloading jinja2-3.1.6-py3-none-any.whl (134 kB)
Downloading MarkupSafe-3.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB)
Downloading packaging-25.0-py3-none-any.whl (66 kB)
Downloading pygments-2.19.2-py3-none-any.whl (1.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 660.5 MB/s  0:00:00
Downloading requests-2.32.4-py3-none-any.whl (64 kB)
Downloading charset_normalizer-3.4.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (147 kB)
Downloading idna-3.10-py3-none-any.whl (70 kB)
Downloading urllib3-2.5.0-py3-none-any.whl (129 kB)
Downloading certifi-2025.8.3-py3-none-any.whl (161 kB)
Downloading roman_numerals_py-3.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-py, Pygments, packaging, MarkupSafe, imagesize, idna, docutils, charset_normalizer, certifi, babel, alabaster, requests, Jinja2, sphinx

Successfully installed Jinja2-3.1.6 MarkupSafe-3.0.2 Pygments-2.19.2 alabaster-1.0.0 babel-2.17.0 certifi-2025.8.3 charset_normalizer-3.4.2 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-25.0 requests-2.32.4 roman-numerals-py-3.1.0 snowballstemmer-3.0.1 sphinx-8.2.3 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.5.0

[rtd-command-info] start-time: 2025-08-07T13:06:07.694962Z, end-time: 2025-08-07T13:06:14.428310Z, duration: 6, exit-code: 0
python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt
Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from -r docs/requirements.txt (line 2)) (25.0)
Collecting sphinx-last-updated-by-git (from -r docs/requirements.txt (line 4))
  Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl.metadata (7.1 kB)
Collecting sphinx-sitemap (from -r docs/requirements.txt (line 5))
  Downloading sphinx_sitemap-2.7.2-py3-none-any.whl.metadata (3.4 kB)
Collecting canonical-sphinx[full] (from -r docs/requirements.txt (line 1))
  Downloading canonical_sphinx-0.5.1-py3-none-any.whl.metadata (5.8 kB)
Collecting sphinxcontrib-svg2pdfconverter[CairoSVG] (from -r docs/requirements.txt (line 3))
  Downloading sphinxcontrib_svg2pdfconverter-1.3.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-microceph/envs/latest/lib/python3.11/site-packages (from canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (8.2.3)
Collecting furo (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading furo-2025.7.19-py3-none-any.whl.metadata (6.0 kB)
Collecting myst-parser (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading myst_parser-4.0.1-py3-none-any.whl.metadata (5.5 kB)
Collecting linkify-it-py (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading linkify_it_py-2.0.3-py3-none-any.whl.metadata (8.5 kB)
Collecting canonical-sphinx-extensions (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading canonical_sphinx_extensions-0.0.33-py3-none-any.whl.metadata (16 kB)
Collecting sphinx-copybutton (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_copybutton-0.5.2-py3-none-any.whl.metadata (3.2 kB)
Collecting sphinx-design (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_design-0.6.1-py3-none-any.whl.metadata (5.5 kB)
Collecting sphinx-notfound-page (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl.metadata (2.9 kB)
Collecting sphinx-reredirects (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_reredirects-1.0.0-py3-none-any.whl.metadata (4.7 kB)
Collecting sphinx-tabs (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_tabs-3.4.7-py3-none-any.whl.metadata (6.3 kB)
Collecting sphinxcontrib-jquery (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB)
Collecting sphinxext-opengraph (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinxext_opengraph-0.12.0-py3-none-any.whl.metadata (2.7 kB)
Collecting pyspelling (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading pyspelling-2.10-py3-none-any.whl.metadata (3.8 kB)
Collecting sphinx-autobuild (from canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_autobuild-2024.10.3-py3-none-any.whl.metadata (7.7 kB)
Collecting cairosvg>=1.0 (from sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading cairosvg-2.8.2-py3-none-any.whl.metadata (2.7 kB)
Collecting cairocffi (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading cairocffi-1.7.1-py3-none-any.whl.metadata (3.3 kB)
Collecting cssselect2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading cssselect2-0.8.0-py3-none-any.whl.metadata (2.9 kB)
Collecting defusedxml (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading defusedxml-0.7.1-py2.py3-none-any.whl.metadata (32 kB)
Collecting pillow (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading pillow-11.3.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.metadata (9.0 kB)
Collecting tinycss2 (from cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading tinycss2-1.4.0-py3-none-any.whl.metadata (3.0 kB)
Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.1.0)
Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (1.0.1)
Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.0.0)
Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.1.6)
Requirement already satisfied: Pygments>=2.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.19.2)
Requirement already satisfied: docutils<0.22,>=0.20 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (0.21.2)
Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.0.1)
Requirement already satisfied: babel>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.17.0)
Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (1.0.0)
Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (1.4.1)
Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.32.4)
Requirement already satisfied: roman-numerals-py>=1.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.1.0)
Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from Jinja2>=3.1->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.0.2)
Requirement already satisfied: charset_normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.4.2)
Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (3.10)
Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2.5.0)
Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.11/site-packages (from requests>=2.30.0->Sphinx>=7.1.2->canonical-sphinx[full]->-r docs/requirements.txt (line 1)) (2025.8.3)
Collecting cffi>=1.1.0 (from cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading cffi-1.17.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (1.5 kB)
Collecting pycparser (from cffi>=1.1.0->cairocffi->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading pycparser-2.22-py3-none-any.whl.metadata (943 bytes)
Collecting beautifulsoup4 (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading beautifulsoup4-4.13.4-py3-none-any.whl.metadata (3.8 kB)
Collecting gitpython (from canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading gitpython-3.1.45-py3-none-any.whl.metadata (13 kB)
Collecting soupsieve>1.2 (from beautifulsoup4->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading soupsieve-2.7-py3-none-any.whl.metadata (4.6 kB)
Collecting typing-extensions>=4.0.0 (from beautifulsoup4->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading typing_extensions-4.14.1-py3-none-any.whl.metadata (3.0 kB)
Collecting webencodings (from cssselect2->cairosvg>=1.0->sphinxcontrib-svg2pdfconverter[CairoSVG]->-r docs/requirements.txt (line 3))
  Downloading webencodings-0.5.1-py2.py3-none-any.whl.metadata (2.1 kB)
Collecting sphinx-basic-ng>=1.0.0.beta2 (from furo->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl.metadata (1.5 kB)
Collecting accessible-pygments>=0.0.5 (from furo->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading accessible_pygments-0.0.5-py3-none-any.whl.metadata (10 kB)
Collecting gitdb<5,>=4.0.1 (from gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading gitdb-4.0.12-py3-none-any.whl.metadata (1.2 kB)
Collecting smmap<6,>=3.0.1 (from gitdb<5,>=4.0.1->gitpython->canonical-sphinx-extensions->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading smmap-5.0.2-py3-none-any.whl.metadata (4.3 kB)
Collecting uc-micro-py (from linkify-it-py->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading uc_micro_py-1.0.3-py3-none-any.whl.metadata (2.0 kB)
Collecting markdown-it-py~=3.0 (from myst-parser->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  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->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading mdit_py_plugins-0.4.2-py3-none-any.whl.metadata (2.8 kB)
Collecting pyyaml (from myst-parser->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading PyYAML-6.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (2.1 kB)
Collecting mdurl~=0.1 (from markdown-it-py~=3.0->myst-parser->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading mdurl-0.1.2-py3-none-any.whl.metadata (1.6 kB)
Collecting html5lib (from pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading html5lib-1.1-py2.py3-none-any.whl.metadata (16 kB)
Collecting lxml (from pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading lxml-6.0.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.metadata (6.6 kB)
Collecting markdown (from pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading markdown-3.8.2-py3-none-any.whl.metadata (5.1 kB)
Collecting wcmatch>=8.5 (from pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading wcmatch-10.1-py3-none-any.whl.metadata (5.1 kB)
Collecting bracex>=2.1.1 (from wcmatch>=8.5->pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading bracex-2.6-py3-none-any.whl.metadata (3.6 kB)
Collecting six>=1.9 (from html5lib->pyspelling->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading six-1.17.0-py2.py3-none-any.whl.metadata (1.7 kB)
Collecting colorama>=0.4.6 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB)
Collecting starlette>=0.35 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading starlette-0.47.2-py3-none-any.whl.metadata (6.2 kB)
Collecting uvicorn>=0.25 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading uvicorn-0.35.0-py3-none-any.whl.metadata (6.5 kB)
Collecting watchfiles>=0.20 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading watchfiles-1.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (4.9 kB)
Collecting websockets>=11 (from sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading websockets-15.0.1-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (6.8 kB)
Collecting anyio<5,>=3.6.2 (from starlette>=0.35->sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading anyio-4.10.0-py3-none-any.whl.metadata (4.0 kB)
Collecting sniffio>=1.1 (from anyio<5,>=3.6.2->starlette>=0.35->sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading sniffio-1.3.1-py3-none-any.whl.metadata (3.9 kB)
Collecting click>=7.0 (from uvicorn>=0.25->sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading click-8.2.1-py3-none-any.whl.metadata (2.5 kB)
Collecting h11>=0.8 (from uvicorn>=0.25->sphinx-autobuild->canonical-sphinx[full]->-r docs/requirements.txt (line 1))
  Downloading h11-0.16.0-py3-none-any.whl.metadata (8.3 kB)
Downloading canonical_sphinx-0.5.1-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 67.6 MB/s  0:00:00
Downloading sphinxcontrib_svg2pdfconverter-1.3.0-py3-none-any.whl (7.9 kB)
Downloading sphinx_last_updated_by_git-0.3.8-py3-none-any.whl (8.6 kB)
Downloading sphinx_sitemap-2.7.2-py3-none-any.whl (6.0 kB)
Downloading cairosvg-2.8.2-py3-none-any.whl (45 kB)
Downloading cairocffi-1.7.1-py3-none-any.whl (75 kB)
Downloading cffi-1.17.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (467 kB)
Downloading canonical_sphinx_extensions-0.0.33-py3-none-any.whl (67 kB)
Downloading beautifulsoup4-4.13.4-py3-none-any.whl (187 kB)
Downloading soupsieve-2.7-py3-none-any.whl (36 kB)
Downloading typing_extensions-4.14.1-py3-none-any.whl (43 kB)
Downloading cssselect2-0.8.0-py3-none-any.whl (15 kB)
Downloading defusedxml-0.7.1-py2.py3-none-any.whl (25 kB)
Downloading furo-2025.7.19-py3-none-any.whl (342 kB)
Downloading accessible_pygments-0.0.5-py3-none-any.whl (1.4 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 170.8 MB/s  0:00:00
Downloading sphinx_basic_ng-1.0.0b2-py3-none-any.whl (22 kB)
Downloading gitpython-3.1.45-py3-none-any.whl (208 kB)
Downloading gitdb-4.0.12-py3-none-any.whl (62 kB)
Downloading smmap-5.0.2-py3-none-any.whl (24 kB)
Downloading linkify_it_py-2.0.3-py3-none-any.whl (19 kB)
Downloading myst_parser-4.0.1-py3-none-any.whl (84 kB)
Downloading markdown_it_py-3.0.0-py3-none-any.whl (87 kB)
Downloading mdit_py_plugins-0.4.2-py3-none-any.whl (55 kB)
Downloading mdurl-0.1.2-py3-none-any.whl (10.0 kB)
Downloading pillow-11.3.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (6.6 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.6/6.6 MB 268.0 MB/s  0:00:00
Downloading pycparser-2.22-py3-none-any.whl (117 kB)
Downloading pyspelling-2.10-py3-none-any.whl (45 kB)
Downloading wcmatch-10.1-py3-none-any.whl (39 kB)
Downloading bracex-2.6-py3-none-any.whl (11 kB)
Downloading html5lib-1.1-py2.py3-none-any.whl (112 kB)
Downloading six-1.17.0-py2.py3-none-any.whl (11 kB)
Downloading lxml-6.0.0-cp311-cp311-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (5.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.2/5.2 MB 331.3 MB/s  0:00:00
Downloading markdown-3.8.2-py3-none-any.whl (106 kB)
Downloading PyYAML-6.0.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (762 kB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 763.0/763.0 kB 626.1 MB/s  0:00:00
Downloading sphinx_autobuild-2024.10.3-py3-none-any.whl (11 kB)
Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
Downloading starlette-0.47.2-py3-none-any.whl (72 kB)
Downloading anyio-4.10.0-py3-none-any.whl (107 kB)
Downloading sniffio-1.3.1-py3-none-any.whl (10 kB)
Downloading uvicorn-0.35.0-py3-none-any.whl (66 kB)
Downloading click-8.2.1-py3-none-any.whl (102 kB)
Downloading h11-0.16.0-py3-none-any.whl (37 kB)
Downloading watchfiles-1.1.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (453 kB)
Downloading websockets-15.0.1-cp311-cp311-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (182 kB)
Downloading sphinx_copybutton-0.5.2-py3-none-any.whl (13 kB)
Downloading sphinx_design-0.6.1-py3-none-any.whl (2.2 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 93.1 MB/s  0:00:00
Downloading sphinx_notfound_page-1.1.0-py3-none-any.whl (8.2 kB)
Downloading sphinx_reredirects-1.0.0-py3-none-any.whl (6.2 kB)
Downloading sphinx_tabs-3.4.7-py3-none-any.whl (9.7 kB)
Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB)
Downloading sphinxext_opengraph-0.12.0-py3-none-any.whl (1.0 MB)
   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.0/1.0 MB 627.6 MB/s  0:00:00
Downloading tinycss2-1.4.0-py3-none-any.whl (26 kB)
Downloading webencodings-0.5.1-py2.py3-none-any.whl (11 kB)
Downloading uc_micro_py-1.0.3-py3-none-any.whl (6.2 kB)
Installing collected packages: webencodings, websockets, uc-micro-py, typing-extensions, tinycss2, soupsieve, sniffio, smmap, six, pyyaml, pycparser, pillow, mdurl, markdown, lxml, h11, defusedxml, colorama, click, bracex, accessible-pygments, wcmatch, uvicorn, markdown-it-py, linkify-it-py, html5lib, gitdb, cssselect2, cffi, beautifulsoup4, anyio, watchfiles, starlette, sphinxext-opengraph, sphinxcontrib-svg2pdfconverter, sphinxcontrib-jquery, sphinx-tabs, sphinx-reredirects, sphinx-notfound-page, sphinx-last-updated-by-git, sphinx-design, sphinx-copybutton, sphinx-basic-ng, pyspelling, mdit-py-plugins, gitpython, cairocffi, sphinx-sitemap, sphinx-autobuild, myst-parser, furo, canonical-sphinx-extensions, cairosvg, canonical-sphinx

Successfully installed accessible-pygments-0.0.5 anyio-4.10.0 beautifulsoup4-4.13.4 bracex-2.6 cairocffi-1.7.1 cairosvg-2.8.2 canonical-sphinx-0.5.1 canonical-sphinx-extensions-0.0.33 cffi-1.17.1 click-8.2.1 colorama-0.4.6 cssselect2-0.8.0 defusedxml-0.7.1 furo-2025.7.19 gitdb-4.0.12 gitpython-3.1.45 h11-0.16.0 html5lib-1.1 linkify-it-py-2.0.3 lxml-6.0.0 markdown-3.8.2 markdown-it-py-3.0.0 mdit-py-plugins-0.4.2 mdurl-0.1.2 myst-parser-4.0.1 pillow-11.3.0 pycparser-2.22 pyspelling-2.10 pyyaml-6.0.2 six-1.17.0 smmap-5.0.2 sniffio-1.3.1 soupsieve-2.7 sphinx-autobuild-2024.10.3 sphinx-basic-ng-1.0.0b2 sphinx-copybutton-0.5.2 sphinx-design-0.6.1 sphinx-last-updated-by-git-0.3.8 sphinx-notfound-page-1.1.0 sphinx-reredirects-1.0.0 sphinx-sitemap-2.7.2 sphinx-tabs-3.4.7 sphinxcontrib-jquery-4.1 sphinxcontrib-svg2pdfconverter-1.3.0 sphinxext-opengraph-0.12.0 starlette-0.47.2 tinycss2-1.4.0 typing-extensions-4.14.1 uc-micro-py-1.0.3 uvicorn-0.35.0 watchfiles-1.1.0 wcmatch-10.1 webencodings-0.5.1 websockets-15.0.1

[rtd-command-info] start-time: 2025-08-07T13:06:14.598855Z, end-time: 2025-08-07T13:06:14.643491Z, duration: 0, exit-code: 0
cat docs/conf.py
import datetime
import os
import yaml

# Configuration for the Sphinx documentation builder.
# All configuration specific to our project should be done in this file.
#
# 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

project = "MicroCeph"
author = "Canonical Ltd."


# Sidebar documentation title; best kept reasonably short
#
# To include a version number, add it here (hardcoded or automated).
#
# To disable the title, set to an empty string.

html_title = project + " documentation"


# Copyright string; shown at the bottom of the page
#
# Now, the starter pack uses CC-BY-SA as the license
# and the current year as the copyright year.
#
# If your docs need another license, specify it instead of 'CC-BY-SA'.
#
# If your documentation is a part of the code repository of your project,
# it inherits the code license instead; specify it instead of 'CC-BY-SA'.
#
# NOTE: For static works, it is common to provide the first publication year.
#       Another option is to provide both the first year of publication
#       and the current year, especially for docs that frequently change,
#       e.g. 2022–2023 (note the en-dash).
#
#       A way to check a repo's creation date is to get a classic GitHub token
#       with 'repo' permissions; see https://github.com/settings/tokens
#       Next, use 'curl' and 'jq' to extract the date from the API's output:
#
#       curl -H 'Authorization: token <TOKEN>' \
#         -H 'Accept: application/vnd.github.v3.raw' \
#         https://api.github.com/repos/canonical/<REPO> | jq '.created_at'

copyright = "%s AGPL-3.0, %s" % (datetime.date.today().year, author)


# Documentation website URL
#
# Update with the official URL of your docs or leave empty if unsure.
#
# NOTE: The Open Graph Protocol (OGP) enhances page display in a social graph
#       and is used by social media platforms; see https://ogp.me/

ogp_site_url = "https://canonical-microceph.readthedocs-hosted.com/"


# Preview name of the documentation website
#
# To use a different name for the project in previews, update as needed.

ogp_site_name = project


# Preview image URL
#
# 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.

# 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
    #
    # 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": "",
    # Product tag image; the orange part of your logo, shown in the page header
    #
    # To add a tag image, uncomment and update as needed.
    # 'product_tag': '_static/tag.png',
    # Your Discourse instance URL
    #
    # Change to your Discourse instance URL or leave empty.
    #
    # If set, adding ':discourse: 123' to an .rst file
    #       will add a link to Discourse topic 123 at the bottom of the page.
    "discourse": "",
    # Your Mattermost channel URL
    #
    # Change to your Mattermost channel URL or leave empty.
    "mattermost": "https://chat.canonical.com/canonical/channels/ceph",
    # Your Matrix channel URL
    #
    # Change to your Matrix channel URL or leave empty.
    "matrix": "https://matrix.to/#/#ceph-general:ubuntu.com",
    # Your documentation GitHub repository URL
    #
    # 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/microceph",
    # Docs branch in the repo; used in links for viewing the source files
    #
    # 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
    #


    # To customise the directory, uncomment and update as needed.
    "repo_folder": "/docs/",
    # To enable or disable the Previous / Next buttons at the bottom of pages
    # Valid options: none, prev, next, both
    "sequential_nav": "both",
    # To enable listing contributors on individual pages, set to True
    "display_contributors": True,

    # Required for feedback button    
    'github_issues': 'enabled',
}

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

# Project slug; see https://meta.discourse.org/t/what-is-category-slug/87897
#
# If your documentation is hosted on https://docs.ubuntu.com/,
# uncomment and update as needed.

# slug = ''

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

# Base URL of RTD hosted project

html_baseurl = 'https://canonical-microceph.readthedocs-hosted.com/'

# URL scheme. Add language and version scheme elements.
# When configured with RTD variables, check for RTD environment so manual runs succeed:

if 'READTHEDOCS_VERSION' in os.environ:
    version = os.environ["READTHEDOCS_VERSION"]
    sitemap_url_scheme = '{version}{link}'
else:
    sitemap_url_scheme = 'MANUAL/{link}'

# Template and asset locations

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


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

# To set up redirects: https://documatt.gitlab.io/sphinx-reredirects/usage.html
# For example: 'explanation/old-name.html': '../how-to/prettify.html',

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

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

redirects = {}


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

# A regex list of URLs that are ignored by 'make linkcheck'
#
# Remove or adjust the ACME entry after you update the contributing guide

linkcheck_ignore = [
    "http://127.0.0.1:8000",
    "https://github.com/canonical/ACME/*",
    "https://app.element.io/#/room/#ceph-general:ubuntu.com",
    "https://matrix.to/#/#documentation:ubuntu.com"
    ]

# A regex list of URLs where anchors are ignored by 'make linkcheck'

linkcheck_anchors_ignore_for_url = [
    r"https://github\.com/.*",
    r"https://app.element.io/#/room/#ceph-general:ubuntu.com",
    r"https://matrix.to/#/#documentation:ubuntu.com"
    ]

# give linkcheck multiple tries on failure
# linkcheck_timeout = 30
linkcheck_retries = 3

########################
# Configuration extras #
########################

# Custom MyST syntax extensions; see
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
#
# NOTE: By default, the following MyST extensions are enabled:
#       substitution, deflist, linkify

# myst_enable_extensions = set()


# Custom Sphinx extensions; see
# https://www.sphinx-doc.org/en/master/usage/extensions/index.html

# NOTE: The canonical_sphinx extension is required for the starter pack.
#       It automatically enables the following extensions:
#       - custom-rst-roles
#       - myst_parser
#       - notfound.extension
#       - related-links
#       - sphinx_copybutton
#       - sphinx_design
#       - sphinx_reredirects
#       - sphinx_tabs.tabs
#       - sphinxcontrib.jquery
#       - sphinxext.opengraph
#       - terminal-output
#       - youtube-links

extensions = [
    "canonical_sphinx",
    "sphinxcontrib.cairosvgconverter",
    "sphinx_last_updated_by_git",
    "sphinx.ext.intersphinx",
    "sphinx_sitemap",
]

# Excludes files or directories from processing

exclude_patterns = [
    "doc-cheat-sheet*",
]

# Adds custom CSS files, located under 'html_static_path'

# html_css_files = []


# Adds custom JavaScript files, located under 'html_static_path'

# html_js_files = []


# Specifies a reST snippet to be appended to each .rst file

rst_epilog = """
.. include:: /reuse/links.txt
.. include:: /reuse/substitutions.txt
"""

# Feedback button at the top; enabled by default
#
# To disable the button, uncomment this.

# disable_feedback_button = True


# Your manpage URL
#
# 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"] = html_context["discourse"] + "/t/"

# Workaround for substitutions.yaml

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

# Add configuration for intersphinx mapping

# intersphinx_mapping = {
#    'starter-pack': ('https://canonical-example-product-documentation.readthedocs-hosted.com/en/latest', None)
#}

[rtd-command-info] start-time: 2025-08-07T13:06:14.745886Z, end-time: 2025-08-07T13:06:19.703186Z, duration: 4, exit-code: 0
python -m sphinx -T -W --keep-going -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html
Running Sphinx v8.2.3
loading translations [en]... done
sphinx_design found.
sphinx_design is now configured.
sphinx_tabs.tabs found.
sphinx_tabs.tabs is now configured.
sphinx_reredirects found.
sphinx_reredirects is now configured.
canonical.youtube-links found.
canonical.youtube-links is now configured.
canonical.related-links found.
canonical.related-links is now configured.
canonical.custom-rst-roles found.
canonical.custom-rst-roles is now configured.
canonical.terminal-output found.
canonical.terminal-output is now configured.
canonical.contributor-listing found.
canonical.contributor-listing is now configured.
sphinx_copybutton found.
sphinx_copybutton is now configured.
sphinxext.opengraph found.
sphinxext.opengraph is now configured.
sphinxcontrib.jquery found.
sphinxcontrib.jquery is now configured.
notfound.extension found.
notfound.extension is now configured.
sphinxcontrib.cairosvgconverter found.
sphinxcontrib.cairosvgconverter is now configured.
sphinx_last_updated_by_git found.
sphinx_last_updated_by_git is now configured.
matplotlib is not installed, social cards will not be generated
making output directory... done
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'substitution', 'deflist', 'linkify'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={version_number: ..., formatted_text: ..., site_link: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [dirhtml]: targets for 46 source files that are out of date
updating environment: [new config] 46 added, 0 changed, 0 removed
reading sources... [  2%] contributing/index
reading sources... [  4%] explanation/cluster-configurations
reading sources... [  7%] explanation/cluster-maintenance
reading sources... [  9%] explanation/cluster-scaling
reading sources... [ 11%] explanation/index
reading sources... [ 13%] explanation/microceph-charm
reading sources... [ 15%] explanation/security/cryptographic-approaches
reading sources... [ 17%] explanation/security/full-disk-encryption
reading sources... [ 20%] explanation/security/security-overview
reading sources... [ 22%] explanation/snap-content-interface
reading sources... [ 24%] explanation/taking-snapshots
reading sources... [ 26%] how-to/change-log-level
reading sources... [ 28%] how-to/configure-network-keys
reading sources... [ 30%] how-to/configure-rbd-mirroring
reading sources... [ 33%] how-to/enable-alerts
reading sources... [ 35%] how-to/enable-metrics
reading sources... [ 37%] how-to/enable-service-instances
reading sources... [ 39%] how-to/import-remote-cluster
reading sources... [ 41%] how-to/index
reading sources... [ 43%] how-to/integrate-keystone
reading sources... [ 46%] how-to/major-upgrade
reading sources... [ 48%] how-to/migrate-auto-services
reading sources... [ 50%] how-to/mount-block-device
reading sources... [ 52%] how-to/mount-cephfs-share
reading sources... [ 54%] how-to/multi-node
reading sources... [ 57%] how-to/perform-cluster-maintenance
reading sources... [ 59%] how-to/perform-site-failover
reading sources... [ 61%] how-to/rbd-client-cfg
reading sources... [ 63%] how-to/remove-disk
reading sources... [ 65%] how-to/single-node
reading sources... [ 67%] index
reading sources... [ 70%] reference/commands/client
reading sources... [ 72%] reference/commands/cluster
reading sources... [ 74%] reference/commands/disable
reading sources... [ 76%] reference/commands/disk
reading sources... [ 78%] reference/commands/enable
reading sources... [ 80%] reference/commands/help
reading sources... [ 83%] reference/commands/index
reading sources... [ 85%] reference/commands/init
reading sources... [ 87%] reference/commands/pool
reading sources... [ 89%] reference/commands/remote
reading sources... [ 91%] reference/commands/replication-rbd
reading sources... [ 93%] reference/commands/status
reading sources... [ 96%] reference/index
reading sources... [ 98%] reference/release-notes
reading sources... [100%] tutorial/get-started

getting Git timestamps for source files... [ 12%] contributing
getting Git timestamps for source files... [ 25%] explanation
getting Git timestamps for source files... [ 38%] explanation/security
getting Git timestamps for source files... [ 50%] how-to
getting Git timestamps for source files... [ 62%] .
getting Git timestamps for source files... [ 75%] reference/commands
getting Git timestamps for source files... [ 88%] reference
getting Git timestamps for source files... [100%] tutorial

getting Git timestamps for dependencies... [ 33%] reuse
getting Git timestamps for dependencies... [ 67%] explanation/assets
getting Git timestamps for dependencies... [100%] how-to/assets

looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... 
copying downloadable files... [100%] how-to/assets/prometheus_alerts.yaml

copying static files... 
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/html/_static/language_data.js
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/html/_static/basic.css
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/html/_static/documentation_options.js
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/html/_static/copybutton.js
copying static files: done
copying extra files... 
copying extra files: done
copying assets: done
writing output... [  2%] contributing/index
writing output... [  4%] explanation/cluster-configurations
writing output... [  7%] explanation/cluster-maintenance
writing output... [  9%] explanation/cluster-scaling
writing output... [ 11%] explanation/index
writing output... [ 13%] explanation/microceph-charm
writing output... [ 15%] explanation/security/cryptographic-approaches
writing output... [ 17%] explanation/security/full-disk-encryption
writing output... [ 20%] explanation/security/security-overview
writing output... [ 22%] explanation/snap-content-interface
writing output... [ 24%] explanation/taking-snapshots
writing output... [ 26%] how-to/change-log-level
writing output... [ 28%] how-to/configure-network-keys
writing output... [ 30%] how-to/configure-rbd-mirroring
writing output... [ 33%] how-to/enable-alerts
writing output... [ 35%] how-to/enable-metrics
writing output... [ 37%] how-to/enable-service-instances
writing output... [ 39%] how-to/import-remote-cluster
writing output... [ 41%] how-to/index
writing output... [ 43%] how-to/integrate-keystone
writing output... [ 46%] how-to/major-upgrade
writing output... [ 48%] how-to/migrate-auto-services
writing output... [ 50%] how-to/mount-block-device
writing output... [ 52%] how-to/mount-cephfs-share
writing output... [ 54%] how-to/multi-node
writing output... [ 57%] how-to/perform-cluster-maintenance
writing output... [ 59%] how-to/perform-site-failover
writing output... [ 61%] how-to/rbd-client-cfg
writing output... [ 63%] how-to/remove-disk
writing output... [ 65%] how-to/single-node
writing output... [ 67%] index
writing output... [ 70%] reference/commands/client
writing output... [ 72%] reference/commands/cluster
writing output... [ 74%] reference/commands/disable
writing output... [ 76%] reference/commands/disk
writing output... [ 78%] reference/commands/enable
writing output... [ 80%] reference/commands/help
writing output... [ 83%] reference/commands/index
writing output... [ 85%] reference/commands/init
writing output... [ 87%] reference/commands/pool
writing output... [ 89%] reference/commands/remote
writing output... [ 91%] reference/commands/replication-rbd
writing output... [ 93%] reference/commands/status
writing output... [ 96%] reference/index
writing output... [ 98%] reference/release-notes
writing output... [100%] tutorial/get-started

generating indices... genindex done
writing additional pages... search done
copying images... [ 25%] explanation/assets/flow.jpg
copying images... [ 50%] how-to/assets/alerts
copying images... [ 75%] how-to/assets/prometheus_microceph_scraping.jpg
copying images... [100%] how-to/assets/prometheus_console.jpg

dumping search index in English (code: en)... done
dumping object inventory... done
sphinx-sitemap: sitemap.xml was generated for URL https://canonical-microceph.readthedocs-hosted.com/ in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/html/sitemap.xml
build succeeded.

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

[rtd-command-info] start-time: 2025-08-07T13:06:19.805786Z, end-time: 2025-08-07T13:06:21.252813Z, duration: 1, exit-code: 0
python -m sphinx -T -b latex -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/pdf
Running Sphinx v8.2.3
loading translations [en]... done
sphinx_design found.
sphinx_design is now configured.
sphinx_tabs.tabs found.
sphinx_tabs.tabs is now configured.
sphinx_reredirects found.
sphinx_reredirects is now configured.
canonical.youtube-links found.
canonical.youtube-links is now configured.
canonical.related-links found.
canonical.related-links is now configured.
canonical.custom-rst-roles found.
canonical.custom-rst-roles is now configured.
canonical.terminal-output found.
canonical.terminal-output is now configured.
canonical.contributor-listing found.
canonical.contributor-listing is now configured.
sphinx_copybutton found.
sphinx_copybutton is now configured.
sphinxext.opengraph found.
sphinxext.opengraph is now configured.
sphinxcontrib.jquery found.
sphinxcontrib.jquery is now configured.
notfound.extension found.
notfound.extension is now configured.
sphinxcontrib.cairosvgconverter found.
sphinxcontrib.cairosvgconverter is now configured.
sphinx_last_updated_by_git found.
sphinx_last_updated_by_git is now configured.
matplotlib is not installed, social cards will not be generated
making output directory... done
loading pickled environment... The configuration has changed (4 options: 'html_css_files', 'html_js_files', 'html_static_path', 'pygments_dark_style')
done
myst v4.0.1: MdParserConfig(commonmark_only=False, gfm_only=False, enable_extensions={'deflist', 'substitution', 'linkify'}, disable_syntax=[], all_links_external=False, links_external_new_tab=False, url_schemes=('http', 'https', 'mailto', 'ftp'), ref_domains=None, fence_as_directive=set(), number_code_blocks=[], title_to_header=False, heading_anchors=0, heading_slug_func=None, html_meta={}, footnote_sort=True, footnote_transition=True, words_per_minute=200, substitutions={version_number: ..., formatted_text: ..., site_link: ...}, linkify_fuzzy_links=True, dmath_allow_labels=True, dmath_allow_space=True, dmath_allow_digits=True, dmath_double_inline=False, update_mathjax=True, mathjax_classes='tex2jax_process|mathjax_process|math|output_area', enable_checkboxes=False, suppress_warnings=[], highlight_code_blocks=True)
building [mo]: targets for 0 po files that are out of date
writing output... 
building [latex]: all documents
updating environment: 0 added, 0 changed, 0 removed
reading sources... 
getting Git timestamps for source files... 
getting Git timestamps for dependencies... 
looking for now-outdated files... none found
preparing documents... done
copying assets... 
copying TeX support files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/pdf/latexmkrc
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/pdf/Makefile
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/pdf/make.bat
Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/pdf/latexmkjarc
done
copying assets: done
processing microceph.tex... 
index
 tutorial/get-started
  how-to/index
   how-to/single-node
   how-to/multi-node
    how-to/rbd-client-cfg
    how-to/integrate-keystone
    how-to/configure-network-keys
    how-to/enable-metrics
    how-to/enable-alerts
    how-to/enable-service-instances
     how-to/change-log-level
     how-to/migrate-auto-services
     how-to/remove-disk
     how-to/perform-cluster-maintenance
      how-to/import-remote-cluster
      how-to/configure-rbd-mirroring
      how-to/perform-site-failover
       how-to/major-upgrade
        how-to/mount-block-device
        how-to/mount-cephfs-share
  reference/index
   reference/commands/index
    reference/commands/client
    reference/commands/cluster
    reference/commands/disable
    reference/commands/disk
    reference/commands/enable
    reference/commands/help
    reference/commands/init
    reference/commands/pool
    reference/commands/remote
    reference/commands/replication-rbd
    reference/commands/status
    reference/release-notes
  explanation/index
   explanation/cluster-configurations
   explanation/cluster-maintenance
   explanation/cluster-scaling
   explanation/taking-snapshots
    explanation/snap-content-interface
     explanation/microceph-charm
      explanation/security/security-overview
       explanation/security/cryptographic-approaches
       explanation/security/full-disk-encryption
  contributing/index

resolving references...
processing microceph.tex: done
writing... done
copying images... [ 25%] how-to/assets/prometheus_microceph_scraping.jpg
copying images... [ 50%] how-to/assets/prometheus_console.jpg
copying images... [ 75%] how-to/assets/alerts
copying images... [100%] explanation/assets/flow.jpg

Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/checkouts/latest/_readthedocs/pdf/sphinxmessages.sty
sphinx-sitemap: No pages generated for sitemap.xml
build succeeded.

The LaTeX files are in ../_readthedocs/pdf.
Run 'make' in that directory to run these through (pdf)latex
(use `make latexpdf' here to do that automatically).

[rtd-command-info] start-time: 2025-08-07T13:06:23.361290Z, end-time: 2025-08-07T13:06:23.407308Z, duration: 0, exit-code: 0
cat latexmkrc
$latex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
$pdflatex = 'xelatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
$lualatex = 'lualatex ' . $ENV{'LATEXOPTS'} . ' %O %S';
$xelatex = 'xelatex --no-pdf ' . $ENV{'LATEXOPTS'} . ' %O %S';
$makeindex = 'internal xindy ' . $ENV{'XINDYOPTS'} . ' %O -o %D %S';
sub xindy {
  my @args = @_;
  if (-z $args[-1]) {
    # create an empty .ind file if .idx is empty
    open(FH, ">" . $args[-2]);
    close(FH);
    return 0;
  } else {
    return system("xindy", @args);
  }
}
add_cus_dep( "glo", "gls", 0, "makeglo" );
sub makeglo {
 return system( "makeindex -s gglo.ist -o '$_[0].gls' '$_[0].glo'" );
}

[rtd-command-info] start-time: None, end-time: None, duration: None, exit-code: None
latexmk -r latexmkrc -pdf -f -dvi- -ps- -jobname=canonical-microceph -interaction=nonstopmode