Read the Docs build information Build id: 143928 Project: narrativ-narrativ Version: stable Commit: b50e9c1dc5fd411467251a7079703d0e85a632d2 Date: 2018-09-20T21:30:52.241394Z State: finished Success: True [rtd-command-info] start-time: 2018-09-21T02:31:37.203129Z, end-time: 2018-09-21T02:31:37.209316Z, duration: 0, exit-code: 0 git remote set-url origin https://github.com/hellonarrativ/api-docs.git [rtd-command-info] start-time: 2018-09-21T02:31:37.266764Z, end-time: 2018-09-21T02:31:37.460331Z, duration: 0, exit-code: 0 git fetch --tags --prune [rtd-command-info] start-time: 2018-09-21T02:31:37.522565Z, end-time: 2018-09-21T02:31:37.531508Z, duration: 0, exit-code: 0 git checkout --force b50e9c1dc5fd411467251a7079703d0e85a632d2 Previous HEAD position was 17bd2f2... Merge pull request #52 from hellonarrativ/BAM-2195-Linkmate-docs HEAD is now at b50e9c1... Merge pull request #54 from hellonarrativ/BAM-2337 [rtd-command-info] start-time: 2018-09-21T02:31:37.589688Z, end-time: 2018-09-21T02:31:37.596212Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2018-09-21T02:31:37.688918Z, end-time: 2018-09-21T02:31:37.693739Z, duration: 0, exit-code: 0 git branch -r origin/BAM-1466-update-styling origin/BAM-1599 origin/BAM-1671-channel origin/BAM-1942-correct-query-params origin/BAM-1942-pub-stats-quick-fix origin/BAM-1942-pub-stats-read-endpoints origin/BAM-1981 origin/BAM-2026-clickmate origin/BAM-2195-Linkmate-docs origin/HEAD -> origin/master origin/jstag origin/master origin/narrativkevin-patch-1 origin/narrativkevin-patch-2 origin/narrativkevin-patch-3 origin/narrativkevin-patch-4 origin/update-channel [rtd-command-info] start-time: 2018-09-21T02:31:38.375537Z, end-time: 2018-09-21T02:31:40.545325Z, duration: 2, exit-code: 0 python3.5 -mvirtualenv --no-site-packages --no-download Using base prefix '/usr' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/bin/python3.5 Not overwriting existing python script /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/bin/python (you must use /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/bin/python3.5) Installing setuptools, pip, wheel...done. [rtd-command-info] start-time: 2018-09-21T02:31:40.638721Z, end-time: 2018-09-21T02:31:46.623894Z, duration: 5, exit-code: 0 python pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip Pygments==2.2.0 setuptools<40 docutils==0.13.1 mock==1.0.1 pillow==2.6.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.4.0 sphinx<1.8 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<0.6 Requirement already up-to-date: Pygments==2.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: setuptools<40 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: docutils==0.13.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: mock==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: pillow==2.6.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Collecting alabaster!=0.7.5,<0.8,>=0.7 Using cached https://files.pythonhosted.org/packages/6e/71/c3648cc2f675063dbe2d669004a59e4a5120172713a1de3c3b14144d4b31/alabaster-0.7.11-py2.py3-none-any.whl Requirement already up-to-date: commonmark==0.5.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: recommonmark==0.4.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Collecting sphinx<1.8 Using cached https://files.pythonhosted.org/packages/90/f9/a0babe32c78480994e4f1b93315558f5ed756104054a7029c672a8d77b72/Sphinx-1.7.9-py2.py3-none-any.whl Collecting sphinx-rtd-theme<0.5 Using cached https://files.pythonhosted.org/packages/87/30/7460f7b77b6e8a080dd3688f750fe5d5666c49358f8941449c5b128fa97d/sphinx_rtd_theme-0.4.1-py2.py3-none-any.whl Requirement already up-to-date: readthedocs-sphinx-ext<0.6 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages Requirement already up-to-date: packaging in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from sphinx<1.8) Collecting sphinxcontrib-websupport (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/52/69/3c2fbdc3702358c5b34ee25e387b24838597ef099761fc9a42c166796e8f/sphinxcontrib_websupport-1.1.0-py2.py3-none-any.whl Requirement already up-to-date: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from sphinx<1.8) Collecting requests>=2.0.0 (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/65/47/7e02164a2a3db50ed6d8a6ab1d6d60b69c4c3fdf57a284257925dfc12bda/requests-2.19.1-py2.py3-none-any.whl Collecting babel!=2.0,>=1.3 (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/b8/ad/c6f60602d3ee3d92fbed87675b6fb6a6f9a38c223343ababdb44ba201f10/Babel-2.6.0-py2.py3-none-any.whl Collecting Jinja2>=2.3 (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/7f/ff/ae64bacdfc95f27a016a7bed8e8686763ba4d277a78ca76f32659220a731/Jinja2-2.10-py2.py3-none-any.whl Collecting imagesize (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/fc/b6/aef66b4c52a6ad6ac18cf6ebc5731ed06d8c9ae4d3b2d9951f261150be67/imagesize-1.1.0-py2.py3-none-any.whl Collecting six>=1.5 (from sphinx<1.8) Using cached https://files.pythonhosted.org/packages/67/4b/141a581104b1f6397bfa78ac9d43d8ad29a7ca43ea90a2d863fe3056e86a/six-1.11.0-py2.py3-none-any.whl Requirement already up-to-date: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from packaging->sphinx<1.8) Requirement already up-to-date: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from requests>=2.0.0->sphinx<1.8) Collecting urllib3<1.24,>=1.21.1 (from requests>=2.0.0->sphinx<1.8) Using cached https://files.pythonhosted.org/packages/bd/c9/6fdd990019071a4a32a5e7cb78a1d92c53851ef4f56f62a3486e6a7d8ffb/urllib3-1.23-py2.py3-none-any.whl Collecting idna<2.8,>=2.5 (from requests>=2.0.0->sphinx<1.8) Using cached https://files.pythonhosted.org/packages/4b/2a/0276479a4b3caeb8a8c1af2f8e4355746a97fab05a372e4a2c6a6b876165/idna-2.7-py2.py3-none-any.whl Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<1.8) Using cached https://files.pythonhosted.org/packages/df/f7/04fee6ac349e915b82171f8e23cee63644d83663b34c539f7a09aed18f9e/certifi-2018.8.24-py2.py3-none-any.whl Collecting pytz>=0a (from babel!=2.0,>=1.3->sphinx<1.8) Using cached https://files.pythonhosted.org/packages/30/4e/27c34b62430286c6d59177a0842ed90dc789ce5d1ed740887653b898779a/pytz-2018.5-py2.py3-none-any.whl Requirement already up-to-date: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from Jinja2>=2.3->sphinx<1.8) Installing collected packages: alabaster, sphinxcontrib-websupport, urllib3, idna, certifi, requests, pytz, babel, Jinja2, imagesize, six, sphinx, sphinx-rtd-theme Found existing installation: alabaster 0.7.10 Uninstalling alabaster-0.7.10: Successfully uninstalled alabaster-0.7.10 Found existing installation: sphinxcontrib-websupport 1.0.1 Uninstalling sphinxcontrib-websupport-1.0.1: Successfully uninstalled sphinxcontrib-websupport-1.0.1 Found existing installation: urllib3 1.21.1 Uninstalling urllib3-1.21.1: Successfully uninstalled urllib3-1.21.1 Found existing installation: idna 2.5 Uninstalling idna-2.5: Successfully uninstalled idna-2.5 Found existing installation: certifi 2017.4.17 Uninstalling certifi-2017.4.17: Successfully uninstalled certifi-2017.4.17 Found existing installation: requests 2.18.1 Uninstalling requests-2.18.1: Successfully uninstalled requests-2.18.1 Found existing installation: pytz 2017.2 Uninstalling pytz-2017.2: Successfully uninstalled pytz-2017.2 Found existing installation: Babel 2.4.0 Uninstalling Babel-2.4.0: Successfully uninstalled Babel-2.4.0 Found existing installation: Jinja2 2.9.6 Uninstalling Jinja2-2.9.6: Successfully uninstalled Jinja2-2.9.6 Found existing installation: imagesize 0.7.1 Uninstalling imagesize-0.7.1: Successfully uninstalled imagesize-0.7.1 Found existing installation: six 1.10.0 Uninstalling six-1.10.0: Successfully uninstalled six-1.10.0 Found existing installation: Sphinx 1.6.3 Uninstalling Sphinx-1.6.3: Successfully uninstalled Sphinx-1.6.3 Found existing installation: sphinx-rtd-theme 0.2.4 Uninstalling sphinx-rtd-theme-0.2.4: Successfully uninstalled sphinx-rtd-theme-0.2.4 Successfully installed Jinja2-2.10 alabaster-0.7.11 babel-2.6.0 certifi-2018.8.24 idna-2.7 imagesize-1.1.0 pytz-2018.5 requests-2.19.1 six-1.11.0 sphinx-1.7.9 sphinx-rtd-theme-0.4.1 sphinxcontrib-websupport-1.1.0 urllib3-1.23 You are using pip version 9.0.1, however version 18.0 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2018-09-21T02:31:46.711487Z, end-time: 2018-09-21T02:31:51.402943Z, duration: 4, exit-code: 0 python pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip -r conf/requirements.txt Collecting alabaster==0.7.10 (from -r conf/requirements.txt (line 15)) Using cached https://files.pythonhosted.org/packages/2e/c3/9b7dcd8548cf2c00531763ba154e524af575e8f36701bacfe5bcadc67440/alabaster-0.7.10-py2.py3-none-any.whl Requirement already satisfied: argh==0.26.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 16)) Collecting Babel==2.4.0 (from -r conf/requirements.txt (line 17)) Using cached https://files.pythonhosted.org/packages/5f/cf/17935db603f7044d188ce3e3a6545c4b4500dbaa8835d50da2934b738111/Babel-2.4.0-py2.py3-none-any.whl Collecting certifi==2017.4.17 (from -r conf/requirements.txt (line 18)) Using cached https://files.pythonhosted.org/packages/eb/01/c1f58987b777d6c4ec535b4e004a4a07bfc9db06f0c7533367ca6da8f2a6/certifi-2017.4.17-py2.py3-none-any.whl Requirement already satisfied: chardet==3.0.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 19)) Requirement already satisfied: docutils==0.13.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 20)) Collecting idna==2.5 (from -r conf/requirements.txt (line 21)) Using cached https://files.pythonhosted.org/packages/11/7d/9bbbd7bb35f34b0169542487d2a8859e44306bb2e6a4455d491800a5621f/idna-2.5-py2.py3-none-any.whl Collecting imagesize==0.7.1 (from -r conf/requirements.txt (line 22)) Using cached https://files.pythonhosted.org/packages/29/e9/342106962eac603ff7865a29de05e965af6a259e30fbccc6fc5aeac74d70/imagesize-0.7.1-py2.py3-none-any.whl Collecting Jinja2==2.9.6 (from -r conf/requirements.txt (line 23)) Using cached https://files.pythonhosted.org/packages/5e/73/10c45b82a88ed6b7751bd40da31eeefd7b362e07b56a99aa6e56655a0794/Jinja2-2.9.6-py2.py3-none-any.whl Requirement already satisfied: livereload==2.5.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 24)) Requirement already satisfied: MarkupSafe==1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 25)) Requirement already satisfied: pathtools==0.1.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 26)) Requirement already satisfied: port-for==0.3.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 28)) Requirement already satisfied: Pygments==2.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 29)) Collecting pytz==2017.2 (from -r conf/requirements.txt (line 30)) Using cached https://files.pythonhosted.org/packages/55/62/e7cd0e15b76062d298413f14bb4ec3cd8568a22d274427f9c3c7286969f4/pytz-2017.2-py2.py3-none-any.whl Requirement already satisfied: PyYAML==3.12 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 31)) Collecting requests==2.18.1 (from -r conf/requirements.txt (line 32)) Using cached https://files.pythonhosted.org/packages/5a/58/671011e3ff4a06e2969322267d78dcfda1bf4d1576551df1cce93cd7239d/requests-2.18.1-py2.py3-none-any.whl Collecting six==1.10.0 (from -r conf/requirements.txt (line 33)) Using cached https://files.pythonhosted.org/packages/c8/0a/b6723e1bc4c516cb687841499455a8505b44607ab535be01091c0f24f079/six-1.10.0-py2.py3-none-any.whl Requirement already satisfied: snowballstemmer==1.2.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 34)) Collecting Sphinx==1.6.3 (from -r conf/requirements.txt (line 35)) Using cached https://files.pythonhosted.org/packages/2d/96/97bebe9e13284fac32b6712ddf1dab5441f649ef24343ebfec98ba017553/Sphinx-1.6.3-py2.py3-none-any.whl Requirement already satisfied: sphinx-autobuild==0.7.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 36)) Collecting sphinx-rtd-theme==0.2.4 (from -r conf/requirements.txt (line 37)) Using cached https://files.pythonhosted.org/packages/d7/50/849cd05961e7bafda2e0846ba80fa03f5a16a55fc5acc1d9f6bc79eb6fd9/sphinx_rtd_theme-0.2.4-py2.py3-none-any.whl Collecting sphinxcontrib-websupport==1.0.1 (from -r conf/requirements.txt (line 38)) Using cached https://files.pythonhosted.org/packages/56/0f/3ee19ca5e5a1d9751cf4bbeb372d40a46421c4321fe55a4703ba66d0bafb/sphinxcontrib_websupport-1.0.1-py2.py3-none-any.whl Requirement already satisfied: tornado==4.5.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 39)) Collecting urllib3==1.21.1 (from -r conf/requirements.txt (line 40)) Using cached https://files.pythonhosted.org/packages/24/53/f397db567de0aa0e81b211d81c13c41a779f14893e42189cf5bdb97611b2/urllib3-1.21.1-py2.py3-none-any.whl Requirement already satisfied: watchdog==0.8.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from -r conf/requirements.txt (line 41)) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.5/site-packages (from Sphinx==1.6.3->-r conf/requirements.txt (line 35)) Installing collected packages: alabaster, pytz, Babel, certifi, idna, imagesize, Jinja2, urllib3, requests, six, sphinxcontrib-websupport, Sphinx, sphinx-rtd-theme Found existing installation: alabaster 0.7.11 Uninstalling alabaster-0.7.11: Successfully uninstalled alabaster-0.7.11 Found existing installation: pytz 2018.5 Uninstalling pytz-2018.5: Successfully uninstalled pytz-2018.5 Found existing installation: Babel 2.6.0 Uninstalling Babel-2.6.0: Successfully uninstalled Babel-2.6.0 Found existing installation: certifi 2018.8.24 Uninstalling certifi-2018.8.24: Successfully uninstalled certifi-2018.8.24 Found existing installation: idna 2.7 Uninstalling idna-2.7: Successfully uninstalled idna-2.7 Found existing installation: imagesize 1.1.0 Uninstalling imagesize-1.1.0: Successfully uninstalled imagesize-1.1.0 Found existing installation: Jinja2 2.10 Uninstalling Jinja2-2.10: Successfully uninstalled Jinja2-2.10 Found existing installation: urllib3 1.23 Uninstalling urllib3-1.23: Successfully uninstalled urllib3-1.23 Found existing installation: requests 2.19.1 Uninstalling requests-2.19.1: Successfully uninstalled requests-2.19.1 Found existing installation: six 1.11.0 Uninstalling six-1.11.0: Successfully uninstalled six-1.11.0 Found existing installation: sphinxcontrib-websupport 1.1.0 Uninstalling sphinxcontrib-websupport-1.1.0: Successfully uninstalled sphinxcontrib-websupport-1.1.0 Found existing installation: Sphinx 1.7.9 Uninstalling Sphinx-1.7.9: Successfully uninstalled Sphinx-1.7.9 Found existing installation: sphinx-rtd-theme 0.4.1 Uninstalling sphinx-rtd-theme-0.4.1: Successfully uninstalled sphinx-rtd-theme-0.4.1 Successfully installed Babel-2.4.0 Jinja2-2.9.6 Sphinx-1.6.3 alabaster-0.7.10 certifi-2017.4.17 idna-2.5 imagesize-0.7.1 pytz-2017.2 requests-2.18.1 six-1.10.0 sphinx-rtd-theme-0.2.4 sphinxcontrib-websupport-1.0.1 urllib3-1.21.1 You are using pip version 9.0.1, however version 18.0 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2018-09-21T02:31:52.083736Z, end-time: 2018-09-21T02:31:52.153830Z, duration: 0, exit-code: 0 cat docs/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Narrativ API documentation build configuration file, created by # sphinx-quickstart on Mon Jul 24 11:48:40 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # 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 # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.ifconfig'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Narrativ API' copyright = '2018, Narrativ AI, Inc.' author = 'Narrativ' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. (major version 1 corresponds to /api/v1/) version = '1.4.15' # The full version, including alpha/beta/rc tags. release = '1.4.15' # 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 patterns also effect to 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 = 'sphinx' # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # Use Read the Docs theme on all build environments for consistency: # https://docs.readthedocs.io/en/latest/theme.html#read-the-docs-theme 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. # https://github.com/rtfd/sphinx_rtd_theme/blob/master/sphinx_rtd_theme/theme.conf html_theme_options = { 'logo_only': True, 'display_version': False, } # 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". if os.environ.get('READTHEDOCS'): # Don't set '_static' on Read the Docs. It is already the default, # and if you set it explicitly, it breaks Read the Docs. # https://github.com/rtfd/readthedocs.org/issues/1774 html_static_path = [] else: # Static path must be set locally or else files will not be built. html_static_path = ['_static'] html_logo = '_static/narrativ_white_200px.png' # Custom sidebar templates, must be a dictionary that maps document names # to template names. # # This is required for the alabaster theme # refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars html_sidebars = { '**': [ 'about.html', 'navigation.html', 'relations.html', # needs 'show_related': True theme option to display 'searchbox.html', 'donate.html', ] } # -- Options for HTMLHelp output ------------------------------------------ # Output file base name for HTML help builder. htmlhelp_basename = 'NarrativAPIdoc' # -- 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, 'NarrativAPI.tex', 'Narrativ API Documentation', author, '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, 'narrativapi', 'Narrativ API 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, 'NarrativAPI', 'Narrativ API Documentation', author, 'NarrativAPI', 'One line description of project.', 'Miscellaneous'), ] # Custom CSS must be loaded using an extension module. # https://github.com/rtfd/readthedocs.org/issues/2116 def setup(app): app.add_stylesheet('override.css') ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # 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 else: SUFFIX = source_suffix[0] 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') html_static_path.append('/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = False if 'html_theme' in globals(): if html_theme in ['default']: # Allow people to bail with a hack of having an html_style if not 'html_style' in globals(): import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True else: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True 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/"), ("1.4.15", "/en/1.4.15/"), ("1.4.13", "/en/1.4.13/"), ("1.4.12", "/en/1.4.12/"), ("1.4.11", "/en/1.4.11/"), ("1.4.10", "/en/1.4.10/"), ("1.4.9", "/en/1.4.9/"), ], 'downloads': [ ("htmlzip", "//readthedocs.com/projects/narrativ-narrativ/downloads/htmlzip/stable/"), ], 'subprojects': [ ], 'slug': 'narrativ-narrativ', 'name': u'Narrativ', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://narrativ-narrativ.readthedocs-hosted.com/en/stable/', 'analytics_code': '', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'hellonarrativ', 'github_repo': 'api-docs', 'github_version': 'b50e9c1dc5fd411467251a7079703d0e85a632d2', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'b50e9c1dc5fd411467251a7079703d0e85a632d2', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'b50e9c1dc5fd411467251a7079703d0e85a632d2', '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': 'b50e9c1d', } 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"] [rtd-command-info] start-time: 2018-09-21T02:31:52.224681Z, end-time: 2018-09-21T02:31:54.916922Z, duration: 2, exit-code: 0 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.6.3 making output directory... loading translations [en]... done loading pickled environment... done building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 17 source files that are out of date updating environment: [config changed] 17 added, 0 changed, 0 removed reading sources... [ 5%] auction reading sources... [ 11%] auth reading sources... [ 17%] clickmate reading sources... [ 23%] events reading sources... [ 29%] extensionbasics reading sources... [ 35%] extensionuse reading sources... [ 41%] index reading sources... [ 47%] linkmate reading sources... [ 52%] privacypolicy reading sources... [ 58%] requests reading sources... [ 64%] smartlink reading sources... [ 70%] smartshopbuild reading sources... [ 76%] statistics reading sources... [ 82%] tagbasics reading sources... [ 88%] tagmerchant reading sources... [ 94%] tagpublisher reading sources... [100%] tagpublishercustom looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 5%] auction writing output... [ 11%] auth writing output... [ 17%] clickmate writing output... [ 23%] events writing output... [ 29%] extensionbasics writing output... [ 35%] extensionuse writing output... [ 41%] index writing output... [ 47%] linkmate writing output... [ 52%] privacypolicy writing output... [ 58%] requests writing output... [ 64%] smartlink writing output... [ 70%] smartshopbuild writing output... [ 76%] statistics writing output... [ 82%] tagbasics writing output... [ 88%] tagmerchant writing output... [ 94%] tagpublisher writing output... [100%] tagpublishercustom generating indices... genindex writing additional pages... search copying images... [ 3%] _static/extension_instructions/3.png copying images... [ 6%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 9%] _static/extension_instructions/Dynamic.png copying images... [ 12%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 16%] _static/builder_instructions/Builder4.png copying images... [ 19%] _static/extension_instructions/5.png copying images... [ 22%] _static/extension_instructions/Exclusive.png copying images... [ 25%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 29%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 32%] _static/extension_instructions/1-channel-select.png copying images... [ 35%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 38%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 41%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 45%] _static/extension_instructions/6.png copying images... [ 48%] _static/extension_instructions/8.png copying images... [ 51%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 54%] _static/builder_instructions/Builder2.png copying images... [ 58%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 61%] _static/extension_instructions/7.png copying images... [ 64%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 67%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 70%] _static/builder_instructions/Builder5.png copying images... [ 74%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 77%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 80%] _static/extension_instructions/1.png copying images... [ 83%] _static/extension_instructions/2.png copying images... [ 87%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 90%] _static/builder_instructions/Builder1.png copying images... [ 93%] _static/extension_instructions/4.png copying images... [ 96%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [100%] _static/builder_instructions/Builder3.png copying static files... WARNING: html_static_path entry '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static' does not exist 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, 1 warning. [rtd-command-info] start-time: 2018-09-21T02:31:55.034105Z, end-time: 2018-09-21T02:31:56.865138Z, duration: 1, exit-code: 0 python sphinx-build -T -b readthedocssinglehtmllocalmedia -d _build/doctrees-readthedocssinglehtmllocalmedia -D language=en . _build/localmedia Running Sphinx v1.6.3 making output directory... loading translations [en]... done loading pickled environment... done building [mo]: targets for 0 po files that are out of date building [readthedocssinglehtmllocalmedia]: all documents updating environment: [config changed] 17 added, 0 changed, 0 removed reading sources... [ 5%] auction reading sources... [ 11%] auth reading sources... [ 17%] clickmate reading sources... [ 23%] events reading sources... [ 29%] extensionbasics reading sources... [ 35%] extensionuse reading sources... [ 41%] index reading sources... [ 47%] linkmate reading sources... [ 52%] privacypolicy reading sources... [ 58%] requests reading sources... [ 64%] smartlink reading sources... [ 70%] smartshopbuild reading sources... [ 76%] statistics reading sources... [ 82%] tagbasics reading sources... [ 88%] tagmerchant reading sources... [ 94%] tagpublisher reading sources... [100%] tagpublishercustom looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done assembling single document... auth requests smartlink clickmate linkmate auction events statistics tagbasics tagpublisher tagmerchant tagpublishercustom extensionbasics extensionuse smartshopbuild privacypolicy writing... done writing additional files... copying images... [ 3%] _static/builder_instructions/Builder3.png copying images... [ 6%] _static/extension_instructions/6.png copying images... [ 9%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 12%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 16%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 19%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 22%] _static/builder_instructions/Builder1.png copying images... [ 25%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 29%] _static/extension_instructions/3.png copying images... [ 32%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 35%] _static/builder_instructions/Builder5.png copying images... [ 38%] _static/extension_instructions/4.png copying images... [ 41%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 45%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 48%] _static/extension_instructions/Dynamic.png copying images... [ 51%] _static/builder_instructions/Builder4.png copying images... [ 54%] _static/extension_instructions/7.png copying images... [ 58%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 61%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 64%] _static/extension_instructions/Exclusive.png copying images... [ 67%] _static/extension_instructions/8.png copying images... [ 70%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 74%] _static/extension_instructions/1-channel-select.png copying images... [ 77%] _static/extension_instructions/5.png copying images... [ 80%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 83%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 87%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 90%] _static/builder_instructions/Builder2.png copying images... [ 93%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 96%] _static/extension_instructions/2.png copying images... [100%] _static/extension_instructions/1.png copying static files... WARNING: html_static_path entry '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static' does not exist done copying readthedocs static files... done copying extra files... done dumping object inventory... done build succeeded, 1 warning.