Read the Docs build information Build id: 247262 Project: narrativ-narrativ Version: stable Commit: 722d2dbdff78369a1dfa400cd949064025e64261 Date: 2019-10-03T15:57:27.579875Z State: finished Success: True [rtd-command-info] start-time: 2019-10-03T15:57:28.074757Z, end-time: 2019-10-03T15:57:28.705586Z, duration: 0, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/hellonarrativ/api-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2019-10-03T15:57:29.147386Z, end-time: 2019-10-03T15:57:29.231784Z, duration: 0, exit-code: 0 git checkout --force da0dbc846fde96d885169d32e9ac41246e7edcde Note: checking out 'da0dbc846fde96d885169d32e9ac41246e7edcde'. 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 da0dbc8 Remove linkmate docs (#92) [rtd-command-info] start-time: 2019-10-03T15:57:29.400827Z, end-time: 2019-10-03T15:57:29.413598Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2019-10-03T16:04:31.812406Z, end-time: 2019-10-03T16:04:31.830114Z, duration: 0, exit-code: 0 git remote set-url origin https://github.com/hellonarrativ/api-docs.git [rtd-command-info] start-time: 2019-10-03T16:04:31.910713Z, end-time: 2019-10-03T16:04:32.388577Z, duration: 0, exit-code: 0 git fetch origin --force --tags --prune --prune-tags --depth 50 [rtd-command-info] start-time: 2019-10-03T16:04:32.678115Z, end-time: 2019-10-03T16:04:32.689370Z, duration: 0, exit-code: 0 git checkout --force 722d2dbdff78369a1dfa400cd949064025e64261 HEAD is now at 722d2db Merge pull request #93 from hellonarrativ/BAM-4202 [rtd-command-info] start-time: 2019-10-03T16:04:32.833118Z, end-time: 2019-10-03T16:04:32.864893Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2019-10-03T16:04:34.564094Z, end-time: 2019-10-03T16:04:38.095223Z, duration: 3, exit-code: 0 python3.7 -mvirtualenv --no-site-packages --no-download Using base prefix '/home/docs/.pyenv/versions/3.7.1' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/bin/python3.7 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.7) Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2019-10-03T16:04:38.189781Z, end-time: 2019-10-03T16:04:39.244234Z, duration: 1, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (19.2.3) [rtd-command-info] start-time: 2019-10-03T16:04:39.337910Z, end-time: 2019-10-03T16:04:45.652742Z, duration: 6, exit-code: 0 python -m pip install --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.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 https://files.pythonhosted.org/packages/13/e5/6d710c9cf96c31ac82657bcfb441df328b22df8564d58d0c4cd62612674c/Pygments-2.3.1-py2.py3-none-any.whl Collecting setuptools==41.0.1 Using cached https://files.pythonhosted.org/packages/ec/51/f45cea425fd5cb0b0380f5b0f048ebc1da5b417e48d304838c02d6288a1e/setuptools-41.0.1-py2.py3-none-any.whl Collecting docutils==0.14 Using cached https://files.pythonhosted.org/packages/36/fa/08e9e6e0e3cbd1d362c3bbee8d01d0aedb2155c4ac112b19ef3cae8eed8d/docutils-0.14-py3-none-any.whl Requirement already up-to-date: mock==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (1.0.1) Requirement already up-to-date: pillow==5.4.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (5.4.1) Requirement already up-to-date: alabaster!=0.7.5,<0.8,>=0.7 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (0.7.12) Requirement already up-to-date: commonmark==0.8.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (0.8.1) Requirement already up-to-date: recommonmark==0.5.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (0.5.0) Collecting sphinx<2 Using cached https://files.pythonhosted.org/packages/7d/66/a4af242b4348b729b9d46ce5db23943ce9bca7da9bbe2ece60dc27f26420/Sphinx-1.8.5-py2.py3-none-any.whl Requirement already up-to-date: sphinx-rtd-theme<0.5 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (0.4.3) Requirement already up-to-date: readthedocs-sphinx-ext<1.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (1.0.0) Requirement already satisfied, skipping upgrade: future in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from commonmark==0.8.1) (0.17.1) Requirement already satisfied, skipping upgrade: babel!=2.0,>=1.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (2.7.0) Requirement already satisfied, skipping upgrade: packaging in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (19.2) Requirement already satisfied, skipping upgrade: Jinja2>=2.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (2.10.1) Requirement already satisfied, skipping upgrade: requests>=2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (2.22.0) Requirement already satisfied, skipping upgrade: sphinxcontrib-websupport in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (1.1.2) Requirement already satisfied, skipping upgrade: six>=1.5 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (1.12.0) Requirement already satisfied, skipping upgrade: snowballstemmer>=1.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (2.0.0) Requirement already satisfied, skipping upgrade: imagesize in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from sphinx<2) (1.1.0) Requirement already satisfied, skipping upgrade: pytz>=2015.7 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from babel!=2.0,>=1.3->sphinx<2) (2019.2) Requirement already satisfied, skipping upgrade: pyparsing>=2.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from packaging->sphinx<2) (2.4.2) Requirement already satisfied, skipping upgrade: MarkupSafe>=0.23 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from Jinja2>=2.3->sphinx<2) (1.1.1) Requirement already satisfied, skipping upgrade: urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from requests>=2.0.0->sphinx<2) (1.25.6) Requirement already satisfied, skipping upgrade: idna<2.9,>=2.5 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from requests>=2.0.0->sphinx<2) (2.8) Requirement already satisfied, skipping upgrade: certifi>=2017.4.17 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from requests>=2.0.0->sphinx<2) (2019.9.11) Requirement already satisfied, skipping upgrade: chardet<3.1.0,>=3.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from requests>=2.0.0->sphinx<2) (3.0.4) Installing collected packages: Pygments, setuptools, docutils, sphinx Found existing installation: Pygments 2.4.2 Uninstalling Pygments-2.4.2: Successfully uninstalled Pygments-2.4.2 Found existing installation: setuptools 41.2.0 Uninstalling setuptools-41.2.0: Successfully uninstalled setuptools-41.2.0 Found existing installation: docutils 0.15.2 Uninstalling docutils-0.15.2: Successfully uninstalled docutils-0.15.2 Found existing installation: Sphinx 2.2.0 Uninstalling Sphinx-2.2.0: Successfully uninstalled Sphinx-2.2.0 Successfully installed Pygments-2.3.1 docutils-0.14 setuptools-41.0.1 sphinx-1.8.5 [rtd-command-info] start-time: 2019-10-03T16:04:45.738095Z, end-time: 2019-10-03T16:04:51.703090Z, duration: 5, exit-code: 0 python -m pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip -r conf/requirements.txt Requirement already satisfied: alabaster==0.7.12 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 7)) (0.7.12) Requirement already satisfied: argh==0.26.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 11)) (0.26.2) Requirement already satisfied: babel==2.7.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 15)) (2.7.0) Requirement already satisfied: certifi==2019.9.11 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 19)) (2019.9.11) Requirement already satisfied: chardet==3.0.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 23)) (3.0.4) Requirement already satisfied: click==7.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 27)) (7.0) Collecting docutils==0.15.2 (from -r conf/requirements.txt (line 31)) Using cached https://files.pythonhosted.org/packages/22/cd/a6aa959dca619918ccb55023b4cb151949c64d4d5d55b3f4ffd7eee0c6e8/docutils-0.15.2-py3-none-any.whl Requirement already satisfied: idna==2.8 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 36)) (2.8) Requirement already satisfied: imagesize==1.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 40)) (1.1.0) Requirement already satisfied: jinja2==2.10.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 44)) (2.10.1) Requirement already satisfied: livereload==2.6.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 48)) (2.6.1) Requirement already satisfied: markupsafe==1.1.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 52)) (1.1.1) Requirement already satisfied: packaging==19.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 82)) (19.2) Requirement already satisfied: pathtools==0.1.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 86)) (0.1.2) Requirement already satisfied: pip-tools==4.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 89)) (4.1.0) Requirement already satisfied: port_for==0.3.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 92)) (0.3.1) Collecting pygments==2.4.2 (from -r conf/requirements.txt (line 95)) Using cached https://files.pythonhosted.org/packages/5c/73/1dfa428150e3ccb0fa3e68db406e5be48698f2a979ccbcec795f28f44048/Pygments-2.4.2-py2.py3-none-any.whl Requirement already satisfied: pyparsing==2.4.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 99)) (2.4.2) Requirement already satisfied: pytz==2019.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 103)) (2019.2) Requirement already satisfied: pyyaml==4.2b4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 107)) (4.2b4) Requirement already satisfied: requests==2.22.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 113)) (2.22.0) Requirement already satisfied: six==1.12.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 117)) (1.12.0) Requirement already satisfied: snowballstemmer==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 121)) (2.0.0) Requirement already satisfied: sphinx-autobuild==0.7.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 125)) (0.7.1) Requirement already satisfied: sphinx-rtd-theme==0.4.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 128)) (0.4.3) Collecting sphinx==2.2.0 (from -r conf/requirements.txt (line 131)) Using cached https://files.pythonhosted.org/packages/8e/4c/95a21788db2e1653e931420f561015a0bbc9bd4660c4520467ab9e733eb2/Sphinx-2.2.0-py3-none-any.whl Requirement already satisfied: sphinxcontrib-applehelp==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 134)) (1.0.1) Requirement already satisfied: sphinxcontrib-devhelp==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 138)) (1.0.1) Requirement already satisfied: sphinxcontrib-htmlhelp==1.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 142)) (1.0.2) Requirement already satisfied: sphinxcontrib-jsmath==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 146)) (1.0.1) Requirement already satisfied: sphinxcontrib-qthelp==1.0.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 150)) (1.0.2) Requirement already satisfied: sphinxcontrib-serializinghtml==1.1.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 154)) (1.1.3) Requirement already satisfied: tornado==6.0.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 158)) (6.0.3) Requirement already satisfied: urllib3==1.25.6 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 167)) (1.25.6) Requirement already satisfied: watchdog==0.9.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages (from -r conf/requirements.txt (line 171)) (0.9.0) Collecting setuptools==41.2.0 (from -r conf/requirements.txt (line 176)) Using cached https://files.pythonhosted.org/packages/b2/86/095d2f7829badc207c893dd4ac767e871f6cd547145df797ea26baea4e2e/setuptools-41.2.0-py2.py3-none-any.whl Installing collected packages: docutils, pygments, setuptools, sphinx Found existing installation: docutils 0.14 Uninstalling docutils-0.14: Successfully uninstalled docutils-0.14 Found existing installation: Pygments 2.3.1 Uninstalling Pygments-2.3.1: Successfully uninstalled Pygments-2.3.1 Found existing installation: setuptools 41.0.1 Uninstalling setuptools-41.0.1: Successfully uninstalled setuptools-41.0.1 Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed docutils-0.15.2 pygments-2.4.2 setuptools-41.2.0 sphinx-2.2.0 [rtd-command-info] start-time: 2019-10-03T16:04:52.919059Z, end-time: 2019-10-03T16:04:53.236203Z, 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 = '2019, The Narrativ Company, 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.8.5' # The full version, including alpha/beta/rc tags. release = '1.8.5' # 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 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/"), ("1.8.6", "/en/1.8.6/"), ("1.8.5", "/en/1.8.5/"), ("1.8.4", "/en/1.8.4/"), ("1.8.3", "/en/1.8.3/"), ("1.8.2", "/en/1.8.2/"), ("1.8.1", "/en/1.8.1/"), ("1.8.0", "/en/1.8.0/"), ("1.7.14", "/en/1.7.14/"), ("1.7.13", "/en/1.7.13/"), ("1.7.12", "/en/1.7.12/"), ("1.7.11", "/en/1.7.11/"), ("1.7.9", "/en/1.7.9/"), ("1.7.7", "/en/1.7.7/"), ("1.7.6", "/en/1.7.6/"), ("1.7.5", "/en/1.7.5/"), ("1.6.0", "/en/1.6.0/"), ("1.5.0", "/en/1.5.0/"), ], 'downloads': [ ("html", "//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://docs.narrativ.com/en/stable/', 'analytics_code': 'None', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'hellonarrativ', 'github_repo': 'api-docs', 'github_version': '722d2dbdff78369a1dfa400cd949064025e64261', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '722d2dbdff78369a1dfa400cd949064025e64261', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '722d2dbdff78369a1dfa400cd949064025e64261', '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': '722d2dbd', } 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: 2019-10-03T16:04:53.358574Z, end-time: 2019-10-03T16:04:55.564634Z, duration: 2, exit-code: 0 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v2.2.0 loading translations [en]... done making output directory... done loading pickled environment... done building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 19 source files that are out of date updating environment: 0 added, 1 changed, 0 removed reading sources... [100%] index /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/checkouts/stable/docs/index.rst:23: WARNING: toctree contains reference to nonexisting document 'linkmate' looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 5%] amp writing output... [ 10%] auction writing output... [ 15%] auth writing output... [ 21%] clickmate writing output... [ 26%] events writing output... [ 31%] extensionbasics writing output... [ 36%] extensionuse writing output... [ 42%] feeds writing output... [ 47%] index writing output... [ 52%] privacypolicy writing output... [ 57%] productapi writing output... [ 63%] requests writing output... [ 68%] smartlink writing output... [ 73%] smartshopbuild writing output... [ 78%] statistics writing output... [ 84%] tagbasics writing output... [ 89%] tagmerchant writing output... [ 94%] tagpublisher writing output... [100%] tagpublishercustom /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/checkouts/stable/docs/amp.rst:11: WARNING: undefined label: linkmate_api (if the link has no caption the label must precede a section header) /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/checkouts/stable/docs/tagpublishercustom.rst:91: WARNING: unknown document: linkmate generating indices... genindexdone writing additional pages... searchdone copying images... [ 3%] _static/extension_instructions/1.png copying images... [ 6%] _static/extension_instructions/2.png copying images... [ 9%] _static/extension_instructions/3.png copying images... [ 12%] _static/extension_instructions/4.png copying images... [ 16%] _static/extension_instructions/5.png copying images... [ 19%] _static/extension_instructions/1-channel-select.png copying images... [ 22%] _static/extension_instructions/7.png copying images... [ 25%] _static/extension_instructions/6.png copying images... [ 29%] _static/extension_instructions/Dynamic.png copying images... [ 32%] _static/extension_instructions/Exclusive.png copying images... [ 35%] _static/extension_instructions/8.png copying images... [ 38%] _static/builder_instructions/Builder1.png copying images... [ 41%] _static/builder_instructions/Builder2.png copying images... [ 45%] _static/builder_instructions/Builder3.png copying images... [ 48%] _static/builder_instructions/Builder4.png copying images... [ 51%] _static/builder_instructions/Builder5.png copying images... [ 54%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 58%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 61%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 64%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 67%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 70%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 74%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 77%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 80%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 83%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 87%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 90%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 93%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 96%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [100%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.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, 3 warnings. The HTML pages are in _build/html. /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/stable/lib/python3.7/site-packages/sphinx_rtd_theme/search.html:20: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a