Read the Docs build information Build id: 280146 Project: tamr-tamr-client Version: stable Commit: 4c131c03e36b7fcf6b51e82dd6ebcf49165695e4 Date: 2020-01-24T14:42:14.618920Z State: finished Success: True [rtd-command-info] start-time: 2020-01-24T14:42:36.260432Z, end-time: 2020-01-24T14:42:37.174806Z, 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-01-24T14:42:37.446380Z, end-time: 2020-01-24T14:42:37.693633Z, duration: 0, exit-code: 0 git checkout --force 4c131c03e36b7fcf6b51e82dd6ebcf49165695e4 Note: checking out '4c131c03e36b7fcf6b51e82dd6ebcf49165695e4'. 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 4c131c0 Merge pull request #327 from pcattori/release-0.10.0 [rtd-command-info] start-time: 2020-01-24T14:42:37.780644Z, end-time: 2020-01-24T14:42:37.996228Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-01-24T14:42:39.167158Z, end-time: 2020-01-24T14:42:43.757813Z, duration: 4, exit-code: 0 python3.6 -mvirtualenv --no-site-packages --no-download 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/stable/bin/python3.6 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-01-24T14:42:43.836352Z, end-time: 2020-01-24T14:42:46.266669Z, duration: 2, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip pip Collecting pip Using cached https://files.pythonhosted.org/packages/57/36/67f809c135c17ec9b8276466cc57f35b98c240f55c780689ea29fa32f512/pip-20.0.1-py2.py3-none-any.whl Installing collected packages: pip Found existing installation: pip 19.1.1 Uninstalling pip-19.1.1: Successfully uninstalled pip-19.1.1 Successfully installed pip-20.0.1 [rtd-command-info] start-time: 2020-01-24T14:42:46.346650Z, end-time: 2020-01-24T14:42:55.562140Z, duration: 9, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip 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 Using cached Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Requirement already up-to-date: setuptools==41.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (41.0.1) Collecting docutils==0.14 Using cached docutils-0.14-py3-none-any.whl (543 kB) Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip/wheels/15/fd/39/f238f155700d6d5e6231e82ae3ccf3aa7490a1b17d2073251b/mock-1.0.1-py3-none-any.whl Collecting pillow==5.4.1 Using cached Pillow-5.4.1-cp36-cp36m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Using cached alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Using cached commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Using cached recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Using cached Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Using cached sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<1.1 Using cached readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl (14 kB) Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip/wheels/6e/9c/ed/4499c9865ac1002697793e0ae05ba6be33553d098f3347fb94/future-0.18.2-py3-none-any.whl Collecting requests>=2.0.0 Using cached requests-2.22.0-py2.py3-none-any.whl (57 kB) Collecting imagesize Using cached imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting six>=1.5 Using cached six-1.14.0-py2.py3-none-any.whl (10 kB) Collecting packaging Using cached packaging-20.1-py2.py3-none-any.whl (36 kB) Collecting snowballstemmer>=1.1 Using cached snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting sphinxcontrib-websupport Using cached sphinxcontrib_websupport-1.1.2-py2.py3-none-any.whl (39 kB) Collecting babel!=2.0,>=1.3 Using cached Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting Jinja2>=2.3 Using cached Jinja2-2.10.3-py2.py3-none-any.whl (125 kB) Collecting idna<2.9,>=2.5 Using cached idna-2.8-py2.py3-none-any.whl (58 kB) Collecting chardet<3.1.0,>=3.0.2 Using cached chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Using cached urllib3-1.25.8-py2.py3-none-any.whl (125 kB) Collecting certifi>=2017.4.17 Using cached certifi-2019.11.28-py2.py3-none-any.whl (156 kB) Collecting pyparsing>=2.0.2 Using cached pyparsing-2.4.6-py2.py3-none-any.whl (67 kB) Collecting pytz>=2015.7 Using cached pytz-2019.3-py2.py3-none-any.whl (509 kB) Collecting MarkupSafe>=0.23 Using cached MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl (27 kB) Installing collected packages: Pygments, docutils, mock, pillow, alabaster, future, commonmark, idna, chardet, urllib3, certifi, requests, imagesize, six, pyparsing, packaging, snowballstemmer, sphinxcontrib-websupport, pytz, babel, MarkupSafe, Jinja2, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Successfully installed Jinja2-2.10.3 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.8.0 certifi-2019.11.28 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.8 imagesize-1.2.0 mock-1.0.1 packaging-20.1 pillow-5.4.1 pyparsing-2.4.6 pytz-2019.3 readthedocs-sphinx-ext-1.0.1 recommonmark-0.5.0 requests-2.22.0 six-1.14.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.1.2 urllib3-1.25.8 [rtd-command-info] start-time: 2020-01-24T14:42:55.661754Z, end-time: 2020-01-24T14:43:13.564667Z, duration: 17, exit-code: 0 python -m pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip -r docs/requirements.txt Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/checkouts/stable 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 wheel metadata: started Preparing wheel metadata: finished with status 'done' Collecting recommonmark==0.6.0 Using cached recommonmark-0.6.0-py2.py3-none-any.whl (10 kB) Requirement already satisfied: sphinx_rtd_theme==0.4.3 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from -r docs/requirements.txt (line 3)) (0.4.3) Collecting sphinx-autodoc-typehints==1.8.0 Using cached sphinx_autodoc_typehints-1.8.0-py3-none-any.whl (8.1 kB) Collecting Sphinx==2.1.0 Using cached Sphinx-2.1.0-py2.py3-none-any.whl (3.2 MB) Collecting toml==0.10.0 Using cached toml-0.10.0-py2.py3-none-any.whl (25 kB) Collecting dataclasses<0.7.0,>=0.6.0 Using cached dataclasses-0.6-py3-none-any.whl (14 kB) Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip/wheels/c2/95/a2/477b46cfe980061fddc4cb76ed4657eceec35d2b2090355e41/simplejson-3.17.0-cp36-cp36m-linux_x86_64.whl Requirement already satisfied: requests<3.0,>=2.22 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from tamr-unify-client==0.10.0->-r docs/requirements.txt (line 7)) (2.22.0) Requirement already satisfied: docutils>=0.11 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from recommonmark==0.6.0->-r docs/requirements.txt (line 2)) (0.14) Requirement already satisfied: commonmark>=0.8.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from recommonmark==0.6.0->-r docs/requirements.txt (line 2)) (0.8.1) Requirement already satisfied: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (1.2.0) Requirement already satisfied: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2.0.0) Requirement already satisfied: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2.8.0) Requirement already satisfied: packaging in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (20.1) Requirement already satisfied: alabaster<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (0.7.12) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (41.0.1) Requirement already satisfied: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2.10.3) Collecting sphinxcontrib-serializinghtml Using cached sphinxcontrib_serializinghtml-1.1.3-py2.py3-none-any.whl (89 kB) Collecting sphinxcontrib-jsmath Using cached sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-devhelp Using cached sphinxcontrib_devhelp-1.0.1-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-qthelp Using cached sphinxcontrib_qthelp-1.0.2-py2.py3-none-any.whl (90 kB) Requirement already satisfied: Pygments>=2.0 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2.3.1) Collecting sphinxcontrib-htmlhelp Using cached sphinxcontrib_htmlhelp-1.0.2-py2.py3-none-any.whl (96 kB) Collecting sphinxcontrib-applehelp Using cached sphinxcontrib_applehelp-1.0.1-py2.py3-none-any.whl (121 kB) Requirement already satisfied: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0->-r docs/requirements.txt (line 7)) (2019.11.28) Requirement already satisfied: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0->-r docs/requirements.txt (line 7)) (2.8) 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/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0->-r docs/requirements.txt (line 7)) (1.25.8) Requirement already satisfied: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0->-r docs/requirements.txt (line 7)) (3.0.4) Requirement already satisfied: future in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from commonmark>=0.8.1->recommonmark==0.6.0->-r docs/requirements.txt (line 2)) (0.18.2) Requirement already satisfied: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from babel!=2.0,>=1.3->Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2019.3) Requirement already satisfied: six in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from packaging->Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (1.14.0) Requirement already satisfied: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from packaging->Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (2.4.6) Requirement already satisfied: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from Jinja2>=2.3->Sphinx==2.1.0->-r docs/requirements.txt (line 5)) (1.1.1) 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.10.0-py3-none-any.whl size=54391 sha256=3fe2ade7066d592fffb086664edd3c9ce0cf8ca65c49f6f239952ce9b8b05d75 Stored in directory: /tmp/pip-ephem-wheel-cache-jyc3rtfx/wheels/41/33/44/464ccba936ff300353686edf02547012e975cac1f088d54a11 Successfully built tamr-unify-client Installing collected packages: sphinxcontrib-serializinghtml, sphinxcontrib-jsmath, sphinxcontrib-devhelp, sphinxcontrib-qthelp, sphinxcontrib-htmlhelp, sphinxcontrib-applehelp, Sphinx, recommonmark, sphinx-autodoc-typehints, toml, dataclasses, simplejson, 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 Successfully installed Sphinx-2.1.0 dataclasses-0.6 recommonmark-0.6.0 simplejson-3.17.0 sphinx-autodoc-typehints-1.8.0 sphinxcontrib-applehelp-1.0.1 sphinxcontrib-devhelp-1.0.1 sphinxcontrib-htmlhelp-1.0.2 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.2 sphinxcontrib-serializinghtml-1.1.3 tamr-unify-client-0.10.0 toml-0.10.0 [rtd-command-info] start-time: 2020-01-24T14:43:13.666928Z, end-time: 2020-01-24T14:43:24.214926Z, duration: 10, exit-code: 0 python -m pip install --upgrade --upgrade-strategy eager --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/.cache/pip /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/checkouts/stable Processing /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/checkouts/stable 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 wheel metadata: started Preparing wheel metadata: finished with status 'done' Requirement already up-to-date: simplejson<4.0,>=3.16 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from tamr-unify-client==0.10.0) (3.17.0) Requirement already up-to-date: dataclasses<0.7.0,>=0.6.0 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from tamr-unify-client==0.10.0) (0.6) Requirement already up-to-date: requests<3.0,>=2.22 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from tamr-unify-client==0.10.0) (2.22.0) 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/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0) (1.25.8) Requirement already up-to-date: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0) (2019.11.28) Requirement already up-to-date: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0) (3.0.4) Requirement already up-to-date: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages (from requests<3.0,>=2.22->tamr-unify-client==0.10.0) (2.8) 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.10.0-py3-none-any.whl size=54391 sha256=3fe2ade7066d592fffb086664edd3c9ce0cf8ca65c49f6f239952ce9b8b05d75 Stored in directory: /tmp/pip-ephem-wheel-cache-fgav93da/wheels/41/33/44/464ccba936ff300353686edf02547012e975cac1f088d54a11 Successfully built tamr-unify-client Installing collected packages: tamr-unify-client Attempting uninstall: tamr-unify-client Found existing installation: tamr-unify-client 0.10.0 Uninstalling tamr-unify-client-0.10.0: Successfully uninstalled tamr-unify-client-0.10.0 Successfully installed tamr-unify-client-0.10.0 [rtd-command-info] start-time: 2020-01-24T14:43:26.181666Z, end-time: 2020-01-24T14:43:26.425180Z, 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 import recommonmark from recommonmark.transform import AutoStructify import toml sys.path.insert(0, os.path.abspath("..")) # -- Project information ----------------------------------------------------- project = "Tamr - Python Client" copyright = "2019, Tamr" 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_flags = ["inherited-members", "members"] autodoc_member_order = "bysource" autosectionlabel_prefix_document = True intersphinx_mapping = { "https://docs.python.org/": None, "requests": ("https://requests.kennethreitz.org/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" # 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_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://media.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "stable", 'version_slug': "stable", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://media.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/stable/pdf/"), ("html", "//tamr-tamr-client.readthedocs-hosted.com/_/downloads/en/stable/htmlzip/"), ("epub", "//tamr-tamr-client.readthedocs-hosted.com/_/downloads/en/stable/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', 'proxied_api_host': 'https://readthedocs.com', 'github_user': 'Datatamer', 'github_repo': 'tamr-client', 'github_version': '4c131c03e36b7fcf6b51e82dd6ebcf49165695e4', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '4c131c03e36b7fcf6b51e82dd6ebcf49165695e4', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '4c131c03e36b7fcf6b51e82dd6ebcf49165695e4', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '4c131c03', } 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 'tag' == '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-01-24T14:43:26.523992Z, end-time: 2020-01-24T14:43:34.909890Z, duration: 8, exit-code: 0 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v2.1.0 loading translations [en]... done making output directory... done 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 loading intersphinx inventory from https://requests.kennethreitz.org/en/master/objects.inv... loading intersphinx inventory from https://pandas.pydata.org/pandas-docs/stable/objects.inv... building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 12 source files that are out of date updating environment: 12 added, 0 changed, 0 removed reading sources... [ 8%] contributor-guide reading sources... [ 16%] developer-interface reading sources... [ 25%] index reading sources... [ 33%] user-guide/advanced-usage reading sources... [ 41%] user-guide/faq reading sources... [ 50%] user-guide/geo reading sources... [ 58%] user-guide/installation reading sources... [ 66%] user-guide/logging reading sources... [ 75%] user-guide/quickstart reading sources... [ 83%] user-guide/secure-credentials reading sources... [ 91%] user-guide/spec reading sources... [100%] user-guide/workflows looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 8%] contributor-guide writing output... [ 16%] developer-interface writing output... [ 25%] index writing output... [ 33%] user-guide/advanced-usage writing output... [ 41%] user-guide/faq writing output... [ 50%] user-guide/geo writing output... [ 58%] user-guide/installation writing output... [ 66%] user-guide/logging writing output... [ 75%] user-guide/quickstart writing output... [ 83%] user-guide/secure-credentials writing output... [ 91%] user-guide/spec writing output... [100%] user-guide/workflows generating indices... genindex highlighting module code... [ 2%] tamr_unify_client.attribute.collection highlighting module code... [ 5%] tamr_unify_client.attribute.resource highlighting module code... [ 8%] tamr_unify_client.attribute.subattribute highlighting module code... [ 10%] tamr_unify_client.attribute.type highlighting module code... [ 13%] tamr_unify_client.auth.username_password highlighting module code... [ 16%] tamr_unify_client.base_collection highlighting module code... [ 18%] tamr_unify_client.base_model highlighting module code... [ 21%] tamr_unify_client.base_resource highlighting module code... [ 24%] tamr_unify_client.categorization.category.collection highlighting module code... [ 27%] tamr_unify_client.categorization.category.resource highlighting module code... [ 29%] tamr_unify_client.categorization.project highlighting module code... [ 32%] tamr_unify_client.categorization.taxonomy highlighting module code... [ 35%] tamr_unify_client.client highlighting module code... [ 37%] tamr_unify_client.dataset.collection highlighting module code... [ 40%] tamr_unify_client.dataset.profile highlighting module code... [ 43%] tamr_unify_client.dataset.resource highlighting module code... [ 45%] tamr_unify_client.dataset.status highlighting module code... [ 48%] tamr_unify_client.dataset.uri highlighting module code... [ 51%] tamr_unify_client.dataset.usage highlighting module code... [ 54%] tamr_unify_client.dataset.use highlighting module code... [ 56%] tamr_unify_client.mastering.binning_model highlighting module code... [ 59%] tamr_unify_client.mastering.estimated_pair_counts highlighting module code... [ 62%] tamr_unify_client.mastering.project highlighting module code... [ 64%] tamr_unify_client.mastering.published_cluster.configuration highlighting module code... [ 67%] tamr_unify_client.mastering.published_cluster.metric highlighting module code... [ 70%] tamr_unify_client.mastering.published_cluster.record highlighting module code... [ 72%] tamr_unify_client.mastering.published_cluster.record_version highlighting module code... [ 75%] tamr_unify_client.mastering.published_cluster.resource highlighting module code... [ 78%] tamr_unify_client.mastering.published_cluster.version highlighting module code... [ 81%] tamr_unify_client.operation highlighting module code... [ 83%] tamr_unify_client.project.attribute_configuration.collection highlighting module code... [ 86%] tamr_unify_client.project.attribute_configuration.resource highlighting module code... [ 89%] tamr_unify_client.project.attribute_mapping.collection highlighting module code... [ 91%] tamr_unify_client.project.attribute_mapping.resource highlighting module code... [ 94%] tamr_unify_client.project.collection highlighting module code... [ 97%] tamr_unify_client.project.resource highlighting module code... [100%] tamr_unify_client.project.step writing additional pages... search copying images... [ 50%] resource:collectionRoute.png copying images... [100%] resource:collectionRequest.png copying static files... done copying readthedocs static files... done copying searchtools... done copying extra files... done dumping search index in English (code: en) ... done dumping object inventory... done build succeeded. The HTML pages are in _build/html. /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages/sphinx/events.py:103: RemovedInSphinx30Warning: autodoc_default_flags is now deprecated. Please use autodoc_default_options instead. results.append(callback(self.app, *args)) /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages/recommonmark/parser.py:75: UserWarning: Container node skipped: type=document warn("Container node skipped: type={0}".format(mdnode.t)) /home/docs/checkouts/readthedocs.org/user_builds/tamr-tamr-client/envs/stable/lib/python3.6/site-packages/sphinx_rtd_theme/search.html:20: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a