Read the Docs build information Build id: 1327420 Project: canonical-microceph Version: latest Commit: af7a27fd816b35b34b3582bce69fa14118d78469 Date: 2023-03-02T19:06:28.238155Z State: finished Success: True [rtd-command-info] start-time: 2023-03-02T19:06:50.855561Z, end-time: 2023-03-02T19:06:51.480958Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/canonical/microceph.git . Cloning into '.'... [rtd-command-info] start-time: 2023-03-02T19:06:51.679385Z, end-time: 2023-03-02T19:06:51.753699Z, 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 Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at af7a27f Merge pull request #96 from ChrisMacNaughton/feature/ceph-dashboard [rtd-command-info] start-time: 2023-03-02T19:06:51.969162Z, end-time: 2023-03-02T19:06:52.040699Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-03-02T19:06:53.107122Z, end-time: 2023-03-02T19:06:57.602601Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2023-03-02T19:06:57.799693Z, end-time: 2023-03-02T19:06:59.610547Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools<58.3.0 Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (23.0.1) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 946.1/946.1 kB 24.4 MB/s eta 0:00:00 Installing collected packages: setuptools Attempting uninstall: setuptools Found existing installation: setuptools 67.4.0 Uninstalling setuptools-67.4.0: Successfully uninstalled setuptools-67.4.0 Successfully installed setuptools-58.2.0 [rtd-command-info] start-time: 2023-03-02T19:06:59.799282Z, end-time: 2023-03-02T19:07:07.325770Z, duration: 7, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.3 Collecting pillow Downloading Pillow-9.4.0-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (3.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.3/3.3 MB 52.7 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 238.3 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 163.2 MB/s eta 0:00:00 Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading sphinx-5.3.0-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 186.0 MB/s eta 0:00:00 Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.2.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 184.2 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Downloading readthedocs_sphinx_ext-2.2.0-py2.py3-none-any.whl (11 kB) Collecting docutils>=0.11 Downloading docutils-0.19-py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.5/570.5 kB 238.6 MB/s eta 0:00:00 Collecting snowballstemmer>=2.0 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 190.2 MB/s eta 0:00:00 Collecting babel>=2.9 Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 168.0 MB/s eta 0:00:00 Collecting requests>=2.5.0 Downloading requests-2.28.2-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.8/62.8 kB 179.4 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 180.8 MB/s eta 0:00:00 Collecting Jinja2>=3.0 Downloading Jinja2-3.1.2-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.1/133.1 kB 208.8 MB/s eta 0:00:00 Collecting Pygments>=2.12 Downloading Pygments-2.14.0-py3-none-any.whl (1.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.1/1.1 MB 231.4 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 kB 199.7 MB/s eta 0:00:00 Collecting packaging>=21.0 Downloading packaging-23.0-py3-none-any.whl (42 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 42.7/42.7 kB 162.5 MB/s eta 0:00:00 Collecting importlib-metadata>=4.8 Downloading importlib_metadata-6.0.0-py3-none-any.whl (21 kB) Collecting imagesize>=1.3 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 kB 221.4 MB/s eta 0:00:00 Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 kB 190.9 MB/s eta 0:00:00 Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 kB 197.8 MB/s eta 0:00:00 Collecting docutils>=0.11 Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 570.0/570.0 kB 240.1 MB/s eta 0:00:00 Collecting sphinxcontrib-jquery!=3.0.0,>=2.0.0 Downloading sphinxcontrib_jquery-2.0.0-py3-none-any.whl (3.2 kB) Collecting pytz>=2015.7 Downloading pytz-2022.7.1-py2.py3-none-any.whl (499 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 499.4/499.4 kB 227.5 MB/s eta 0:00:00 Collecting zipp>=0.5 Downloading zipp-3.15.0-py3-none-any.whl (6.8 kB) Collecting typing-extensions>=3.6.4 Downloading typing_extensions-4.5.0-py3-none-any.whl (27 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.2-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.14-py2.py3-none-any.whl (140 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 140.6/140.6 kB 213.2 MB/s eta 0:00:00 Collecting charset-normalizer<4,>=2 Downloading charset_normalizer-3.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (170 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 170.5/170.5 kB 199.7 MB/s eta 0:00:00 Collecting idna<4,>=2.5 Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 154.9 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 Downloading certifi-2022.12.7-py3-none-any.whl (155 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 155.3/155.3 kB 218.2 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinxcontrib-jquery!=3.0.0,>=2.0.0->sphinx-rtd-theme) (58.2.0) Building wheels for collected packages: mock Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=0a88099be088acba688b60b85f938462696a026167aa3c51a67513bb24ed3413 Stored in directory: /tmp/pip-ephem-wheel-cache-8o24k23y/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Successfully built mock Installing collected packages: snowballstemmer, pytz, mock, commonmark, charset-normalizer, zipp, urllib3, typing-extensions, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-jquery, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, certifi, babel, alabaster, requests, Jinja2, importlib-metadata, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed Jinja2-3.1.2 MarkupSafe-2.1.2 Pygments-2.14.0 alabaster-0.7.13 babel-2.12.1 certifi-2022.12.7 charset-normalizer-3.0.1 commonmark-0.9.1 docutils-0.18.1 idna-3.4 imagesize-1.4.1 importlib-metadata-6.0.0 mock-1.0.1 packaging-23.0 pillow-9.4.0 pytz-2022.7.1 readthedocs-sphinx-ext-2.2.0 recommonmark-0.5.0 requests-2.28.2 snowballstemmer-2.2.0 sphinx-5.3.0 sphinx-rtd-theme-1.2.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jquery-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 typing-extensions-4.5.0 urllib3-1.26.14 zipp-3.15.0 [rtd-command-info] start-time: 2023-03-02T19:07:07.546708Z, end-time: 2023-03-02T19:07:09.953741Z, duration: 2, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Requirement already satisfied: sphinx in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from -r docs/requirements.txt (line 1)) (5.3.0) Collecting sphinx-autobuild Downloading sphinx_autobuild-2021.3.14-py3-none-any.whl (9.9 kB) Collecting sphinx-design Downloading sphinx_design-0.3.0-py3-none-any.whl (2.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 47.9 MB/s eta 0:00:00 Collecting pyenchant Downloading pyenchant-3.2.2-py3-none-any.whl (55 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 55.7/55.7 kB 161.2 MB/s eta 0:00:00 Requirement already satisfied: pygments in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from -r docs/requirements.txt (line 5)) (2.14.0) Collecting sphinxcontrib-spelling Downloading sphinxcontrib_spelling-8.0.0-py3-none-any.whl (16 kB) Collecting furo Downloading furo-2022.12.7-py3-none-any.whl (328 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 328.7/328.7 kB 229.7 MB/s eta 0:00:00 Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: importlib-metadata>=4.8 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (6.0.0) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.0.3) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: docutils<0.20,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (0.18.1) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: Jinja2>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (3.1.2) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (2.12.1) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.4.1) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (1.1.5) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (2.28.2) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (0.7.13) Requirement already satisfied: packaging>=21.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from sphinx->-r docs/requirements.txt (line 1)) (23.0) Collecting colorama Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB) Collecting livereload Downloading livereload-2.6.3-py2.py3-none-any.whl (24 kB) Collecting beautifulsoup4 Downloading beautifulsoup4-4.11.2-py3-none-any.whl (129 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 129.4/129.4 kB 202.3 MB/s eta 0:00:00 Collecting sphinx-basic-ng Downloading sphinx_basic_ng-1.0.0b1-py3-none-any.whl (22 kB) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from babel>=2.9->sphinx->-r docs/requirements.txt (line 1)) (2022.7.1) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx->-r docs/requirements.txt (line 1)) (3.15.0) Requirement already satisfied: typing-extensions>=3.6.4 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from importlib-metadata>=4.8->sphinx->-r docs/requirements.txt (line 1)) (4.5.0) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from Jinja2>=3.0->sphinx->-r docs/requirements.txt (line 1)) (2.1.2) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/requirements.txt (line 1)) (2022.12.7) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/requirements.txt (line 1)) (3.4) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/requirements.txt (line 1)) (1.26.14) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/canonical-microceph/envs/latest/lib/python3.7/site-packages (from requests>=2.5.0->sphinx->-r docs/requirements.txt (line 1)) (3.0.1) Collecting soupsieve>1.2 Downloading soupsieve-2.4-py3-none-any.whl (37 kB) Collecting six Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting tornado Downloading tornado-6.2-cp37-abi3-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (423 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 424.0/424.0 kB 230.9 MB/s eta 0:00:00 Installing collected packages: tornado, soupsieve, six, pyenchant, colorama, livereload, beautifulsoup4, sphinxcontrib-spelling, sphinx-design, sphinx-basic-ng, sphinx-autobuild, furo Successfully installed beautifulsoup4-4.11.2 colorama-0.4.6 furo-2022.12.7 livereload-2.6.3 pyenchant-3.2.2 six-1.16.0 soupsieve-2.4 sphinx-autobuild-2021.3.14 sphinx-basic-ng-1.0.0b1 sphinx-design-0.3.0 sphinxcontrib-spelling-8.0.0 tornado-6.2 [rtd-command-info] start-time: 2023-03-02T19:07:11.549912Z, end-time: 2023-03-02T19:07:11.619872Z, duration: 0, exit-code: 0 cat docs/conf.py # Configuration file for the Sphinx documentation builder. # # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Microceph' copyright = '2022-2023, Canonical Group Ltd' author = 'Chris MacNaughton' # release = '1.0' # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = ['sphinx_design'] templates_path = ['_templates'] exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'sphinxenv'] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output html_theme = 'furo' # html_static_path = ['_static'] ########################################################################### # 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') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} # This following legacy behavior will gradually be sliced out until its deprecated and removed. # Skipped for Sphinx 6+ # Skipped by internal Feature flag SKIP_SPHINX_HTML_THEME_PATH # Skipped by all new projects since SKIP_SPHINX_HTML_THEME_PATH's introduction (jan 2023) if ( using_rtd_theme and version_info < (6,0) and not False ): theme = importlib.import_module('sphinx_rtd_theme') if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] # Define websupport2_base_url and websupport2_static_url if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, '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/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'canonical-microceph', 'name': u'microceph', 'rtd_language': u'en', 'programming_language': u'go', 'canonical_url': 'https://canonical-microceph.readthedocs-hosted.com/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'canonical', 'proxied_api_host': '/_', 'github_repo': 'microceph', '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': 'af7a27fd', } # 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(): html_context.update(context) 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-microceph/builds/1327420/' 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']) [rtd-command-info] start-time: 2023-03-02T19:07:11.810202Z, end-time: 2023-03-02T19:07:12.844813Z, duration: 1, exit-code: 0 python -m sphinx -T -E -W --keep-going -b dirhtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v5.3.0 making output directory... done building [mo]: targets for 0 po files that are out of date building [dirhtml]: targets for 8 source files that are out of date updating environment: [new config] 8 added, 0 changed, 0 removed reading sources... [ 12%] explanation/index reading sources... [ 25%] how-to/index reading sources... [ 37%] index reading sources... [ 50%] reference/index reading sources... [ 62%] tutorial/add_osds reading sources... [ 75%] tutorial/index reading sources... [ 87%] tutorial/initial_setup reading sources... [100%] tutorial/install looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 12%] explanation/index writing output... [ 25%] how-to/index writing output... [ 37%] index writing output... [ 50%] reference/index writing output... [ 62%] tutorial/add_osds writing output... [ 75%] tutorial/index writing output... [ 87%] tutorial/initial_setup writing output... [100%] tutorial/install generating indices... genindex done writing additional pages... search done copying static files... done copying extra files... done dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded. The HTML pages are in ../_readthedocs/html.