Read the Docs build information Build id: 367042 Project: tamr-tamr-client Version: latest Commit: a24c31df12d354e272e4a40d1f01c560f4948649 Date: 2020-07-14T14:02:47.601730Z State: finished Success: False [rtd-command-info] start-time: 2020-07-14T14:02:50.436751Z, end-time: 2020-07-14T14:02:51.311676Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/Datatamer/tamr-client . Cloning into '.'... [rtd-command-info] start-time: 2020-07-14T14:02:51.635224Z, end-time: 2020-07-14T14:02:51.843749Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. 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 a24c31d Merge pull request #421 from keziah-tamr/transformations [rtd-command-info] start-time: 2020-07-14T14:02:52.224615Z, end-time: 2020-07-14T14:02:52.436546Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-07-14T14:02:54.060683Z, end-time: 2020-07-14T14:02:58.142196Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.6.8' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-07-14T14:02:58.268893Z, end-time: 2020-07-14T14:02:59.118196Z, duration: 0, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (20.1.1) [rtd-command-info] start-time: 2020-07-14T14:02:59.465732Z, end-time: 2020-07-14T14:03:09.425818Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 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<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) 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<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.3-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-20.4-py2.py3-none-any.whl (37 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.2-py2.py3-none-any.whl (125 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting six>=1.5 Downloading six-1.15.0-py2.py3-none-any.whl (10 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting requests>=2.0.0 Downloading requests-2.24.0-py2.py3-none-any.whl (61 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl (27 kB) Collecting pytz>=2015.7 Downloading pytz-2020.1-py2.py3-none-any.whl (510 kB) Collecting certifi>=2017.4.17 Downloading certifi-2020.6.20-py2.py3-none-any.whl (156 kB) Collecting chardet<4,>=3.0.2 Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Downloading urllib3-1.25.9-py2.py3-none-any.whl (126 kB) Building wheels for collected packages: mock, 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=23754 sha256=993aba9aa762b9c79429cdf41f0d54ed5b1960ecbed12c886e20363bf6dbcc09 Stored in directory: /tmp/pip-ephem-wheel-cache-bwfhgm23/wheels/15/fd/39/f238f155700d6d5e6231e82ae3ccf3aa7490a1b17d2073251b 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=491058 sha256=8e6a2872af8745fa42e64e2c7a39f4a48af6b399950fa4f85cc6cecbebd1fa99 Stored in directory: /tmp/pip-ephem-wheel-cache-bwfhgm23/wheels/6e/9c/ed/4499c9865ac1002697793e0ae05ba6be33553d098f3347fb94 Successfully built mock future Installing collected packages: Pygments, setuptools, docutils, mock, pillow, alabaster, future, commonmark, sphinxcontrib-websupport, six, pyparsing, packaging, MarkupSafe, Jinja2, snowballstemmer, pytz, babel, imagesize, certifi, chardet, idna, urllib3, requests, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Attempting uninstall: setuptools Found existing installation: setuptools 49.2.0 Uninstalling setuptools-49.2.0: Successfully uninstalled setuptools-49.2.0 Successfully installed Jinja2-2.11.2 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.8.0 certifi-2020.6.20 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-20.4 pillow-5.4.1 pyparsing-2.4.7 pytz-2020.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.24.0 setuptools-41.0.1 six-1.15.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.2.3 urllib3-1.25.9 [rtd-command-info] start-time: 2020-07-14T14:03:09.693207Z, end-time: 2020-07-14T14:03:30.516959Z, duration: 20, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r docs/requirements.txt Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/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 wheel metadata: started Preparing wheel metadata: finished with status 'done' Collecting pandas==1.0.5 Downloading pandas-1.0.5-cp36-cp36m-manylinux1_x86_64.whl (10.1 MB) Collecting recommonmark==0.6.0 Downloading recommonmark-0.6.0-py2.py3-none-any.whl (10 kB) Collecting sphinx_rtd_theme==0.5.0 Downloading sphinx_rtd_theme-0.5.0-py2.py3-none-any.whl (10.8 MB) Collecting sphinx-autodoc-typehints==1.11.0 Downloading sphinx_autodoc_typehints-1.11.0-py3-none-any.whl (8.5 kB) Collecting Sphinx==3.1.1 Downloading Sphinx-3.1.1-py3-none-any.whl (2.9 MB) Collecting toml==0.10.0 Downloading toml-0.10.0-py2.py3-none-any.whl (25 kB) Requirement already satisfied: requests<3.0,>=2.22 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from tamr-unify-client==0.13.0.dev0->-r docs/requirements.txt (line 8)) (2.24.0) Collecting simplejson<4.0,>=3.16 Downloading simplejson-3.17.0.tar.gz (83 kB) Collecting dataclasses<0.7.0,>=0.6.0 Downloading dataclasses-0.6-py3-none-any.whl (14 kB) Requirement already satisfied: pytz>=2017.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from pandas==1.0.5->-r docs/requirements.txt (line 2)) (2020.1) Collecting numpy>=1.13.3 Downloading numpy-1.19.0-cp36-cp36m-manylinux2010_x86_64.whl (14.6 MB) Collecting python-dateutil>=2.6.1 Downloading python_dateutil-2.8.1-py2.py3-none-any.whl (227 kB) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from recommonmark==0.6.0->-r docs/requirements.txt (line 3)) (0.14) Requirement already satisfied: commonmark>=0.8.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from recommonmark==0.6.0->-r docs/requirements.txt (line 3)) (0.8.1) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (1.2.0) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (2.11.2) Collecting sphinxcontrib-htmlhelp Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (0.7.12) Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (2.0.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (20.4) Requirement already satisfied: babel>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (2.8.0) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (41.0.1) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (2.3.1) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0->-r docs/requirements.txt (line 8)) (2020.6.20) Requirement already satisfied: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0->-r docs/requirements.txt (line 8)) (3.0.4) Requirement already satisfied: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0->-r docs/requirements.txt (line 8)) (2.10) Requirement already satisfied: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0->-r docs/requirements.txt (line 8)) (1.25.9) Requirement already satisfied: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from python-dateutil>=2.6.1->pandas==1.0.5->-r docs/requirements.txt (line 2)) (1.15.0) Requirement already satisfied: future in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from commonmark>=0.8.1->recommonmark==0.6.0->-r docs/requirements.txt (line 3)) (0.18.2) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from Jinja2>=2.3->Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (1.1.1) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from packaging->Sphinx==3.1.1->-r docs/requirements.txt (line 6)) (2.4.7) Building wheels for collected packages: tamr-unify-client, simplejson Building wheel for tamr-unify-client (PEP 517): started Building wheel for tamr-unify-client (PEP 517): finished with status 'done' Created wheel for tamr-unify-client: filename=tamr_unify_client-0.13.0.dev0-py3-none-any.whl size=77575 sha256=944e31c52b7ac13eb0f51c97850210fba7d7315d1b736ef4461d79881cbd9ff9 Stored in directory: /tmp/pip-ephem-wheel-cache-ib9dyj63/wheels/4a/96/84/c16eadd0b1086fda84887483d49fa8038b10a90c72d5264532 Building wheel for simplejson (setup.py): started Building wheel for simplejson (setup.py): finished with status 'done' Created wheel for simplejson: filename=simplejson-3.17.0-cp36-cp36m-linux_x86_64.whl size=123790 sha256=41b04434e5575628c24b800bf72cc21f77aaf60a599e45ed16ce8f0a71a9253f Stored in directory: /tmp/pip-ephem-wheel-cache-ib9dyj63/wheels/c2/95/a2/477b46cfe980061fddc4cb76ed4657eceec35d2b2090355e41 Successfully built tamr-unify-client simplejson Installing collected packages: numpy, python-dateutil, pandas, sphinxcontrib-qthelp, sphinxcontrib-htmlhelp, sphinxcontrib-applehelp, sphinxcontrib-jsmath, sphinxcontrib-serializinghtml, sphinxcontrib-devhelp, Sphinx, recommonmark, sphinx-rtd-theme, sphinx-autodoc-typehints, toml, simplejson, dataclasses, tamr-unify-client Attempting uninstall: Sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Attempting uninstall: recommonmark Found existing installation: recommonmark 0.5.0 Uninstalling recommonmark-0.5.0: Successfully uninstalled recommonmark-0.5.0 Attempting uninstall: sphinx-rtd-theme Found existing installation: sphinx-rtd-theme 0.4.3 Uninstalling sphinx-rtd-theme-0.4.3: Successfully uninstalled sphinx-rtd-theme-0.4.3 Successfully installed Sphinx-3.1.1 dataclasses-0.6 numpy-1.19.0 pandas-1.0.5 python-dateutil-2.8.1 recommonmark-0.6.0 simplejson-3.17.0 sphinx-autodoc-typehints-1.11.0 sphinx-rtd-theme-0.5.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 tamr-unify-client-0.13.0.dev0 toml-0.10.0 [rtd-command-info] start-time: 2020-07-14T14:03:30.723201Z, end-time: 2020-07-14T14:03:38.973122Z, duration: 8, exit-code: 0 python -m pip install --upgrade --upgrade-strategy eager --no-cache-dir /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/checkouts/latest Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/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 wheel metadata: started Preparing wheel metadata: finished with status 'done' Requirement already up-to-date: dataclasses<0.7.0,>=0.6.0 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from tamr-unify-client==0.13.0.dev0) (0.6) Requirement already up-to-date: simplejson<4.0,>=3.16 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from tamr-unify-client==0.13.0.dev0) (3.17.0) Requirement already up-to-date: requests<3.0,>=2.22 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from tamr-unify-client==0.13.0.dev0) (2.24.0) Requirement already up-to-date: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0) (2020.6.20) Requirement already up-to-date: idna<3,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0) (2.10) Requirement already up-to-date: chardet<4,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0) (3.0.4) Requirement already up-to-date: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.13.0.dev0) (1.25.9) Building wheels for collected packages: tamr-unify-client Building wheel for tamr-unify-client (PEP 517): started Building wheel for tamr-unify-client (PEP 517): finished with status 'done' Created wheel for tamr-unify-client: filename=tamr_unify_client-0.13.0.dev0-py3-none-any.whl size=77575 sha256=944e31c52b7ac13eb0f51c97850210fba7d7315d1b736ef4461d79881cbd9ff9 Stored in directory: /tmp/pip-ephem-wheel-cache-k98do8xt/wheels/4a/96/84/c16eadd0b1086fda84887483d49fa8038b10a90c72d5264532 Successfully built tamr-unify-client Installing collected packages: tamr-unify-client Attempting uninstall: tamr-unify-client Found existing installation: tamr-unify-client 0.13.0.dev0 Uninstalling tamr-unify-client-0.13.0.dev0: Successfully uninstalled tamr-unify-client-0.13.0.dev0 Successfully installed tamr-unify-client-0.13.0.dev0 [rtd-command-info] start-time: 2020-07-14T14:03:41.403951Z, end-time: 2020-07-14T14:03:41.616382Z, duration: 0, exit-code: 0 cat docs/conf.py # -*- coding: utf-8 -*- # # Configuration file for the Sphinx documentation builder. # # This file does only contain a selection of the most common options. For a # full list see the documentation: # http://www.sphinx-doc.org/en/master/config # -- 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. import os import sys from recommonmark.transform import AutoStructify import toml sys.path.insert(0, os.path.abspath("..")) # -- Project information ----------------------------------------------------- project = "Tamr - Python Client" author = "Tamr" project_root = os.path.dirname(os.path.dirname(__file__)) with open(os.path.join(project_root, "pyproject.toml")) as f: version = toml.load(f)["tool"]["poetry"]["version"] # The short X.Y version version = ".".join(version.split(".")[:-1]) # The full version, including alpha/beta/rc tags release = version # -- 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 = [ "recommonmark", "sphinx.ext.napoleon", "sphinx_autodoc_typehints", "sphinx.ext.intersphinx", "sphinx.ext.viewcode", "sphinx.ext.autosectionlabel", ] autodoc_default_options = {"inherited-members": True, "members": True} autodoc_member_order = "bysource" autosectionlabel_prefix_document = True intersphinx_mapping = { "https://docs.python.org/": None, "requests": ("https://requests.readthedocs.io/en/master/", None), "pandas": ("https://pandas.pydata.org/pandas-docs/stable", 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'] # 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 = None # 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 = None # -- 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" html_favicon = "_static/favicon.png" html_show_copyright = False # custom copyright in _templates/footer.html html_show_sphinx = False # 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 = {} # 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"] html_logo = "_static/tamr.png" html_sidebars = {"**": ["localtoc.html", "relations.html", "searchbox.html"]} # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # The default sidebars (for documents that don't match any pattern) are # defined by theme itself. Builtin themes are using these templates by # default: ``['localtoc.html', 'relations.html', 'sourcelink.html', # 'searchbox.html']``. # # html_sidebars = {} # -- Options for HTMLHelp output --------------------------------------------- # Output file base name for HTML help builder. htmlhelp_basename = "TamrPythonClientdoc" # -- 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, "TamrPythonClient.tex", "Tamr - Python Client Documentation", "Tamr", "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, "tamrpythonclient", "Tamr - Python Client 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, "TamrPythonClient", "Tamr - Python Client Documentation", author, "TamrPythonClient", "One line description of project.", "Miscellaneous", ) ] # -- Options for Epub output ------------------------------------------------- # Bibliographic Dublin Core info. epub_title = project # The unique identifier of the text. This can be a ISBN number # or the project homepage. # # epub_identifier = '' # A unique identification for the text. # # epub_uid = '' # A list of files that should not be packed into the epub file. epub_exclude_files = ["search.html"] def setup(app): """ https://recommonmark.readthedocs.io/en/latest/auto_structify.html#configuring-autostructify """ app.add_config_value( "recommonmark_config", {"enable_auto_toc_tree": True, "auto_toc_maxdepth": 2}, True, ) app.add_transform(AutoStructify) ########################################################################### # 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 # import importlib import sys import os.path from six import string_types 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/"), ("stable", "/en/stable/"), ("0.8.0", "/en/0.8.0/"), ("0.7.0", "/en/0.7.0/"), ("0.6.0", "/en/0.6.0/"), ("0.5.0", "/en/0.5.0/"), ("0.4.0", "/en/0.4.0/"), ("0.3.0", "/en/0.3.0/"), ("0.2.0", "/en/0.2.0/"), ("0.1.0", "/en/0.1.0/"), ], 'downloads': [ ("pdf", "//tamr-tamr-client.readthedocs-hosted.com/_/downloads/en/latest/pdf/"), ("html", "//tamr-tamr-client.readthedocs-hosted.com/_/downloads/en/latest/htmlzip/"), ("epub", "//tamr-tamr-client.readthedocs-hosted.com/_/downloads/en/latest/epub/"), ], 'subprojects': [ ], 'slug': 'tamr-tamr-client', 'name': u'Tamr Client', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://tamr-tamr-client.readthedocs-hosted.com/en/stable/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'Datatamer', 'proxied_api_host': '/_', 'github_repo': 'tamr-client', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', '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': 'a24c31df', } 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") 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' [rtd-command-info] start-time: 2020-07-14T14:03:41.812269Z, end-time: 2020-07-14T14:03:43.238088Z, duration: 1, exit-code: 1 python sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v3.1.1 loading translations [en]... done making output directory... done loading intersphinx inventory from https://docs.python.org/objects.inv... loading intersphinx inventory from https://requests.readthedocs.io/en/master/objects.inv... loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv... intersphinx inventory has moved: https://docs.python.org/objects.inv -> https://docs.python.org/3/objects.inv building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 48 source files that are out of date updating environment: [new config] 48 added, 0 changed, 0 removed reading sources... [ 2%] beta reading sources... [ 4%] beta/attribute reading sources... [ 6%] beta/attribute/attribute /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/latest/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document warn("Container node skipped: type={0}".format(mdnode.t)) ERROR: 'tamr_client' package is in BETA, but you do not have the 'TAMR_CLIENT_BETA' environment variable set to '1'. HINT: For non-BETA features, use only the 'tamr_unify_client' package. HINT: To opt-in to BETA features, set environment variable: 'TAMR_CLIENT_BETA=1'. WARNING: Do not rely on BETA features in production workflows. Support from Tamr may be limited.