Read the Docs build information Build id: 2420544 Project: tiledb-inc-tiledb-py Version: 2039 Commit: 84b42e2e28800e3babc8fa38fddc28b665965043 Date: 2024-08-16T12:15:44.863313Z State: finished Success: True [rtd-command-info] start-time: 2024-08-16T12:15:45.956338Z, end-time: 2024-08-16T12:15:46.442254Z, duration: 0, exit-code: 0 git clone --depth 1 https://github.com/TileDB-Inc/TileDB-Py.git . Cloning into '.'... [rtd-command-info] start-time: 2024-08-16T12:15:46.523988Z, end-time: 2024-08-16T12:15:47.496822Z, duration: 0, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 pull/2039/head:external-2039 From https://github.com/TileDB-Inc/TileDB-Py * [new ref] refs/pull/2039/head -> external-2039 * [new tag] 0.30.0 -> 0.30.0 * [new tag] 0.30.1 -> 0.30.1 * [new tag] 0.30.2 -> 0.30.2 * [new tag] 0.31.0 -> 0.31.0 * [new tag] 0.31.1 -> 0.31.1 [rtd-command-info] start-time: 2024-08-16T12:15:47.626176Z, end-time: 2024-08-16T12:15:47.703219Z, duration: 0, exit-code: 0 git checkout --force 84b42e2e28800e3babc8fa38fddc28b665965043 Note: switching to '84b42e2e28800e3babc8fa38fddc28b665965043'. 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 84b42e2 Add .git-blame-ignore-revs [rtd-command-info] start-time: 2024-08-16T12:15:47.769128Z, end-time: 2024-08-16T12:15:47.819500Z, duration: 0, exit-code: 0 cat .readthedocs.yml # Don't build any extra formats formats: [] # Use RTD config version 2 # https://docs.readthedocs.io/en/stable/config-file/v2.html version: 2 # Set build OS to avoid build failures with old compiler build: os: "ubuntu-22.04" tools: python: "3.8" sphinx: configuration: doc/source/conf.py python: install: - method: pip path: . extra_requirements: - doc [rtd-command-info] start-time: 2024-08-16T12:15:52.761864Z, end-time: 2024-08-16T12:15:52.838372Z, duration: 0, exit-code: 0 asdf global python 3.8.19 [rtd-command-info] start-time: 2024-08-16T12:15:53.226727Z, end-time: 2024-08-16T12:15:54.477334Z, duration: 1, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.8.19.final.0-64 in 923ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039, 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-08-16T12:15:54.539011Z, end-time: 2024-08-16T12:16:06.636651Z, duration: 12, 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/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (23.1) Collecting pip Downloading pip-24.2-py3-none-any.whl (1.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.8/1.8 MB 8.4 MB/s eta 0:00:00 Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (67.6.1) Collecting setuptools Downloading setuptools-72.2.0-py3-none-any.whl (2.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.3/2.3 MB 21.3 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.2 setuptools-72.2.0 [rtd-command-info] start-time: 2024-08-16T12:16:06.711219Z, end-time: 2024-08-16T12:16:14.931398Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir sphinx readthedocs-sphinx-ext Collecting sphinx Downloading sphinx-7.1.2-py3-none-any.whl.metadata (5.8 kB) Collecting readthedocs-sphinx-ext Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl.metadata (1.5 kB) Collecting sphinxcontrib-applehelp (from sphinx) Downloading sphinxcontrib_applehelp-1.0.4-py3-none-any.whl.metadata (2.7 kB) Collecting sphinxcontrib-devhelp (from sphinx) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-jsmath (from sphinx) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl.metadata (1.4 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 (from sphinx) Downloading sphinxcontrib_htmlhelp-2.0.1-py3-none-any.whl.metadata (2.8 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 (from sphinx) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl.metadata (1.5 kB) Collecting sphinxcontrib-qthelp (from sphinx) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl.metadata (1.4 kB) Collecting Jinja2>=3.0 (from sphinx) Downloading jinja2-3.1.4-py3-none-any.whl.metadata (2.6 kB) Collecting Pygments>=2.13 (from sphinx) Downloading pygments-2.18.0-py3-none-any.whl.metadata (2.5 kB) Collecting docutils<0.21,>=0.18.1 (from sphinx) Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting snowballstemmer>=2.0 (from sphinx) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl.metadata (6.5 kB) Collecting babel>=2.9 (from sphinx) Downloading babel-2.16.0-py3-none-any.whl.metadata (1.5 kB) Collecting alabaster<0.8,>=0.7 (from sphinx) Downloading alabaster-0.7.13-py3-none-any.whl.metadata (3.0 kB) Collecting imagesize>=1.3 (from sphinx) Downloading imagesize-1.4.1-py2.py3-none-any.whl.metadata (1.5 kB) Collecting requests>=2.25.0 (from sphinx) Downloading requests-2.32.3-py3-none-any.whl.metadata (4.6 kB) Collecting packaging>=21.0 (from sphinx) Downloading packaging-24.1-py3-none-any.whl.metadata (3.2 kB) Collecting importlib-metadata>=4.8 (from sphinx) Downloading importlib_metadata-8.2.0-py3-none-any.whl.metadata (4.7 kB) Collecting pytz>=2015.7 (from babel>=2.9->sphinx) Downloading pytz-2024.1-py2.py3-none-any.whl.metadata (22 kB) Collecting zipp>=0.5 (from importlib-metadata>=4.8->sphinx) Downloading zipp-3.20.0-py3-none-any.whl.metadata (3.6 kB) Collecting MarkupSafe>=2.0 (from Jinja2>=3.0->sphinx) Downloading MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.25.0->sphinx) Downloading charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (33 kB) Collecting idna<4,>=2.5 (from requests>=2.25.0->sphinx) Downloading idna-3.7-py3-none-any.whl.metadata (9.9 kB) Collecting urllib3<3,>=1.21.1 (from requests>=2.25.0->sphinx) Downloading urllib3-2.2.2-py3-none-any.whl.metadata (6.4 kB) Collecting certifi>=2017.4.17 (from requests>=2.25.0->sphinx) Downloading certifi-2024.7.4-py3-none-any.whl.metadata (2.2 kB) Downloading sphinx-7.1.2-py3-none-any.whl (3.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.2/3.2 MB 131.0 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-2.2.5-py2.py3-none-any.whl (11 kB) Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Downloading babel-2.16.0-py3-none-any.whl (9.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 9.6/9.6 MB 253.2 MB/s eta 0:00:00 Downloading docutils-0.20.1-py3-none-any.whl (572 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 572.7/572.7 kB 341.7 MB/s eta 0:00:00 Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Downloading importlib_metadata-8.2.0-py3-none-any.whl (25 kB) Downloading jinja2-3.1.4-py3-none-any.whl (133 kB) Downloading packaging-24.1-py3-none-any.whl (53 kB) Downloading pygments-2.18.0-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 365.5 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_htmlhelp-2.0.1-py3-none-any.whl (99 kB) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Downloading sphinxcontrib_applehelp-1.0.4-py3-none-any.whl (120 kB) Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Downloading certifi-2024.7.4-py3-none-any.whl (162 kB) Downloading charset_normalizer-3.3.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (141 kB) Downloading idna-3.7-py3-none-any.whl (66 kB) Downloading MarkupSafe-2.1.5-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (26 kB) Downloading pytz-2024.1-py2.py3-none-any.whl (505 kB) Downloading urllib3-2.2.2-py3-none-any.whl (121 kB) Downloading zipp-3.20.0-py3-none-any.whl (9.4 kB) Installing collected packages: snowballstemmer, pytz, zipp, 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, importlib-metadata, sphinx, readthedocs-sphinx-ext Successfully installed Jinja2-3.1.4 MarkupSafe-2.1.5 Pygments-2.18.0 alabaster-0.7.13 babel-2.16.0 certifi-2024.7.4 charset-normalizer-3.3.2 docutils-0.20.1 idna-3.7 imagesize-1.4.1 importlib-metadata-8.2.0 packaging-24.1 pytz-2024.1 readthedocs-sphinx-ext-2.2.5 requests-2.32.3 snowballstemmer-2.2.0 sphinx-7.1.2 sphinxcontrib-applehelp-1.0.4 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.1 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-2.2.2 zipp-3.20.0 [rtd-command-info] start-time: 2024-08-16T12:16:15.007570Z, end-time: 2024-08-16T12:19:52.208657Z, duration: 217, exit-code: 0 python -m pip install --upgrade --upgrade-strategy only-if-needed --no-cache-dir .[doc] Processing /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/checkouts/2039 Installing build dependencies: started Installing build dependencies: finished with status 'done' Getting requirements to build wheel: started Getting requirements to build wheel: finished with status 'done' Installing backend dependencies: started Installing backend dependencies: finished with status 'done' Preparing metadata (pyproject.toml): started Preparing metadata (pyproject.toml): finished with status 'done' Collecting numpy>=1.17 (from tiledb==0.31.2.dev16+g84b42e2) Downloading numpy-1.24.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (5.6 kB) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from tiledb==0.31.2.dev16+g84b42e2) (24.1) Collecting jinja2==3.0.0 (from tiledb==0.31.2.dev16+g84b42e2) Downloading Jinja2-3.0.0-py3-none-any.whl.metadata (3.5 kB) Collecting sphinx-rtd-theme==2.0.0 (from tiledb==0.31.2.dev16+g84b42e2) Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl.metadata (4.4 kB) Requirement already satisfied: Sphinx in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from tiledb==0.31.2.dev16+g84b42e2) (7.1.2) Collecting breathe (from tiledb==0.31.2.dev16+g84b42e2) Downloading breathe-4.35.0-py3-none-any.whl.metadata (1.0 kB) Requirement already satisfied: MarkupSafe>=2.0.0rc2 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from jinja2==3.0.0->tiledb==0.31.2.dev16+g84b42e2) (2.1.5) Requirement already satisfied: docutils<0.21 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from sphinx-rtd-theme==2.0.0->tiledb==0.31.2.dev16+g84b42e2) (0.20.1) Collecting sphinxcontrib-jquery<5,>=4 (from sphinx-rtd-theme==2.0.0->tiledb==0.31.2.dev16+g84b42e2) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl.metadata (2.6 kB) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.0.4) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.0.2) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.0.1) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.1.5) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.0.3) Requirement already satisfied: Pygments>=2.13 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.18.0) Requirement already satisfied: snowballstemmer>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.2.0) Requirement already satisfied: babel>=2.9 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.16.0) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (0.7.13) Requirement already satisfied: imagesize>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (1.4.1) Requirement already satisfied: requests>=2.25.0 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.32.3) Requirement already satisfied: importlib-metadata>=4.8 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from Sphinx->tiledb==0.31.2.dev16+g84b42e2) (8.2.0) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from babel>=2.9->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2024.1) Requirement already satisfied: zipp>=0.5 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from importlib-metadata>=4.8->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (3.20.0) Requirement already satisfied: charset-normalizer<4,>=2 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from requests>=2.25.0->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (3.3.2) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from requests>=2.25.0->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (3.7) Requirement already satisfied: urllib3<3,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from requests>=2.25.0->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2.2.2) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages (from requests>=2.25.0->Sphinx->tiledb==0.31.2.dev16+g84b42e2) (2024.7.4) Downloading Jinja2-3.0.0-py3-none-any.whl (133 kB) Downloading sphinx_rtd_theme-2.0.0-py2.py3-none-any.whl (2.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.8/2.8 MB 102.1 MB/s eta 0:00:00 Downloading numpy-1.24.4-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (17.3 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 17.3/17.3 MB 193.0 MB/s eta 0:00:00 Downloading breathe-4.35.0-py3-none-any.whl (92 kB) Downloading sphinxcontrib_jquery-4.1-py2.py3-none-any.whl (121 kB) Building wheels for collected packages: tiledb Building wheel for tiledb (pyproject.toml): started Building wheel for tiledb (pyproject.toml): still running... Building wheel for tiledb (pyproject.toml): still running... Building wheel for tiledb (pyproject.toml): still running... Building wheel for tiledb (pyproject.toml): finished with status 'done' Created wheel for tiledb: filename=tiledb-0.31.2.dev16+g84b42e2-cp38-cp38-linux_x86_64.whl size=15853674 sha256=8430108e90f96e98f8e08ad52be2d5744496593395d487e85dee7bb61d9df585 Stored in directory: /tmp/pip-ephem-wheel-cache-z8gqynd6/wheels/d9/e9/38/796c6039238a7c0e7ef212b9313eb132b173cda2223c2ea4ff Successfully built tiledb Installing collected packages: numpy, jinja2, tiledb, sphinxcontrib-jquery, breathe, sphinx-rtd-theme Attempting uninstall: jinja2 Found existing installation: Jinja2 3.1.4 Uninstalling Jinja2-3.1.4: Successfully uninstalled Jinja2-3.1.4 Successfully installed breathe-4.35.0 jinja2-3.0.0 numpy-1.24.4 sphinx-rtd-theme-2.0.0 sphinxcontrib-jquery-4.1 tiledb-0.31.2.dev16+g84b42e2 [rtd-command-info] start-time: 2024-08-16T12:19:52.754725Z, end-time: 2024-08-16T12:19:52.799594Z, duration: 0, exit-code: 0 cat doc/source/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # -- Imports configuration ------------------------------------------------- import os import sys from os.path import abspath, dirname, join import sphinx_rtd_theme from importlib.metadata import version as get_version sys.path.insert(0, abspath(join(dirname(__file__)))) # -- ReadTheDocs configuration --------------------------------------------- # Special handling on ReadTheDocs builds. # Some of this code is from https://github.com/robotpy/robotpy-docs/blob/master/conf.py readthedocs = os.environ.get("READTHEDOCS", None) == "True" rtd_version = os.environ.get("READTHEDOCS_VERSION", "latest") rtd_version = rtd_version if rtd_version in ["stable", "latest"] else "stable" # -- Project information ----------------------------------------------------- project = "TileDB-Py" copyright = "2024, TileDB, Inc." author = "TileDB, Inc." # The full version, including alpha/beta/rc tags release: str = get_version("tiledb") # The short X.Y version version: str = ".".join(release.split(".")[:2]) # -- 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.doctest", "sphinx.ext.intersphinx"] # Mapping for linking between RTD subprojects. if readthedocs: intersphinx_mapping = { "tiledb": ( "https://tiledb-inc-tiledb.readthedocs-hosted.com/en/%s/" % rtd_version, None, ), "tiledb-py": ( "https://tiledb-inc-tiledb.readthedocs-hosted.com/projects/python-api/en/%s/" % rtd_version, None, ), "python": ("https://docs.python.org/", None), } # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = ".rst" # The master toctree document. master_doc = "index" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path . exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # The name of the Pygments (syntax highlighting) style to use. pygments_style = "friendly" # -- Options for HTML output ------------------------------------------------- html_static_path = ["_static"] html_title = "TileDB Python API Reference — TileDB-Py %s documentation" % version html_logo = "_static/tiledb-logo_color_no_margin_@4x.png" html_favicon = "_static/favicon.ico" html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = "TileDB-Pydoc" # -- 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': '', # Latex figure (float) alignment # # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ (master_doc, "TileDB-Py.tex", "TileDB-Py Documentation", "TileDB, Inc.", "manual") ] # -- Options for manual page output ------------------------------------------ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [(master_doc, "tiledb-py", "TileDB-Py Documentation", [author], 1)] # -- 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 = [ ( master_doc, "TileDB-Py", "TileDB-Py Documentation", author, "TileDB-Py", "One line description of project.", "Miscellaneous", ) ] # -- Custom Document processing ---------------------------------------------- # Generate the sidebar automatically so that it is identical across all subprojects. # This (and gensidebar.py) from https://github.com/robotpy/robotpy-docs import gensidebar gensidebar.generate_sidebar( {"on_rtd": readthedocs, "rtd_version": rtd_version}, "tiledb-py" ) # -- Custom setup ----------------------------------------------------------- def setup(app): app.add_css_file("custom.css") ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Define this variable in case it's not defined by the user. # It defaults to `alabaster` which is the default from Sphinx. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme html_theme = globals().get('html_theme', 'alabaster') #Add project information to the template context. context = { 'html_theme': html_theme, 'current_version': "2039", 'version_slug': "2039", '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/"), ("stable", "/en/stable/"), ("release-0.6", "/en/release-0.6/"), ("dev", "/en/dev/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'tiledb-inc-tiledb-py', 'name': u'TileDB-Py', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', 'analytics_code': 'G-W0J7K3XGLY', 'single_version': False, 'conf_py_path': '/doc/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'TileDB-Inc', 'proxied_api_host': '/_', 'github_repo': 'TileDB-Py', 'github_version': '84b42e2e28800e3babc8fa38fddc28b665965043', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '84b42e2e28800e3babc8fa38fddc28b665965043', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '84b42e2e28800e3babc8fa38fddc28b665965043', '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': 'G-W0J7K3XGLY', 'global_analytics_code': 'UA-17997319-2', 'commit': '84b42e2e', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None if 'html_context' in globals(): for key in context: if key not in html_context: html_context[key] = context[key] else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'external' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'https://github.com/TileDB-Inc/TileDB-Py/pull/2039' readthedocs_build_url = 'https://readthedocs.com/projects/tiledb-inc-tiledb-py/builds/2420544/' 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: 2024-08-16T12:19:52.875161Z, end-time: 2024-08-16T12:19:57.567727Z, duration: 4, exit-code: 0 python -m sphinx -T -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v7.1.2 making output directory... done loading intersphinx inventory from https://tiledb-inc-tiledb.readthedocs-hosted.com/en/stable/objects.inv... loading intersphinx inventory from https://tiledb-inc-tiledb.readthedocs-hosted.com/projects/python-api/en/stable/objects.inv... loading intersphinx inventory from https://docs.python.org/objects.inv... intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv WARNING: failed to reach any of the inventories with the following issues: intersphinx inventory 'https://tiledb-inc-tiledb.readthedocs-hosted.com/projects/python-api/en/stable/objects.inv' not fetchable due to : 404 Client Error: Not Found for url: https://tiledb-inc-tiledb.readthedocs-hosted.com/projects/python-api/en/stable/objects.inv building [mo]: targets for 0 po files that are out of date writing output... building [html]: targets for 2 source files that are out of date updating environment: [new config] 2 added, 0 changed, 0 removed reading sources... [ 50%] index reading sources... [100%] python-api /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/__init__.py:docstring of tiledb.libtiledb.DenseArrayImpl.query:22: ERROR: Unexpected indentation. /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/__init__.py:docstring of tiledb.libtiledb.DenseArrayImpl.query:23: WARNING: Block quote ends without a blank line; unexpected unindent. /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata, other instance in python-api, use :noindex: for one of them /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata:1: WARNING: duplicate object description of tiledb.group.Group.GroupMetadata, other instance in python-api, use :noindex: for one of them WARNING: autodoc: failed to import method 'Group.GroupMetadata.__keys__' from module 'tiledb'; the following exception was raised: No module named 'tiledb.Group' WARNING: autodoc: failed to import method 'Group.GroupMetadata.__values__' from module 'tiledb'; the following exception was raised: No module named 'tiledb.Group' WARNING: autodoc: failed to import method 'Group.GroupMetadata.__items__' from module 'tiledb'; the following exception was raised: No module named 'tiledb.Group' /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata.clear:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata.clear, other instance in python-api, use :noindex: for one of them /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata.dump:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata.dump, other instance in python-api, use :noindex: for one of them /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata.pop:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata.pop, other instance in python-api, use :noindex: for one of them /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata.popitem:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata.popitem, other instance in python-api, use :noindex: for one of them /home/docs/checkouts/readthedocs.org/user_builds/tiledb-inc-tiledb-py/envs/2039/lib/python3.8/site-packages/tiledb/group.py:docstring of tiledb.group.Group.GroupMetadata.setdefault:1: WARNING: duplicate object description of tiledb.Group.GroupMetadata.setdefault, other instance in python-api, use :noindex: for one of them looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done copying assets... copying static files... done copying extra files... done done writing output... [ 50%] index writing output... [100%] python-api generating indices... genindex done writing additional pages... search done dumping search index in English (code: en)... done dumping object inventory... done Updating searchtools for Read the Docs search... build succeeded, 13 warnings. The HTML pages are in ../../_readthedocs/html.