Read the Docs build information Build id: 2633622 Project: continuumio-conda-docs Version: main Commit: 2da1a3203610d2f828e7863bd0b666bfb3f1c857 Date: 2024-11-21T18:21:03.607381Z State: finished Success: True [rtd-command-info] start-time: 2024-11-21T18:21:04.886055Z, end-time: 2024-11-21T18:21:05.390074Z, duration: 0, exit-code: 0 git clone --depth 1 https://github.com/conda/conda-docs . Cloning into '.'... [rtd-command-info] start-time: 2024-11-21T18:21:05.477653Z, end-time: 2024-11-21T18:21:05.893629Z, 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-11-21T18:21:06.038565Z, end-time: 2024-11-21T18:21:06.110756Z, 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 2da1a32 🤖 Update infrastructure file(s) (#963) [rtd-command-info] start-time: 2024-11-21T18:21:06.195558Z, end-time: 2024-11-21T18:21:06.261385Z, duration: 0, exit-code: 0 cat .readthedocs.yml version: 2 # Set build image and Python version build: os: ubuntu-22.04 tools: python: "3" python: install: - requirements: requirements.txt # Additional (downloadable) formats of the documentation to be built, apart # from the default HTML. formats: - htmlzip [rtd-command-info] start-time: 2024-11-21T18:21:12.723533Z, end-time: 2024-11-21T18:21:12.808918Z, duration: 0, exit-code: 0 asdf global python 3.13.0 [rtd-command-info] start-time: 2024-11-21T18:21:13.215491Z, end-time: 2024-11-21T18:21:14.453074Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.13.0.final.0-64 in 851ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main, 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-11-21T18:21:14.548649Z, end-time: 2024-11-21T18:21:32.432748Z, duration: 17, 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/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (23.1) Collecting pip Downloading pip-24.3.1-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 9.1 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (67.6.1) Collecting setuptools Downloading setuptools-75.6.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 16.2 MB/s eta 0:00:00 Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 67.6.1 Uninstalling setuptools-67.6.1: Successfully uninstalled setuptools-67.6.1 Attempting uninstall: pip Found existing installation: pip 23.1 Uninstalling pip-23.1: Successfully uninstalled pip-23.1 Successfully installed pip-24.3.1 setuptools-75.6.0 [rtd-command-info] start-time: 2024-11-21T18:21:32.508003Z, end-time: 2024-11-21T18:21:44.623083Z, duration: 12, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx Collecting sphinx Downloading sphinx-8.1.3-py3-none-any.whl.metadata (6.4 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.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.17 (from sphinx) Downloading pygments-2.18.0-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-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.13 (from sphinx) Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 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.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=23.0 (from sphinx) Downloading packaging-24.2-py3-none-any.whl.metadata (3.2 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.1->sphinx) Downloading MarkupSafe-3.0.2-cp313-cp313-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.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (34 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.2.3-py3-none-any.whl.metadata (6.5 kB) Collecting certifi>=2017.4.17 (from requests>=2.30.0->sphinx) Downloading certifi-2024.8.30-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-8.1.3-py3-none-any.whl (3.5 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.5/3.5 MB 91.4 MB/s eta 0:00:00 Downloading alabaster-1.0.0-py3-none-any.whl (13 kB) Downloading babel-2.16.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 148.6 MB/s eta 0:00:00 Downloading docutils-0.21.2-py3-none-any.whl (587 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 587.4/587.4 kB 272.9 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) Downloading packaging-24.2-py3-none-any.whl (65 kB) Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 316.9 MB/s eta 0:00:00 Downloading requests-2.32.3-py3-none-any.whl (64 kB) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 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) Downloading certifi-2024.8.30-py3-none-any.whl (167 kB) Downloading charset_normalizer-3.4.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (144 kB) Downloading idna-3.10-py3-none-any.whl (70 kB) Downloading MarkupSafe-3.0.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (23 kB) Downloading urllib3-2.2.3-py3-none-any.whl (126 kB) 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 Successfully installed Jinja2-3.1.4 MarkupSafe-3.0.2 Pygments-2.18.0 alabaster-1.0.0 babel-2.16.0 certifi-2024.8.30 charset-normalizer-3.4.0 docutils-0.21.2 idna-3.10 imagesize-1.4.1 packaging-24.2 requests-2.32.3 snowballstemmer-2.2.0 sphinx-8.1.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.2.3 [rtd-command-info] start-time: 2024-11-21T18:21:44.721807Z, end-time: 2024-11-21T18:21:48.938123Z, duration: 4, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r requirements.txt Collecting conda-sphinx-theme==0.2.2 (from -r requirements.txt (line 1)) Downloading conda_sphinx_theme-0.2.2-py3-none-any.whl.metadata (2.9 kB) Collecting sphinx-sitemap==2.2.0 (from -r requirements.txt (line 2)) Downloading sphinx-sitemap-2.2.0.tar.gz (6.1 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting sphinx-design (from -r requirements.txt (line 3)) Downloading sphinx_design-0.6.1-py3-none-any.whl.metadata (5.5 kB) Collecting sphinx-reredirects (from -r requirements.txt (line 4)) Downloading sphinx_reredirects-0.1.5-py3-none-any.whl.metadata (2.6 kB) Collecting pydata-sphinx-theme<0.16.0,>=0.13.1 (from conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading pydata_sphinx_theme-0.15.4-py3-none-any.whl.metadata (7.5 kB) Collecting sphinx-favicon (from conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading sphinx_favicon-1.0.1-py3-none-any.whl.metadata (5.2 kB) Collecting six (from sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) Downloading six-1.16.0-py2.py3-none-any.whl.metadata (1.8 kB) Requirement already satisfied: sphinx>=1.2 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (8.1.3) Collecting beautifulsoup4 (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading beautifulsoup4-4.12.3-py3-none-any.whl.metadata (3.8 kB) Requirement already satisfied: docutils!=0.17.0 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) (0.21.2) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) (24.2) Requirement already satisfied: Babel in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) (2.16.0) Requirement already satisfied: pygments>=2.7 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) (2.18.0) Collecting accessible-pygments (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading accessible_pygments-0.0.5-py3-none-any.whl.metadata (10 kB) Collecting typing-extensions (from pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading typing_extensions-4.12.2-py3-none-any.whl.metadata (3.0 kB) Requirement already satisfied: sphinxcontrib-applehelp>=1.0.7 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.0.0) Requirement already satisfied: sphinxcontrib-devhelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.0.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.1.0) Requirement already satisfied: sphinxcontrib-jsmath>=1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp>=1.0.6 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.0.0) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.9 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.0.0) Requirement already satisfied: Jinja2>=3.1 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (3.1.4) Requirement already satisfied: snowballstemmer>=2.2 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.2.0) Requirement already satisfied: alabaster>=0.7.14 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (1.0.0) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (1.4.1) Requirement already satisfied: requests>=2.30.0 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.32.3) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from Jinja2>=3.1->sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (3.0.2) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from requests>=2.30.0->sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (3.4.0) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from requests>=2.30.0->sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (3.10) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from requests>=2.30.0->sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2.2.3) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages (from requests>=2.30.0->sphinx>=1.2->sphinx-sitemap==2.2.0->-r requirements.txt (line 2)) (2024.8.30) Collecting soupsieve>1.2 (from beautifulsoup4->pydata-sphinx-theme<0.16.0,>=0.13.1->conda-sphinx-theme==0.2.2->-r requirements.txt (line 1)) Downloading soupsieve-2.6-py3-none-any.whl.metadata (4.6 kB) Downloading conda_sphinx_theme-0.2.2-py3-none-any.whl (489 kB) Downloading sphinx_design-0.6.1-py3-none-any.whl (2.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.2/2.2 MB 110.8 MB/s eta 0:00:00 Downloading sphinx_reredirects-0.1.5-py3-none-any.whl (5.7 kB) Downloading pydata_sphinx_theme-0.15.4-py3-none-any.whl (4.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.6/4.6 MB 192.3 MB/s eta 0:00:00 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Downloading sphinx_favicon-1.0.1-py3-none-any.whl (7.0 kB) Downloading accessible_pygments-0.0.5-py3-none-any.whl (1.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.4/1.4 MB 313.0 MB/s eta 0:00:00 Downloading beautifulsoup4-4.12.3-py3-none-any.whl (147 kB) Downloading typing_extensions-4.12.2-py3-none-any.whl (37 kB) Downloading soupsieve-2.6-py3-none-any.whl (36 kB) Building wheels for collected packages: sphinx-sitemap Building wheel for sphinx-sitemap (setup.py): started Building wheel for sphinx-sitemap (setup.py): finished with status 'done' Created wheel for sphinx-sitemap: filename=sphinx_sitemap-2.2.0-py3-none-any.whl size=6044 sha256=f0b9461c092efa0ea279b11fb3f5fd672772e426fb6653e42cb637eea18b3760 Stored in directory: /tmp/pip-ephem-wheel-cache-9dvkj2dj/wheels/62/fa/c1/4f99fd2cdc64e492acbc7f00321b8f2177ec7e9892e65b5742 Successfully built sphinx-sitemap Installing collected packages: typing-extensions, soupsieve, six, accessible-pygments, beautifulsoup4, sphinx-sitemap, sphinx-reredirects, sphinx-favicon, sphinx-design, pydata-sphinx-theme, conda-sphinx-theme Successfully installed accessible-pygments-0.0.5 beautifulsoup4-4.12.3 conda-sphinx-theme-0.2.2 pydata-sphinx-theme-0.15.4 six-1.16.0 soupsieve-2.6 sphinx-design-0.6.1 sphinx-favicon-1.0.1 sphinx-reredirects-0.1.5 sphinx-sitemap-2.2.0 typing-extensions-4.12.2 [rtd-command-info] start-time: 2024-11-21T18:21:49.144981Z, end-time: 2024-11-21T18:21:49.221487Z, duration: 0, exit-code: 0 cat docs/source/conf.py # # (c) 2012-2017 Anaconda, Inc. / https://www.anaconda.com # All Rights Reserved # # conda is distributed under the terms of the BSD 3-clause license. # Consult LICENSE.txt or http://opensource.org/licenses/BSD-3-Clause. # # conda documentation build configuration file, created by # sphinx-quickstart on Sat Nov 3 16:08:12 2012. # # This file is execfile()d with the current directory set to its containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. import os import sys # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. sys.path.insert(0, os.path.abspath("../..")) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ "sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinx.ext.graphviz", "sphinx.ext.ifconfig", "sphinx.ext.inheritance_diagram", # 'sphinx.ext.napoleon', "sphinx_sitemap", "sphinx_design", "sphinx_reredirects", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix of source filenames. source_suffix = ".rst" # The encoding of source files. # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = "index" # General information about the project. project = "conda-docs" copyright = "2017, Anaconda, Inc." # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. version = " " # The full version, including alpha/beta/rc tags. release = " " # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # today = '' # Else, today_fmt is used as the format for a strftime call. # today_fmt = '%B %d, %Y' # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all documents. # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" # A list of ignored prefixes for module index sorting. modindex_common_prefix = ["conda."] # -- Options for HTML output --------------------------------------------------- # html_additional_pages = {"index": "index.html"} # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # extensions += ['sphinxjp.themes.basicstrap'] # html_theme = 'basicstrap' html_theme = "conda_sphinx_theme" html_context = { "github_user": "conda", "github_repo": "conda-docs", "github_version": "main", "display_github": True, "source_suffix": ".rst", "doc_path": "docs/source", "goatcounter_dashboard_url": "https://docs-conda-io.goatcounter.com", } # Serving the robots.txt since we want to point to the sitemap.xml file html_extra_path = ["robots.txt"] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. html_theme_options = { "show_prev_next": False, "use_edit_page_button": True, "primary_sidebar_end": [], "github_url": "https://github.com/conda/conda-docs", "goatcounter_url": "https://docs-conda-io.goatcounter.com/count", "icon_links": [ { "name": "Element", "url": "https://matrix.to/#/#conda:matrix.org", "icon": "_static/element_logo.svg", "type": "local", }, { "name": "Discourse", "url": "https://conda.discourse.group/", "icon": "fa-brands fa-discourse", "type": "fontawesome", }, ], } # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". # html_title = None # A shorter title for the navigation bar. Default is the same as html_title. # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # html_favicon = None # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ["_static"] html_css_files = [ "css/custom.css", ] # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. # html_last_updated_fmt = '%b %d, %Y' # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # html_additional_pages = {} # If false, no module index is generated. # html_domain_indices = True # If false, no index is generated. # html_use_index = True # If true, the index is split into individual pages for each letter. # html_split_index = False # If true, links to the reST sources are added to the pages. # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Setting the prod URL of the site here as the base URL. html_baseurl = "https://docs.conda.io/" # We don't have a locale set, so we can safely ignore that for the sitemaps. sitemap_locales = [None] # We're hard-coding latest here since that's what we want Google to point to # and we don't have stable for conda-docs at the moment (no releases) sitemap_url_scheme = "{lang}latest/{link}" # Output file base name for HTML help builder. htmlhelp_basename = "condadoc" # -- Options for LaTeX output -------------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass [howto/manual]). latex_documents = [ ("index", "conda.tex", "conda Documentation", "Anaconda, Inc.", "manual"), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # latex_use_parts = False # If true, show page references after internal links. # latex_show_pagerefs = False # If true, show URL addresses after external links. # latex_show_urls = False # Documents to append as an appendix to all manuals. # latex_appendices = [] # If false, no module index is generated. # latex_domain_indices = True # -- Options for manual page output -------------------------------------------- # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [("index", "conda", "conda Documentation", ["Anaconda, Inc."], 1)] # If true, show URL addresses after external links. # man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ # Grouping the document tree into Texinfo files. List of tuples # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ ( "index", "conda", "conda Documentation", "Anaconda, Inc.", "conda", "One line description of project.", "Miscellaneous", ), ] # Documents to append as an appendix to all manuals. # texinfo_appendices = [] # If false, no module index is generated. # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # texinfo_show_urls = 'footnote' # -- For sphinx-reredirects ------------------------------------ redirects = { # External redirects "conda": "https://docs.conda.io/projects/conda/en/stable", "conda-build": "https://docs.conda.io/projects/conda-build/en/stable", "miniconda": "https://docs.anaconda.com/free/miniconda/", } [rtd-command-info] start-time: 2024-11-21T18:21:49.306411Z, end-time: 2024-11-21T18:21:50.861631Z, duration: 1, exit-code: 0 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v8.1.3 loading translations [en]... done making output directory... done Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`. [autosummary] generating autosummary for: announcements.rst, conda-build.rst, conda.rst, contributing.rst, get-involved.rst, help-support.rst, index.rst, intro.rst, license.rst, miniconda.rst, redirects.rst building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 11 source files that are out of date updating environment: [new config] 11 added, 0 changed, 0 removed reading sources... [ 9%] announcements reading sources... [ 18%] conda reading sources... [ 27%] conda-build reading sources... [ 36%] contributing reading sources... [ 45%] get-involved reading sources... [ 55%] help-support reading sources... [ 64%] index reading sources... [ 73%] intro reading sources... [ 82%] license reading sources... [ 91%] miniconda reading sources... [100%] redirects looking for now-outdated files... none found pickling environment... done checking consistency... /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/conda.rst: WARNING: document isn't included in any toctree /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/conda-build.rst: WARNING: document isn't included in any toctree /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/miniconda.rst: WARNING: document isn't included in any toctree /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/contributing.rst: document is referenced in multiple toctrees: ['index', 'redirects'], selecting: redirects <- contributing /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/help-support.rst: document is referenced in multiple toctrees: ['index', 'redirects'], selecting: redirects <- help-support /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/docs/source/license.rst: document is referenced in multiple toctrees: ['index', 'redirects'], selecting: redirects <- license done preparing documents... done copying assets... copying static files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/html/_static/basic.css Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/html/_static/language_data.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/html/_static/documentation_options.js copying static files: done copying extra files... copying extra files: done copying assets: done writing output... [ 9%] announcements writing output... [ 18%] conda writing output... [ 27%] conda-build writing output... [ 36%] contributing writing output... [ 45%] get-involved writing output... [ 55%] help-support writing output... [ 64%] index writing output... [ 73%] intro writing output... [ 82%] license writing output... [ 91%] miniconda writing output... [100%] redirects generating indices... genindex done Overwriting 'conda.html' with redirect to 'https://docs.conda.io/projects/conda/en/stable'. Overwriting 'conda-build.html' with redirect to 'https://docs.conda.io/projects/conda-build/en/stable'. Overwriting 'miniconda.html' with redirect to 'https://docs.anaconda.com/free/miniconda/'. writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages/sphinx_sitemap/__init__.py:172: RemovedInSphinx90Warning: Sphinx 9 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead. filename = app.outdir + "/" + app.config.sitemap_filename sitemap.xml was generated for URL https://docs.conda.io/ in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/html/sitemap.xml build succeeded, 3 warnings. The HTML pages are in ../../_readthedocs/html. [rtd-command-info] start-time: 2024-11-21T18:21:50.939282Z, end-time: 2024-11-21T18:21:52.129821Z, duration: 1, exit-code: 0 python -m sphinx -T -b singlehtml -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlzip Running Sphinx v8.1.3 loading translations [en]... done making output directory... done Converting `source_suffix = '.rst'` to `source_suffix = {'.rst': 'restructuredtext'}`. loading pickled environment... The configuration has changed (5 options: 'html_css_files', 'html_permalinks_icon', 'html_static_path', 'html_theme_options', 'templates_path') done [autosummary] generating autosummary for: announcements.rst, conda-build.rst, conda.rst, contributing.rst, get-involved.rst, help-support.rst, index.rst, intro.rst, license.rst, miniconda.rst, redirects.rst building [mo]: targets for 0 po files that are out of date writing output... building [singlehtml]: all documents updating environment: 0 added, 0 changed, 0 removed reading sources... looking for now-outdated files... none found preparing documents... done copying assets... copying static files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/basic.css Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/language_data.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/documentation_options.js copying static files: done copying extra files... copying extra files: done copying assets: done assembling single document... index help-support contributing license assembling single document: done writing... done writing additional files... done copying static files... Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/basic.css Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/language_data.js Writing evaluated template result to /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/_static/documentation_options.js copying static files: done copying extra files... copying extra files: done dumping object inventory... done /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/envs/main/lib/python3.13/site-packages/sphinx_sitemap/__init__.py:172: RemovedInSphinx90Warning: Sphinx 9 will drop support for representing paths as strings. Use "pathlib.Path" or "os.fspath" instead. filename = app.outdir + "/" + app.config.sitemap_filename sitemap.xml was generated for URL https://docs.conda.io/ in /home/docs/checkouts/readthedocs.org/user_builds/continuumio-conda-docs/checkouts/main/_readthedocs/htmlzip/sitemap.xml build succeeded. The HTML page is in ../../_readthedocs/htmlzip.