Read the Docs build information Build id: 672870 Project: narrativ-narrativ Version: latest Commit: eb6be930eb28dab027aca7c421d64ce2ba5057e7 Date: 2021-07-08T16:41:36.176046Z State: finished Success: True [rtd-command-info] start-time: 2021-07-08T16:42:20.418259Z, end-time: 2021-07-08T16:42:21.825671Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 https://github.com/hellonarrativ/api-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2021-07-08T16:42:21.965555Z, end-time: 2021-07-08T16:42:22.139810Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at eb6be93 Merge pull request #151 from hellonarrativ/PT-38 [rtd-command-info] start-time: 2021-07-08T16:42:22.247798Z, end-time: 2021-07-08T16:42:22.315752Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2021-07-08T16:42:22.421777Z, end-time: 2021-07-08T16:42:22.493962Z, duration: 0, exit-code: 0 git rev-parse HEAD eb6be930eb28dab027aca7c421d64ce2ba5057e7 [rtd-command-info] start-time: 2021-07-08T16:42:23.428745Z, end-time: 2021-07-08T16:42:27.618668Z, duration: 4, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.9' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2021-07-08T16:42:27.727599Z, end-time: 2021-07-08T16:42:28.842868Z, duration: 1, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip setuptools Requirement already satisfied: pip in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (21.1.3) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (57.1.0) [rtd-command-info] start-time: 2021-07-08T16:42:28.963543Z, end-time: 2021-07-08T16:42:37.270350Z, duration: 8, exit-code: 0 python -m pip install --upgrade --no-cache-dir mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.2 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.12-py2.py3-none-any.whl (14 kB) Collecting commonmark==0.8.1 Downloading commonmark-0.8.1-py2.py3-none-any.whl (47 kB) Collecting recommonmark==0.5.0 Downloading recommonmark-0.5.0-py2.py3-none-any.whl (9.8 kB) Collecting sphinx<2 Downloading Sphinx-1.8.5-py2.py3-none-any.whl (3.1 MB) Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) Collecting readthedocs-sphinx-ext<2.2 Downloading readthedocs_sphinx_ext-2.1.4-py2.py3-none-any.whl (29 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting docutils>=0.11 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from sphinx<2) (57.1.0) Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting requests>=2.0.0 Downloading requests-2.25.1-py2.py3-none-any.whl (61 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.0.1-py3-none-any.whl (133 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.1.0-py2.py3-none-any.whl (93 kB) Collecting packaging Downloading packaging-21.0-py3-none-any.whl (40 kB) Collecting Pygments>=2.0 Downloading Pygments-2.9.0-py3-none-any.whl (1.0 MB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting pytz>=2015.7 Downloading pytz-2021.1-py2.py3-none-any.whl (510 kB) Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.0.1-cp37-cp37m-manylinux2010_x86_64.whl (31 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.5.30-py2.py3-none-any.whl (145 kB) Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.6-py2.py3-none-any.whl (138 kB) Collecting chardet<5,>=3.0.2 Downloading chardet-4.0.0-py2.py3-none-any.whl (178 kB) Collecting idna<3,>=2.5 Downloading idna-2.10-py2.py3-none-any.whl (58 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.7-py2.py3-none-any.whl (67 kB) Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23772 sha256=5a0cb48bad0d4053c2f458ede5d7113f24390774aaabe0960ecce1f51cbe2f98 Stored in directory: /tmp/pip-ephem-wheel-cache-klwdkj28/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=1c5993d897831c5d817188485652f1d72c78bae86775135bb8878ac1cecc1c6c Stored in directory: /tmp/pip-ephem-wheel-cache-klwdkj28/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: urllib3, sphinxcontrib-serializinghtml, pytz, pyparsing, MarkupSafe, idna, chardet, certifi, sphinxcontrib-websupport, snowballstemmer, six, requests, Pygments, packaging, Jinja2, imagesize, future, docutils, babel, alabaster, sphinx, commonmark, sphinx-rtd-theme, recommonmark, readthedocs-sphinx-ext, pillow, mock Successfully installed Jinja2-3.0.1 MarkupSafe-2.0.1 Pygments-2.9.0 alabaster-0.7.12 babel-2.9.1 certifi-2021.5.30 chardet-4.0.0 commonmark-0.8.1 docutils-0.17.1 future-0.18.2 idna-2.10 imagesize-1.2.0 mock-1.0.1 packaging-21.0 pillow-5.4.1 pyparsing-2.4.7 pytz-2021.1 readthedocs-sphinx-ext-2.1.4 recommonmark-0.5.0 requests-2.25.1 six-1.16.0 snowballstemmer-2.1.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-1.26.6 [rtd-command-info] start-time: 2021-07-08T16:42:37.405737Z, end-time: 2021-07-08T16:42:43.629093Z, duration: 6, exit-code: 0 python -m pip install --exists-action=w --no-cache-dir -r conf/requirements.txt Requirement already satisfied: alabaster==0.7.12 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 7)) (0.7.12) Requirement already satisfied: babel==2.9.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 11)) (2.9.1) Requirement already satisfied: certifi==2021.5.30 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 15)) (2021.5.30) Requirement already satisfied: chardet==4.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 19)) (4.0.0) Collecting click==8.0.1 Downloading click-8.0.1-py3-none-any.whl (97 kB) Collecting colorama==0.4.4 Downloading colorama-0.4.4-py2.py3-none-any.whl (16 kB) Collecting docutils==0.16 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Requirement already satisfied: idna==2.10 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 37)) (2.10) Requirement already satisfied: imagesize==1.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 41)) (1.2.0) Collecting importlib-metadata==4.6.1 Downloading importlib_metadata-4.6.1-py3-none-any.whl (17 kB) Requirement already satisfied: jinja2==3.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 51)) (3.0.1) Collecting livereload==2.6.3 Downloading livereload-2.6.3.tar.gz (25 kB) Requirement already satisfied: markupsafe==2.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 58)) (2.0.1) Requirement already satisfied: packaging==21.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 94)) (21.0) Collecting pep517==0.10.0 Downloading pep517-0.10.0-py2.py3-none-any.whl (19 kB) Collecting pip-tools==6.2.0 Downloading pip_tools-6.2.0-py3-none-any.whl (46 kB) Requirement already satisfied: pygments==2.9.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 106)) (2.9.0) Requirement already satisfied: pyparsing==2.4.7 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 110)) (2.4.7) Requirement already satisfied: pytz==2021.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 114)) (2021.1) Collecting pyyaml==4.2b4 Downloading PyYAML-4.2b4.tar.gz (262 kB) Requirement already satisfied: requests==2.25.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 125)) (2.25.1) Requirement already satisfied: six==1.16.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 129)) (1.16.0) Requirement already satisfied: snowballstemmer==2.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 133)) (2.1.0) Collecting sphinx-autobuild==2021.3.14 Downloading sphinx_autobuild-2021.3.14-py3-none-any.whl (9.9 kB) Collecting sphinx-rtd-theme==0.5.2 Downloading sphinx_rtd_theme-0.5.2-py2.py3-none-any.whl (9.1 MB) Collecting sphinx==4.0.3 Downloading Sphinx-4.0.3-py3-none-any.whl (2.9 MB) Collecting sphinxcontrib-applehelp==1.0.2 Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) Collecting sphinxcontrib-devhelp==1.0.2 Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) Collecting sphinxcontrib-htmlhelp==2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) Collecting sphinxcontrib-jsmath==1.0.1 Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-qthelp==1.0.3 Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) Requirement already satisfied: sphinxcontrib-serializinghtml==1.1.5 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 172)) (1.1.5) Collecting toml==0.10.2 Downloading toml-0.10.2-py2.py3-none-any.whl (16 kB) Collecting tornado==6.1 Downloading tornado-6.1-cp37-cp37m-manylinux2010_x86_64.whl (428 kB) Collecting typing-extensions==3.10.0.0 Downloading typing_extensions-3.10.0.0-py3-none-any.whl (26 kB) Requirement already satisfied: urllib3==1.26.6 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 228)) (1.26.6) Requirement already satisfied: wheel==0.36.2 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 232)) (0.36.2) Collecting zipp==3.5.0 Downloading zipp-3.5.0-py3-none-any.whl (5.7 kB) Requirement already satisfied: pip==21.1.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 244)) (21.1.3) Requirement already satisfied: setuptools==57.1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.7/site-packages (from -r conf/requirements.txt (line 248)) (57.1.0) Building wheels for collected packages: livereload, pyyaml Building wheel for livereload (setup.py): started Building wheel for livereload (setup.py): finished with status 'done' Created wheel for livereload: filename=livereload-2.6.3-py2.py3-none-any.whl size=24726 sha256=ba34bcfe2d097cbd323081de413ed25afd01c7f28d1866080a8918a78bb0f98c Stored in directory: /tmp/pip-ephem-wheel-cache-r7dyspgs/wheels/d4/f2/03/55f37093eb8cb0c89d7efb206f792dba55cd5bd67b1c5b1ce1 Building wheel for pyyaml (setup.py): started Building wheel for pyyaml (setup.py): finished with status 'done' Created wheel for pyyaml: filename=PyYAML-4.2b4-cp37-cp37m-linux_x86_64.whl size=43047 sha256=aed8c7af506a8453355827acb7ef92fdad562c028f55dbccde40eb524ebce7ae Stored in directory: /tmp/pip-ephem-wheel-cache-r7dyspgs/wheels/06/a6/83/224e726cacb89d8d459811ac7c30825ef0afb75192fe934f22 Successfully built livereload pyyaml Installing collected packages: zipp, typing-extensions, tornado, toml, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, importlib-metadata, docutils, sphinx, pep517, livereload, colorama, click, sphinx-rtd-theme, sphinx-autobuild, pyyaml, pip-tools Attempting uninstall: docutils Found existing installation: docutils 0.17.1 Uninstalling docutils-0.17.1: Successfully uninstalled docutils-0.17.1 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Attempting uninstall: sphinx-rtd-theme Found existing installation: sphinx-rtd-theme 0.4.3 Uninstalling sphinx-rtd-theme-0.4.3: Successfully uninstalled sphinx-rtd-theme-0.4.3 Successfully installed click-8.0.1 colorama-0.4.4 docutils-0.16 importlib-metadata-4.6.1 livereload-2.6.3 pep517-0.10.0 pip-tools-6.2.0 pyyaml-4.2b4 sphinx-4.0.3 sphinx-autobuild-2021.3.14 sphinx-rtd-theme-0.5.2 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 toml-0.10.2 tornado-6.1 typing-extensions-3.10.0.0 zipp-3.5.0 [rtd-command-info] start-time: 2021-07-08T16:42:45.290161Z, end-time: 2021-07-08T16:42:45.381154Z, duration: 0, exit-code: 0 git rev-parse HEAD eb6be930eb28dab027aca7c421d64ce2ba5057e7 [rtd-command-info] start-time: 2021-07-08T16:42:45.634951Z, end-time: 2021-07-08T16:42:45.709113Z, 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 = '2020, 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.9.21' # The full version, including alpha/beta/rc tags. release = '1.9.21' # 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_css_file('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 # # Note: this file should't rely on extra depencies. import importlib import sys import os.path # Borrowed from six. PY3 = sys.version_info[0] == 3 string_types = str if PY3 else basestring from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix elif isinstance(source_suffix, (list, tuple)): # Sphinx >= 1.3 supports list/tuple to define multiple suffixes SUFFIX = source_suffix[0] elif isinstance(source_suffix, dict): # Sphinx >= 1.8 supports a mapping dictionary for multiple suffixes SUFFIX = list(source_suffix.keys())[0] # make a ``list()`` for py2/py3 compatibility else: # default to .rst SUFFIX = '.rst' else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = ( ( 'html_theme' in globals() and html_theme in ['default'] and # Allow people to bail with a hack of having an html_style 'html_style' not in globals() ) or 'html_theme' not in globals() ) if using_rtd_theme: theme = importlib.import_module('sphinx_rtd_theme') html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(theme.get_html_theme_path()) else: html_theme_path = [theme.get_html_theme_path()] if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' websupport2_static_url = 'https://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'STATIC_URL': "https://assets.readthedocs.com/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("1.9.21", "/en/1.9.21/"), ("1.9.12", "/en/1.9.12/"), ("1.9.11", "/en/1.9.11/"), ("1.9.10", "/en/1.9.10/"), ("1.9.6", "/en/1.9.6/"), ("1.9.5", "/en/1.9.5/"), ("1.9.4", "/en/1.9.4/"), ("1.9.3", "/en/1.9.3/"), ("1.9.2", "/en/1.9.2/"), ("1.9.1", "/en/1.9.1/"), ("1.9.0", "/en/1.9.0/"), ("1.8.9", "/en/1.8.9/"), ("1.8.8", "/en/1.8.8/"), ("1.8.7", "/en/1.8.7/"), ("1.8.6", "/en/1.8.6/"), ("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", "//docs.narrativ.com/_/downloads/en/latest/htmlzip/"), ], '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', 'proxied_api_host': '/_', 'github_repo': 'api-docs', 'github_version': 'master', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'master', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'master', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'ad_free': False, 'docsearch_disabled': False, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': 'eb6be930', } # For sphinx >=1.8 we can use html_baseurl to set the canonical URL. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_baseurl if version_info >= (1, 8): if not globals().get('html_baseurl'): html_baseurl = context['canonical_url'] context['canonical_url'] = None if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") readthedocs_vcs_url = 'None' readthedocs_build_url = 'https://readthedocs.com/projects/narrativ-narrativ/builds/672870/' project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' # Make sure our build directory is always excluded exclude_patterns = globals().get('exclude_patterns', []) exclude_patterns.extend(['_build']) [rtd-command-info] start-time: 2021-07-08T16:42:45.832320Z, end-time: 2021-07-08T16:42:48.333479Z, duration: 2, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html Running Sphinx v4.0.3 loading translations [en]... done making output directory... done building [mo]: targets for 0 po files that are out of date building [html]: targets for 22 source files that are out of date updating environment: [new config] 22 added, 0 changed, 0 removed reading sources... [ 4%] amp reading sources... [ 9%] auction reading sources... [ 13%] auth reading sources... [ 18%] clickmate reading sources... [ 22%] events reading sources... [ 27%] extensionbasics reading sources... [ 31%] extensionuse reading sources... [ 36%] feeds reading sources... [ 40%] index reading sources... [ 45%] merchantfeeds reading sources... [ 50%] mobile_link reading sources... [ 54%] privacypolicy reading sources... [ 59%] productapi reading sources... [ 63%] requests reading sources... [ 68%] smartlink reading sources... [ 72%] smartshopbuild reading sources... [ 77%] statistics reading sources... [ 81%] tagbasics reading sources... [ 86%] tagbrand reading sources... [ 90%] tagpublisher reading sources... [ 95%] tagpublishercustom reading sources... [100%] utmsourcetracking looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 4%] amp writing output... [ 9%] auction writing output... [ 13%] auth writing output... [ 18%] clickmate writing output... [ 22%] events writing output... [ 27%] extensionbasics writing output... [ 31%] extensionuse writing output... [ 36%] feeds writing output... [ 40%] index writing output... [ 45%] merchantfeeds writing output... [ 50%] mobile_link writing output... [ 54%] privacypolicy writing output... [ 59%] productapi writing output... [ 63%] requests writing output... [ 68%] smartlink writing output... [ 72%] smartshopbuild writing output... [ 77%] statistics writing output... [ 81%] tagbasics writing output... [ 86%] tagbrand writing output... [ 90%] tagpublisher writing output... [ 95%] tagpublishercustom writing output... [100%] utmsourcetracking generating indices... genindex done writing additional pages... search done copying images... [ 2%] _static/extension_instructions/1.png copying images... [ 4%] _static/extension_instructions/2.png copying images... [ 7%] _static/extension_instructions/3.png copying images... [ 9%] _static/extension_instructions/4.png copying images... [ 12%] _static/extension_instructions/5.png copying images... [ 14%] _static/extension_instructions/account-switch.png copying images... [ 17%] _static/extension_instructions/6.png copying images... [ 19%] _static/extension_instructions/7.png copying images... [ 21%] _static/extension_instructions/8.png copying images... [ 24%] _static/extension_instructions/9.png copying images... [ 26%] _static/extension_instructions/10.png copying images... [ 29%] _static/extension_instructions/11.png copying images... [ 31%] _static/extension_instructions/12.png copying images... [ 34%] _static/mobile_link_instructions/1-ios.png copying images... [ 36%] _static/mobile_link_instructions/1-android.png copying images... [ 39%] _static/mobile_link_instructions/1.png copying images... [ 41%] _static/mobile_link_instructions/2.png copying images... [ 43%] _static/mobile_link_instructions/3.png copying images... [ 46%] _static/builder_instructions/Builder1.png copying images... [ 48%] _static/builder_instructions/Builder2.png copying images... [ 51%] _static/builder_instructions/Builder3.png copying images... [ 53%] _static/builder_instructions/Builder4.png copying images... [ 56%] _static/builder_instructions/Builder5.png copying images... [ 58%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 60%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 63%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 65%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 68%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 70%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 73%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 75%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 78%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 80%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 82%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 85%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 87%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 90%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 92%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 95%] _static/pixel_implementation_screenshots/test_page_impression.png copying images... [ 97%] _static/pixel_implementation_screenshots/test_checkouts.png copying images... [100%] _static/pixel_implementation_screenshots/test_checkouts_payload.png copying static files... 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. Updating searchtools for Read the Docs search... [rtd-command-info] start-time: 2021-07-08T16:42:48.505169Z, end-time: 2021-07-08T16:42:49.618008Z, duration: 1, exit-code: 0 python -m sphinx -T -b readthedocssinglehtmllocalmedia -d _build/doctrees -D language=en . _build/localmedia Running Sphinx v4.0.3 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 [readthedocssinglehtmllocalmedia]: all documents updating environment: 0 added, 0 changed, 0 removed looking for now-outdated files... none found preparing documents... done assembling single document... auth requests smartlink clickmate productapi merchantfeeds utmsourcetracking auction amp events statistics tagbasics tagpublisher tagbrand tagpublishercustom extensionbasics extensionuse smartshopbuild mobile_link feeds privacypolicy done writing... done writing additional files... done copying images... [ 2%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 4%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 7%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 9%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 12%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 14%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 17%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 19%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 21%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 24%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 26%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 29%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 31%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 34%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 36%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 39%] _static/pixel_implementation_screenshots/test_page_impression.png copying images... [ 41%] _static/pixel_implementation_screenshots/test_checkouts.png copying images... [ 43%] _static/pixel_implementation_screenshots/test_checkouts_payload.png copying images... [ 46%] _static/extension_instructions/1.png copying images... [ 48%] _static/extension_instructions/2.png copying images... [ 51%] _static/extension_instructions/3.png copying images... [ 53%] _static/extension_instructions/4.png copying images... [ 56%] _static/extension_instructions/5.png copying images... [ 58%] _static/extension_instructions/account-switch.png copying images... [ 60%] _static/extension_instructions/6.png copying images... [ 63%] _static/extension_instructions/7.png copying images... [ 65%] _static/extension_instructions/8.png copying images... [ 68%] _static/extension_instructions/9.png copying images... [ 70%] _static/extension_instructions/10.png copying images... [ 73%] _static/extension_instructions/11.png copying images... [ 75%] _static/extension_instructions/12.png copying images... [ 78%] _static/builder_instructions/Builder1.png copying images... [ 80%] _static/builder_instructions/Builder2.png copying images... [ 82%] _static/builder_instructions/Builder3.png copying images... [ 85%] _static/builder_instructions/Builder4.png copying images... [ 87%] _static/builder_instructions/Builder5.png copying images... [ 90%] _static/mobile_link_instructions/1-ios.png copying images... [ 92%] _static/mobile_link_instructions/1-android.png copying images... [ 95%] _static/mobile_link_instructions/1.png copying images... [ 97%] _static/mobile_link_instructions/2.png copying images... [100%] _static/mobile_link_instructions/3.png copying static files... done copying extra files... done dumping object inventory... done build succeeded. The HTML page is in _build/localmedia. Updating searchtools for Read the Docs search...