Read the Docs build information Build id: 807894 Project: domino-data-api Version: latest Commit: 06928eec5212cc2d9831d8fc74af85b81a4487d0 Date: 2021-12-22T19:25:50.302815Z State: finished Success: True [rtd-command-info] start-time: 2021-12-22T19:25:51.908674Z, end-time: 2021-12-22T19:25:53.151943Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 git@github.com:dominodatalab/domino-data.git . Cloning into '.'... Warning: Permanently added 'github.com,192.30.255.112' (ECDSA) to the list of known hosts. [rtd-command-info] start-time: 2021-12-22T19:25:53.284565Z, end-time: 2021-12-22T19:25:53.374303Z, duration: 0, exit-code: 0 git checkout --force origin/main Note: checking out '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 performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 06928ee Fix documentation typos (#21) [rtd-command-info] start-time: 2021-12-22T19:25:53.502689Z, end-time: 2021-12-22T19:25:53.569418Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-12-22T19:26:00.858401Z, end-time: 2021-12-22T19:26:01.963938Z, duration: 1, exit-code: 0 asdf global python 3.9.7 [rtd-command-info] start-time: 2021-12-22T19:26:03.043111Z, end-time: 2021-12-22T19:26:05.587426Z, duration: 2, exit-code: 0 python -mvirtualenv created virtual environment CPython3.9.7.final.0-64 in 729ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==21.2.3, setuptools==57.4.0, wheel==0.37.0 activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2021-12-22T19:26:05.705207Z, end-time: 2021-12-22T19:26:18.546750Z, duration: 12, 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/domino-data-api/envs/latest/lib/python3.9/site-packages (21.2.3) Collecting pip Downloading pip-21.3.1-py3-none-any.whl (1.7 MB) Requirement already satisfied: setuptools<58.3.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (57.4.0) Collecting setuptools<58.3.0 Downloading setuptools-58.2.0-py3-none-any.whl (946 kB) Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 57.4.0 Uninstalling setuptools-57.4.0: Successfully uninstalled setuptools-57.4.0 Attempting uninstall: pip Found existing installation: pip 21.2.3 Uninstalling pip-21.2.3: Successfully uninstalled pip-21.2.3 Successfully installed pip-21.3.1 setuptools-58.2.0 [rtd-command-info] start-time: 2021-12-22T19:26:18.659860Z, end-time: 2021-12-22T19:27:04.834344Z, duration: 46, exit-code: 0 python -m pip install --upgrade --no-cache-dir mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx sphinx-rtd-theme readthedocs-sphinx-ext<2.2 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pillow==5.4.1 Downloading Pillow-5.4.1.tar.gz (16.0 MB) 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.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx Downloading Sphinx-4.3.2-py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme Downloading sphinx_rtd_theme-1.0.0-py2.py3-none-any.whl (2.8 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting docutils>=0.11 Downloading docutils-0.18.1-py2.py3-none-any.whl (570 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting sphinxcontrib-serializinghtml>=1.1.5 Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Collecting Pygments>=2.0 Downloading Pygments-2.10.0-py3-none-any.whl (1.0 MB) Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting imagesize Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from sphinx) (58.2.0) Collecting babel>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) Collecting requests>=2.5.0 Downloading requests-2.26.0-py2.py3-none-any.whl (62 kB) Collecting pytz>=2015.7 Downloading pytz-2021.3-py2.py3-none-any.whl (503 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp39-cp39-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (30 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) Collecting idna<4,>=2.5 Downloading idna-3.3-py3-none-any.whl (61 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.9-py3-none-any.whl (39 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.7-py2.py3-none-any.whl (138 kB) Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.6-py3-none-any.whl (97 kB) Building wheels for collected packages: mock, pillow, future 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=acc5d20fe036ffc6401881d47358bcd7acc6f9da2011480fa1e6be270cc0b851 Stored in directory: /tmp/pip-ephem-wheel-cache-4w40lkn_/wheels/44/dc/c7/e89296d3612588db0aa6545ee3305c23b7a48b3a9922916e1f Building wheel for pillow (setup.py): started Building wheel for pillow (setup.py): finished with status 'done' Created wheel for pillow: filename=Pillow-5.4.1-cp39-cp39-linux_x86_64.whl size=1361163 sha256=6b051db21516ade15399bea4ac6b02ec355209cf90640d913a596e98ad332b65 Stored in directory: /tmp/pip-ephem-wheel-cache-4w40lkn_/wheels/d3/de/21/f0ad1b0453288616d3f4d2ce28431aa7a2adde8f27c9b7a0af Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=2ae75e24c1b686e9d0d3fb03e95fb4b63813bfd5f61f22b2e97057fe4c15197e Stored in directory: /tmp/pip-ephem-wheel-cache-4w40lkn_/wheels/2f/a0/d3/4030d9f80e6b3be787f19fc911b8e7aa462986a40ab1e4bb94 Successfully built mock pillow future Installing collected packages: urllib3, pytz, pyparsing, MarkupSafe, idna, charset-normalizer, certifi, sphinxcontrib-serializinghtml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, snowballstemmer, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.3 MarkupSafe-2.0.1 Pygments-2.10.0 alabaster-0.7.12 babel-2.9.1 certifi-2021.10.8 charset-normalizer-2.0.9 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-3.3 imagesize-1.3.0 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.6 pytz-2021.3 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.26.0 snowballstemmer-2.2.0 sphinx-4.3.2 sphinx-rtd-theme-1.0.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.5 urllib3-1.26.7 [rtd-command-info] start-time: 2021-12-22T19:27:04.981844Z, end-time: 2021-12-22T19:27:20.875149Z, duration: 15, exit-code: 0 python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir . Processing /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/checkouts/latest 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' Preparing metadata (pyproject.toml): started Preparing metadata (pyproject.toml): finished with status 'done' Collecting pyarrow<6.0.0,>=5.0.0 Downloading pyarrow-5.0.0-cp39-cp39-manylinux2014_x86_64.whl (23.7 MB) Collecting attrs<22.0.0,>=20.1.0 Downloading attrs-21.2.0-py2.py3-none-any.whl (53 kB) Collecting pandas>=1.3.0 Downloading pandas-1.3.5-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (11.5 MB) Collecting loguru<0.6.0,>=0.5.3 Downloading loguru-0.5.3-py3-none-any.whl (57 kB) Collecting backoff<2.0.0,>=1.11.1 Downloading backoff-1.11.1-py2.py3-none-any.whl (13 kB) Collecting httpx<0.19.0,>=0.15.4 Downloading httpx-0.18.2-py3-none-any.whl (76 kB) Collecting python-dateutil<3.0.0,>=2.8.0 Downloading python_dateutil-2.8.2-py2.py3-none-any.whl (247 kB) Collecting rfc3986[idna2008]<2,>=1.3 Downloading rfc3986-1.5.0-py2.py3-none-any.whl (31 kB) Collecting sniffio Downloading sniffio-1.2.0-py3-none-any.whl (10 kB) Requirement already satisfied: certifi in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from httpx<0.19.0,>=0.15.4->dominodatalab-data==0.1.8) (2021.10.8) Collecting httpcore<0.14.0,>=0.13.3 Downloading httpcore-0.13.7-py3-none-any.whl (58 kB) Requirement already satisfied: pytz>=2017.3 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from pandas>=1.3.0->dominodatalab-data==0.1.8) (2021.3) Collecting numpy>=1.17.3 Downloading numpy-1.21.5-cp39-cp39-manylinux_2_12_x86_64.manylinux2010_x86_64.whl (15.7 MB) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting anyio==3.* Downloading anyio-3.4.0-py3-none-any.whl (78 kB) Collecting h11<0.13,>=0.11 Downloading h11-0.12.0-py3-none-any.whl (54 kB) Requirement already satisfied: idna>=2.8 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from anyio==3.*->httpcore<0.14.0,>=0.13.3->httpx<0.19.0,>=0.15.4->dominodatalab-data==0.1.8) (3.3) Building wheels for collected packages: dominodatalab-data Building wheel for dominodatalab-data (pyproject.toml): started Building wheel for dominodatalab-data (pyproject.toml): finished with status 'done' Created wheel for dominodatalab-data: filename=dominodatalab_data-0.1.8-py3-none-any.whl size=59115 sha256=346ecc0e098d2ac66da7afed1f042dca80d3f77e6fa795ea378dea510cdd5402 Stored in directory: /tmp/pip-ephem-wheel-cache-2q6ohm3o/wheels/a4/71/53/a40cdf1829007e6453a5f16bfc5bdca8fea18f5d2bffa7bf5e Successfully built dominodatalab-data Installing collected packages: sniffio, six, rfc3986, h11, anyio, python-dateutil, numpy, httpcore, pyarrow, pandas, loguru, httpx, backoff, attrs, dominodatalab-data Successfully installed anyio-3.4.0 attrs-21.2.0 backoff-1.11.1 dominodatalab-data-0.1.8 h11-0.12.0 httpcore-0.13.7 httpx-0.18.2 loguru-0.5.3 numpy-1.21.5 pandas-1.3.5 pyarrow-5.0.0 python-dateutil-2.8.2 rfc3986-1.5.0 six-1.16.0 sniffio-1.2.0 [rtd-command-info] start-time: 2021-12-22T19:27:20.987018Z, end-time: 2021-12-22T19:27:22.021977Z, duration: 1, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Collecting sphinx-autodoc-typehints==1.12.0 Downloading sphinx_autodoc_typehints-1.12.0-py3-none-any.whl (9.4 kB) Requirement already satisfied: Sphinx>=3.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (4.3.2) Requirement already satisfied: sphinxcontrib-jsmath in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.0.1) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.1.5) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.10.0) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.2.0) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.9.1) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (58.2.0) Requirement already satisfied: sphinxcontrib-htmlhelp>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.0.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (21.3) Requirement already satisfied: requests>=2.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.26.0) Requirement already satisfied: docutils<0.18,>=0.14 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (0.17.1) Requirement already satisfied: sphinxcontrib-applehelp in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-devhelp in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.0.2) Requirement already satisfied: sphinxcontrib-qthelp in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.0.3) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (0.7.12) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.3.0) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (3.0.3) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from babel>=1.3->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2021.3) Requirement already satisfied: MarkupSafe>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from Jinja2>=2.3->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.0.1) Requirement already satisfied: idna<4,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (3.3) Requirement already satisfied: charset-normalizer~=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2.0.9) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (2021.10.8) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from requests>=2.5.0->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (1.26.7) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/domino-data-api/envs/latest/lib/python3.9/site-packages (from packaging->Sphinx>=3.0->sphinx-autodoc-typehints==1.12.0->-r docs/requirements.txt (line 1)) (3.0.6) Installing collected packages: sphinx-autodoc-typehints Successfully installed sphinx-autodoc-typehints-1.12.0 [rtd-command-info] start-time: 2021-12-22T19:27:22.946246Z, end-time: 2021-12-22T19:27:23.012816Z, duration: 0, exit-code: 0 cat docs/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # 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. # from typing import List import os import sys sys.path.insert(0, os.path.abspath("../../domino_data")) # -- Project information ----------------------------------------------------- project = "Domino Data API" copyright = "2021, Aaron Read, Gabriel Haim" author = "Aaron Read, Gabriel Haim" # -- General configuration --------------------------------------------------- # 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.napoleon", "sphinx.ext.viewcode", "sphinx_autodoc_typehints", "sphinx_rtd_theme", ] # Add any paths that contain templates here, relative to this directory. templates_path = ["_templates"] # 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: List[str] = [] # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # html_theme = "sphinx_rtd_theme" # Napoleon config napoleon_google_docstring = True ########################################################################### # 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/master/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: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] 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", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'domino-data-api', 'name': u'data-api', 'rtd_language': u'en', 'programming_language': u'py', 'canonical_url': 'https://docs.dominodatalab.com/projects/domino-data-api/en/latest/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/source/', 'api_host': 'https://readthedocs.com', 'github_user': 'dominodatalab', 'proxied_api_host': '/_', 'github_repo': 'domino-data', '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': '06928eec', } # 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/domino-data-api/builds/807894/' 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: 2021-12-22T19:27:23.121879Z, end-time: 2021-12-22T19:27:26.897181Z, duration: 3, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.3.2 loading translations [en]... done making output directory... done [autosummary] generating autosummary for: auth.rst, domino_data.rst, index.rst, install.rst, usecases/config_override.rst, usecases/create_trainingset.rst, usecases/custom_auth.rst, usecases/delete_trainingset.rst, usecases/get_trainingset.rst, usecases/object_store.rst, usecases/simple_query.rst, usecases/update_trainingset.rst, usecases/write_to_parquet.rst building [mo]: targets for 0 po files that are out of date building [html]: targets for 13 source files that are out of date updating environment: [new config] 13 added, 0 changed, 0 removed reading sources... [ 7%] auth reading sources... [ 15%] domino_data reading sources... [ 23%] index reading sources... [ 30%] install reading sources... [ 38%] usecases/config_override reading sources... [ 46%] usecases/create_trainingset reading sources... [ 53%] usecases/custom_auth reading sources... [ 61%] usecases/delete_trainingset reading sources... [ 69%] usecases/get_trainingset reading sources... [ 76%] usecases/object_store reading sources... [ 84%] usecases/simple_query reading sources... [ 92%] usecases/update_trainingset reading sources... [100%] usecases/write_to_parquet WARNING: Cannot resolve forward reference in type annotations of "domino_data.data_sources.Datasource": name 'DataSourceClient' is not defined WARNING: Cannot resolve forward reference in type annotations of "domino_data.data_sources.ObjectStoreDatasource": name 'DataSourceClient' is not defined WARNING: Cannot resolve forward reference in type annotations of "domino_data.data_sources.QueryDatasource": name 'DataSourceClient' is not defined WARNING: Cannot resolve forward reference in type annotations of "domino_data.data_sources.Result": name 'DataSourceClient' is not defined looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 7%] auth writing output... [ 15%] domino_data writing output... [ 23%] index writing output... [ 30%] install writing output... [ 38%] usecases/config_override writing output... [ 46%] usecases/create_trainingset writing output... [ 53%] usecases/custom_auth writing output... [ 61%] usecases/delete_trainingset writing output... [ 69%] usecases/get_trainingset writing output... [ 76%] usecases/object_store writing output... [ 84%] usecases/simple_query writing output... [ 92%] usecases/update_trainingset writing output... [100%] usecases/write_to_parquet generating indices... genindex py-modindex done highlighting module code... [ 25%] domino_data.auth highlighting module code... [ 50%] domino_data.data_sources highlighting module code... [ 75%] domino_data.training_sets.client highlighting module code... [100%] domino_data.training_sets.model 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 build succeeded, 4 warnings. The HTML pages are in _build/html. Updating searchtools for Read the Docs search...