Read the Docs build information Build id: 303867 Project: narrativ-narrativ Version: 1.8.8 Commit: b04fc7308de78fe042d912940b899799c163daa3 Date: 2020-03-18T19:29:18.663363Z State: finished Success: True [rtd-command-info] start-time: 2020-03-18T19:29:21.585601Z, end-time: 2020-03-18T19:29:23.096284Z, 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: 2020-03-18T19:29:23.515825Z, end-time: 2020-03-18T19:29:23.898192Z, duration: 0, exit-code: 0 git checkout --force b04fc7308de78fe042d912940b899799c163daa3 Note: checking out 'b04fc7308de78fe042d912940b899799c163daa3'. 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 b04fc73 Merge pull request #102 from hellonarrativ/BAM-5071 [rtd-command-info] start-time: 2020-03-18T19:29:24.142017Z, end-time: 2020-03-18T19:29:24.454800Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2020-03-18T19:29:25.804898Z, end-time: 2020-03-18T19:29:31.229977Z, duration: 5, exit-code: 0 python3.7 -mvirtualenv Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/bin/python3.7 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2020-03-18T19:29:31.394022Z, end-time: 2020-03-18T19:29:32.387637Z, duration: 0, exit-code: 0 python -m pip install --upgrade --no-cache-dir pip Requirement already up-to-date: pip in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (20.0.2) [rtd-command-info] start-time: 2020-03-18T19:29:32.543963Z, end-time: 2020-03-18T19:29:44.217568Z, duration: 11, exit-code: 0 python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818 kB) Collecting pillow==5.4.1 Downloading Pillow-5.4.1-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<1.1 Downloading readthedocs_sphinx_ext-1.0.1-py2.py3-none-any.whl (14 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) Collecting six>=1.5 Downloading six-1.14.0-py2.py3-none-any.whl (10 kB) Collecting Jinja2>=2.3 Downloading Jinja2-2.11.1-py2.py3-none-any.whl (126 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.0-py2.py3-none-any.whl (39 kB) Collecting packaging Downloading packaging-20.3-py2.py3-none-any.whl (37 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.8.0-py2.py3-none-any.whl (8.6 MB) Collecting imagesize Downloading imagesize-1.2.0-py2.py3-none-any.whl (4.8 kB) Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.0.0-py2.py3-none-any.whl (97 kB) Collecting requests>=2.0.0 Downloading requests-2.23.0-py2.py3-none-any.whl (58 kB) Collecting MarkupSafe>=0.23 Downloading MarkupSafe-1.1.1-cp37-cp37m-manylinux1_x86_64.whl (27 kB) Collecting pyparsing>=2.0.2 Downloading pyparsing-2.4.6-py2.py3-none-any.whl (67 kB) Collecting pytz>=2015.7 Downloading pytz-2019.3-py2.py3-none-any.whl (509 kB) Collecting urllib3!=1.25.0,!=1.25.1,<1.26,>=1.21.1 Downloading urllib3-1.25.8-py2.py3-none-any.whl (125 kB) Collecting certifi>=2017.4.17 Downloading certifi-2019.11.28-py2.py3-none-any.whl (156 kB) Collecting chardet<4,>=3.0.2 Downloading chardet-3.0.4-py2.py3-none-any.whl (133 kB) Collecting idna<3,>=2.5 Downloading idna-2.9-py2.py3-none-any.whl (58 kB) Building wheels for collected packages: mock, future Building wheel for mock (setup.py): started Building wheel for mock (setup.py): finished with status 'done' Created wheel for mock: filename=mock-1.0.1-py3-none-any.whl size=23754 sha256=37e7f1767d63666e4cffea9981a431ebbcaa981f44a57beda9235cd07ad706b8 Stored in directory: /tmp/pip-ephem-wheel-cache-8fhs9rx1/wheels/16/03/37/f0a64ab894c9102906f192db1a4071b7592292ad661563c69b Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491058 sha256=c35b03fbb4bdc3cbe8a14feec998fc65ad4c2bb50b0fa98358fcca67147b5768 Stored in directory: /tmp/pip-ephem-wheel-cache-8fhs9rx1/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: Pygments, setuptools, docutils, mock, pillow, alabaster, future, commonmark, six, MarkupSafe, Jinja2, sphinxcontrib-websupport, pyparsing, packaging, pytz, babel, imagesize, snowballstemmer, urllib3, certifi, chardet, idna, requests, sphinx, recommonmark, sphinx-rtd-theme, readthedocs-sphinx-ext Attempting uninstall: setuptools Found existing installation: setuptools 46.0.0 Uninstalling setuptools-46.0.0: Successfully uninstalled setuptools-46.0.0 Successfully installed Jinja2-2.11.1 MarkupSafe-1.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.8.0 certifi-2019.11.28 chardet-3.0.4 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-2.9 imagesize-1.2.0 mock-1.0.1 packaging-20.3 pillow-5.4.1 pyparsing-2.4.6 pytz-2019.3 readthedocs-sphinx-ext-1.0.1 recommonmark-0.5.0 requests-2.23.0 setuptools-41.0.1 six-1.14.0 snowballstemmer-2.0.0 sphinx-1.8.5 sphinx-rtd-theme-0.4.3 sphinxcontrib-websupport-1.2.0 urllib3-1.25.8 [rtd-command-info] start-time: 2020-03-18T19:29:44.385033Z, end-time: 2020-03-18T19:29:55.982484Z, duration: 11, 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/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 7)) (0.7.12) Collecting argh==0.26.2 Downloading argh-0.26.2-py2.py3-none-any.whl (30 kB) Requirement already satisfied: babel==2.8.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 15)) (2.8.0) Requirement already satisfied: certifi==2019.11.28 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 19)) (2019.11.28) Requirement already satisfied: chardet==3.0.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 23)) (3.0.4) Collecting click==7.0 Downloading Click-7.0-py2.py3-none-any.whl (81 kB) Collecting docutils==0.16 Downloading docutils-0.16-py2.py3-none-any.whl (548 kB) Requirement already satisfied: idna==2.9 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 35)) (2.9) Requirement already satisfied: imagesize==1.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 39)) (1.2.0) Requirement already satisfied: jinja2==2.11.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 43)) (2.11.1) Collecting livereload==2.6.1 Downloading livereload-2.6.1-py2.py3-none-any.whl (23 kB) Requirement already satisfied: markupsafe==1.1.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 51)) (1.1.1) Requirement already satisfied: packaging==20.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 86)) (20.3) Collecting pathtools==0.1.2 Downloading pathtools-0.1.2.tar.gz (11 kB) Collecting pip-tools==4.5.1 Downloading pip_tools-4.5.1-py2.py3-none-any.whl (41 kB) Collecting port_for==0.3.1 Downloading port-for-0.3.1.tar.gz (18 kB) Collecting pygments==2.5.2 Downloading Pygments-2.5.2-py2.py3-none-any.whl (896 kB) Requirement already satisfied: pyparsing==2.4.6 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 103)) (2.4.6) Requirement already satisfied: pytz==2019.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 107)) (2019.3) Collecting pyyaml==4.2b4 Downloading PyYAML-4.2b4.tar.gz (262 kB) Requirement already satisfied: requests==2.23.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 117)) (2.23.0) Requirement already satisfied: six==1.14.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 121)) (1.14.0) Requirement already satisfied: snowballstemmer==2.0.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 125)) (2.0.0) Collecting sphinx-autobuild==0.7.1 Downloading sphinx-autobuild-0.7.1.tar.gz (14 kB) Requirement already satisfied: sphinx-rtd-theme==0.4.3 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 132)) (0.4.3) Collecting sphinx==2.4.4 Downloading Sphinx-2.4.4-py3-none-any.whl (2.7 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==1.0.3 Downloading sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl (96 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) Collecting sphinxcontrib-serializinghtml==1.1.4 Downloading sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl (89 kB) Collecting tornado==6.0.4 Downloading tornado-6.0.4.tar.gz (496 kB) Requirement already satisfied: urllib3==1.25.8 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages (from -r conf/requirements.txt (line 173)) (1.25.8) Collecting watchdog==0.10.2 Downloading watchdog-0.10.2.tar.gz (95 kB) Collecting setuptools==45.2.0 Downloading setuptools-45.2.0-py3-none-any.whl (584 kB) Building wheels for collected packages: pathtools, port-for, pyyaml, sphinx-autobuild, tornado, watchdog Building wheel for pathtools (setup.py): started Building wheel for pathtools (setup.py): finished with status 'done' Created wheel for pathtools: filename=pathtools-0.1.2-py3-none-any.whl size=8784 sha256=b372d5dff60fc6850b590a57a70acf7f19764994405abaf0c6f6a4cc88b935d0 Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/3e/31/09/fa59cef12cdcfecc627b3d24273699f390e71828921b2cbba2 Building wheel for port-for (setup.py): started Building wheel for port-for (setup.py): finished with status 'done' Created wheel for port-for: filename=port_for-0.3.1-py3-none-any.whl size=19605 sha256=4b8b121ff9bee7198dbb1064b1c595abda82f980c02d7f5bcc6dfa6e81aa0e60 Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/a0/3a/de/2fee22649fd79d152f8726b86b9dec6fd35924e71d8e4c2bf2 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=43031 sha256=4f388dbb3dc4b3d2398dbbdca7f32fd3b9e230a0cfd12bd8b05d1086b0b1e84e Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/06/a6/83/224e726cacb89d8d459811ac7c30825ef0afb75192fe934f22 Building wheel for sphinx-autobuild (setup.py): started Building wheel for sphinx-autobuild (setup.py): finished with status 'done' Created wheel for sphinx-autobuild: filename=sphinx_autobuild-0.7.1-py3-none-any.whl size=10075 sha256=c12825eba0b68bdb7d50986d8ef5b90b737ae80a72a9ccd301bcce3cbcc94e8b Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/b5/33/11/03f2a5fbd63cd60617cbb411d619008e8e4e0100aa3b21ecda Building wheel for tornado (setup.py): started Building wheel for tornado (setup.py): finished with status 'done' Created wheel for tornado: filename=tornado-6.0.4-cp37-cp37m-linux_x86_64.whl size=428565 sha256=12f9b7d99f6eb4f638a14118cf624f9cc252e5cba67ecbb6d040d53cc8b28a7f Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/7d/14/fa/d88fb5da77d813ea0ffca38a2ab2a052874e9e1142bad0b348 Building wheel for watchdog (setup.py): started Building wheel for watchdog (setup.py): finished with status 'done' Created wheel for watchdog: filename=watchdog-0.10.2-py3-none-any.whl size=73602 sha256=f823615aa290d8f4a81591ec2a21572adf45f169597ded41f550b905d437c0c8 Stored in directory: /tmp/pip-ephem-wheel-cache-qy3ykpax/wheels/36/93/24/29e375ee74e0f178889e6906cb73e693e9f06a5f589dcee6b9 Successfully built pathtools port-for pyyaml sphinx-autobuild tornado watchdog Installing collected packages: argh, click, docutils, tornado, livereload, pathtools, pip-tools, port-for, pygments, pyyaml, watchdog, sphinx-autobuild, sphinxcontrib-applehelp, sphinxcontrib-htmlhelp, sphinxcontrib-jsmath, sphinxcontrib-serializinghtml, sphinxcontrib-devhelp, sphinxcontrib-qthelp, setuptools, sphinx Attempting uninstall: docutils Found existing installation: docutils 0.14 Uninstalling docutils-0.14: Successfully uninstalled docutils-0.14 Attempting uninstall: pygments Found existing installation: Pygments 2.3.1 Uninstalling Pygments-2.3.1: Successfully uninstalled Pygments-2.3.1 Attempting uninstall: setuptools Found existing installation: setuptools 41.0.1 Uninstalling setuptools-41.0.1: Successfully uninstalled setuptools-41.0.1 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.5 Uninstalling Sphinx-1.8.5: Successfully uninstalled Sphinx-1.8.5 Successfully installed argh-0.26.2 click-7.0 docutils-0.16 livereload-2.6.1 pathtools-0.1.2 pip-tools-4.5.1 port-for-0.3.1 pygments-2.5.2 pyyaml-4.2b4 setuptools-45.2.0 sphinx-2.4.4 sphinx-autobuild-0.7.1 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-1.0.3 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 sphinxcontrib-serializinghtml-1.1.4 tornado-6.0.4 watchdog-0.10.2 [rtd-command-info] start-time: 2020-03-18T19:29:58.338778Z, end-time: 2020-03-18T19:29:58.656819Z, 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.7' # The full version, including alpha/beta/rc tags. release = '1.8.7' # 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://assets.readthedocs.com/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "1.8.8", 'version_slug': "1.8.8", '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.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': [ ], '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', 'proxied_api_host': '/_', 'github_user': 'hellonarrativ', 'github_repo': 'api-docs', 'github_version': '1.8.8', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '1.8.8', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '1.8.8', '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': 'b04fc730', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'tag' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") project_language = 'en' # User's Sphinx configurations language_user = globals().get('language', None) latex_engine_user = globals().get('latex_engine', None) latex_elements_user = globals().get('latex_elements', None) # Remove this once xindy gets installed in Docker image and XINDYOPS # env variable is supported # https://github.com/rtfd/readthedocs-docker-images/pull/98 latex_use_xindy = False chinese = any([ language_user in ('zh_CN', 'zh_TW'), project_language in ('zh_CN', 'zh_TW'), ]) japanese = any([ language_user == 'ja', project_language == 'ja', ]) if chinese: latex_engine = latex_engine_user or 'xelatex' latex_elements_rtd = { 'preamble': '\\usepackage[UTF8]{ctex}\n', } latex_elements = latex_elements_user or latex_elements_rtd elif japanese: latex_engine = latex_engine_user or 'platex' [rtd-command-info] start-time: 2020-03-18T19:29:58.817012Z, end-time: 2020-03-18T19:30:01.983462Z, duration: 3, exit-code: 0 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v2.4.4 loading translations [en]... done making output directory... 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: [new config] 19 added, 0 changed, 0 removed reading sources... [ 5%] amp reading sources... [ 10%] auction reading sources... [ 15%] auth reading sources... [ 21%] clickmate reading sources... [ 26%] events reading sources... [ 31%] extensionbasics reading sources... [ 36%] extensionuse reading sources... [ 42%] feeds reading sources... [ 47%] index reading sources... [ 52%] privacypolicy reading sources... [ 57%] productapi reading sources... [ 63%] requests reading sources... [ 68%] smartlink reading sources... [ 73%] smartshopbuild reading sources... [ 78%] statistics reading sources... [ 84%] tagbasics reading sources... [ 89%] 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%] 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 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. The HTML pages are in _build/html. /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.8.8/lib/python3.7/site-packages/sphinx_rtd_theme/search.html:21: RemovedInSphinx30Warning: To modify script_files in the theme is deprecated. Please insert a