Read the Docs build information Build id: 99172 Project: narrativ-narrativ Version: 1.4.0 Commit: 2e72666ad84914462f1b93e518331f85582d76b7 Date: 2018-04-05T17:34:05.189021Z State: finished Success: True [rtd-command-info] start-time: 2018-04-05T22:34:05.661140Z, end-time: 2018-04-05T22:34:06.241512Z, duration: 0, exit-code: 0 git clone --recursive https://github.com/hellonarrativ/api-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2018-04-05T22:34:06.307660Z, end-time: 2018-04-05T22:34:06.353107Z, duration: 0, exit-code: 0 git checkout --force 2e72666ad84914462f1b93e518331f85582d76b7 Note: checking out '2e72666ad84914462f1b93e518331f85582d76b7'. 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 2e72666... Merge pull request #39 from hellonarrativ/update-version-1.4.0 [rtd-command-info] start-time: 2018-04-05T22:34:06.416296Z, end-time: 2018-04-05T22:34:06.425903Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2018-04-05T22:34:06.522884Z, end-time: 2018-04-05T22:34:06.531272Z, duration: 0, exit-code: 0 git show-ref --tags ba6a78662b03664a8bb38d8ee7da603b76c34a35 refs/tags/0.0.1 c0b5d42e73d9ed327e7a0aea094cec7553372eea refs/tags/1.0.0 57d07ca256c02801d0cae77db8ced568e6816dea refs/tags/1.1.0 a98faca2ff4510be57c21f205484850bd71c18d8 refs/tags/1.2.0 e2379729841e4c64a0108fba84460cb434585c13 refs/tags/1.2.1 852fdad2a9e59a14165c1c07037472198e7ccd5a refs/tags/1.3.0 948322aef7d2ac0e0bd9bb198c8829d91820a959 refs/tags/1.3.1 3f7aeb73e53c5ca8311de3e0a448b24b3ac3d66e refs/tags/1.3.2 2e72666ad84914462f1b93e518331f85582d76b7 refs/tags/1.4.0 [rtd-command-info] start-time: 2018-04-05T22:34:06.596382Z, end-time: 2018-04-05T22:34:06.607283Z, duration: 0, exit-code: 0 git branch -r origin/HEAD -> origin/master origin/jstag origin/master origin/narrativkevin-patch-1 origin/narrativkevin-patch-2 origin/narrativkevin-patch-3 origin/narrativkevin-patch-4 origin/update-channel [rtd-command-info] start-time: 2018-04-05T22:34:07.493123Z, end-time: 2018-04-05T22:34:10.231917Z, duration: 2, exit-code: 0 python3.5 -mvirtualenv --no-site-packages --no-download Using base prefix '/usr' New python executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/bin/python3.5 Also creating executable in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/bin/python Installing setuptools, pip, wheel...done. [rtd-command-info] start-time: 2018-04-05T22:34:10.321397Z, end-time: 2018-04-05T22:34:34.546541Z, duration: 24, exit-code: 0 python pip install --use-wheel --upgrade --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip Pygments==2.2.0 setuptools==37.0.0 docutils==0.13.1 mock==1.0.1 pillow==2.6.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.5.4 recommonmark==0.4.0 sphinx==1.6.5 sphinx-rtd-theme<0.3 readthedocs-sphinx-ext<0.6 Collecting Pygments==2.2.0 Downloading Pygments-2.2.0-py2.py3-none-any.whl (841kB) Collecting setuptools==37.0.0 Downloading setuptools-37.0.0-py2.py3-none-any.whl (481kB) Collecting docutils==0.13.1 Downloading docutils-0.13.1-py3-none-any.whl (536kB) Collecting mock==1.0.1 Downloading mock-1.0.1.tar.gz (818kB) Collecting pillow==2.6.1 Downloading Pillow-2.6.1.tar.gz (7.3MB) Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.10-py2.py3-none-any.whl Collecting commonmark==0.5.4 Downloading CommonMark-0.5.4.tar.gz (120kB) Collecting recommonmark==0.4.0 Downloading recommonmark-0.4.0-py2.py3-none-any.whl Collecting sphinx==1.6.5 Downloading Sphinx-1.6.5-py2.py3-none-any.whl (1.9MB) Collecting sphinx-rtd-theme<0.3 Downloading sphinx_rtd_theme-0.2.4-py2.py3-none-any.whl (1.4MB) Collecting readthedocs-sphinx-ext<0.6 Downloading readthedocs-sphinx-ext-0.5.9.tar.gz Collecting six>=1.5 (from sphinx==1.6.5) Downloading six-1.11.0-py2.py3-none-any.whl Collecting snowballstemmer>=1.1 (from sphinx==1.6.5) Downloading snowballstemmer-1.2.1-py2.py3-none-any.whl (64kB) Collecting Jinja2>=2.3 (from sphinx==1.6.5) Downloading Jinja2-2.10-py2.py3-none-any.whl (126kB) Collecting requests>=2.0.0 (from sphinx==1.6.5) Downloading requests-2.18.4-py2.py3-none-any.whl (88kB) Collecting imagesize (from sphinx==1.6.5) Downloading imagesize-1.0.0-py2.py3-none-any.whl Collecting babel!=2.0,>=1.3 (from sphinx==1.6.5) Downloading Babel-2.5.3-py2.py3-none-any.whl (6.8MB) Collecting sphinxcontrib-websupport (from sphinx==1.6.5) Downloading sphinxcontrib_websupport-1.0.1-py2.py3-none-any.whl Collecting nilsimsa>=0.3.7 (from readthedocs-sphinx-ext<0.6) Downloading nilsimsa-0.3.8.tar.gz (276kB) Collecting MarkupSafe>=0.23 (from Jinja2>=2.3->sphinx==1.6.5) Downloading MarkupSafe-1.0.tar.gz Collecting chardet<3.1.0,>=3.0.2 (from requests>=2.0.0->sphinx==1.6.5) Downloading chardet-3.0.4-py2.py3-none-any.whl (133kB) Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx==1.6.5) Downloading certifi-2018.1.18-py2.py3-none-any.whl (151kB) Collecting urllib3<1.23,>=1.21.1 (from requests>=2.0.0->sphinx==1.6.5) Downloading urllib3-1.22-py2.py3-none-any.whl (132kB) Collecting idna<2.7,>=2.5 (from requests>=2.0.0->sphinx==1.6.5) Downloading idna-2.6-py2.py3-none-any.whl (56kB) Collecting pytz>=0a (from babel!=2.0,>=1.3->sphinx==1.6.5) Downloading pytz-2018.3-py2.py3-none-any.whl (509kB) Building wheels for collected packages: mock, pillow, commonmark, readthedocs-sphinx-ext, nilsimsa, MarkupSafe Running setup.py bdist_wheel for mock: started Running setup.py bdist_wheel for mock: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/10/e5/4a/eed88674a2ddcf2fdddb2a00c8a2c772b24979186a4ba84d82 Running setup.py bdist_wheel for pillow: started Running setup.py bdist_wheel for pillow: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/ec/e1/02/91782344499267ed189d74d0e5dae1614a1aab1f17ed2ea8eb Running setup.py bdist_wheel for commonmark: started Running setup.py bdist_wheel for commonmark: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/fd/3a/ea/9ead7944d8ba3771888487ca4f6ef39bcde9fd4e986c32f442 Running setup.py bdist_wheel for readthedocs-sphinx-ext: started Running setup.py bdist_wheel for readthedocs-sphinx-ext: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/20/95/b7/1c4450f0b65a16b6021cd4b1239032d10d4c03640626f7174f Running setup.py bdist_wheel for nilsimsa: started Running setup.py bdist_wheel for nilsimsa: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/77/f8/25/539c7b52ecbfcb7ed9b6c7189f9fdde48706c41fe529a64c9f Running setup.py bdist_wheel for MarkupSafe: started Running setup.py bdist_wheel for MarkupSafe: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/88/a7/30/e39a54a87bcbe25308fa3ca64e8ddc75d9b3e5afa21ee32d57 Successfully built mock pillow commonmark readthedocs-sphinx-ext nilsimsa MarkupSafe Installing collected packages: Pygments, setuptools, docutils, mock, pillow, alabaster, commonmark, recommonmark, six, snowballstemmer, MarkupSafe, Jinja2, chardet, certifi, urllib3, idna, requests, imagesize, pytz, babel, sphinxcontrib-websupport, sphinx, sphinx-rtd-theme, nilsimsa, readthedocs-sphinx-ext Found existing installation: setuptools 28.8.0 Uninstalling setuptools-28.8.0: Successfully uninstalled setuptools-28.8.0 Successfully installed Jinja2-2.10 MarkupSafe-1.0 Pygments-2.2.0 alabaster-0.7.10 babel-2.5.3 certifi-2018.1.18 chardet-3.0.4 commonmark-0.5.4 docutils-0.13.1 idna-2.6 imagesize-1.0.0 mock-1.0.1 nilsimsa-0.3.8 pillow-2.6.1 pytz-2018.3 readthedocs-sphinx-ext-0.5.9 recommonmark-0.4.0 requests-2.18.4 setuptools-37.0.0 six-1.11.0 snowballstemmer-1.2.1 sphinx-1.6.5 sphinx-rtd-theme-0.2.4 sphinxcontrib-websupport-1.0.1 urllib3-1.22 You are using pip version 9.0.1, however version 9.0.3 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2018-04-05T22:34:34.610293Z, end-time: 2018-04-05T22:34:47.455329Z, duration: 12, exit-code: 0 python pip install --exists-action=w --cache-dir /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip -rconf/requirements.txt Requirement already satisfied: alabaster==0.7.10 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 15)) Collecting argh==0.26.2 (from -r conf/requirements.txt (line 16)) Downloading argh-0.26.2-py2.py3-none-any.whl Collecting Babel==2.4.0 (from -r conf/requirements.txt (line 17)) Downloading Babel-2.4.0-py2.py3-none-any.whl (6.8MB) Collecting certifi==2017.4.17 (from -r conf/requirements.txt (line 18)) Downloading certifi-2017.4.17-py2.py3-none-any.whl (375kB) Requirement already satisfied: chardet==3.0.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 19)) Requirement already satisfied: docutils==0.13.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 20)) Collecting idna==2.5 (from -r conf/requirements.txt (line 21)) Downloading idna-2.5-py2.py3-none-any.whl (55kB) Collecting imagesize==0.7.1 (from -r conf/requirements.txt (line 22)) Downloading imagesize-0.7.1-py2.py3-none-any.whl Collecting Jinja2==2.9.6 (from -r conf/requirements.txt (line 23)) Downloading Jinja2-2.9.6-py2.py3-none-any.whl (340kB) Collecting livereload==2.5.1 (from -r conf/requirements.txt (line 24)) Downloading livereload-2.5.1.tar.gz Requirement already satisfied: MarkupSafe==1.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 25)) Collecting pathtools==0.1.2 (from -r conf/requirements.txt (line 26)) Downloading pathtools-0.1.2.tar.gz Collecting port-for==0.3.1 (from -r conf/requirements.txt (line 28)) Downloading port-for-0.3.1.tar.gz Requirement already satisfied: Pygments==2.2.0 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 29)) Collecting pytz==2017.2 (from -r conf/requirements.txt (line 30)) Downloading pytz-2017.2-py2.py3-none-any.whl (484kB) Collecting PyYAML==3.12 (from -r conf/requirements.txt (line 31)) Downloading PyYAML-3.12.tar.gz (253kB) Collecting requests==2.18.1 (from -r conf/requirements.txt (line 32)) Downloading requests-2.18.1-py2.py3-none-any.whl (88kB) Collecting six==1.10.0 (from -r conf/requirements.txt (line 33)) Downloading six-1.10.0-py2.py3-none-any.whl Requirement already satisfied: snowballstemmer==1.2.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 34)) Collecting Sphinx==1.6.3 (from -r conf/requirements.txt (line 35)) Downloading Sphinx-1.6.3-py2.py3-none-any.whl (1.9MB) Collecting sphinx-autobuild==0.7.1 (from -r conf/requirements.txt (line 36)) Downloading sphinx-autobuild-0.7.1.tar.gz Requirement already satisfied: sphinx-rtd-theme==0.2.4 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 37)) Requirement already satisfied: sphinxcontrib-websupport==1.0.1 in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from -r conf/requirements.txt (line 38)) Collecting tornado==4.5.1 (from -r conf/requirements.txt (line 39)) Downloading tornado-4.5.1.tar.gz (483kB) Collecting urllib3==1.21.1 (from -r conf/requirements.txt (line 40)) Downloading urllib3-1.21.1-py2.py3-none-any.whl (131kB) Collecting watchdog==0.8.3 (from -r conf/requirements.txt (line 41)) Downloading watchdog-0.8.3.tar.gz (83kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/1.4.0/lib/python3.5/site-packages (from Sphinx==1.6.3->-r conf/requirements.txt (line 35)) Building wheels for collected packages: livereload, pathtools, port-for, PyYAML, sphinx-autobuild, tornado, watchdog Running setup.py bdist_wheel for livereload: started Running setup.py bdist_wheel for livereload: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/71/95/bf/6ccaa70b36701dd3fa337296d7ec6614bf14f51d58bc3a4a7a Running setup.py bdist_wheel for pathtools: started Running setup.py bdist_wheel for pathtools: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/60/0d/2a/ffe065d190b580be6af9a862c68ed6a8a89c1778bd5c7ba7b8 Running setup.py bdist_wheel for port-for: started Running setup.py bdist_wheel for port-for: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/59/4e/68/d3a42868015e73913b1da097bf0cacfbd9b2261dc7f5796eda Running setup.py bdist_wheel for PyYAML: started Running setup.py bdist_wheel for PyYAML: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/2c/f7/79/13f3a12cd723892437c0cfbde1230ab4d82947ff7b3839a4fc Running setup.py bdist_wheel for sphinx-autobuild: started Running setup.py bdist_wheel for sphinx-autobuild: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/43/1d/a7/44dc67ffd7a7c751bdf3a7f57dc0fcb38d118e730b74e61ebf Running setup.py bdist_wheel for tornado: started Running setup.py bdist_wheel for tornado: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/84/83/cd/6a04602633457269d161344755e6766d24307189b7a67ff4b7 Running setup.py bdist_wheel for watchdog: started Running setup.py bdist_wheel for watchdog: finished with status 'done' Stored in directory: /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/.cache/pip/wheels/3c/9c/be/e82ae5a37c19baf8abe88623d1f47d2d502bed7b54d4f34740 Successfully built livereload pathtools port-for PyYAML sphinx-autobuild tornado watchdog Installing collected packages: argh, pytz, Babel, certifi, idna, imagesize, Jinja2, tornado, six, livereload, pathtools, port-for, PyYAML, urllib3, requests, Sphinx, watchdog, sphinx-autobuild Found existing installation: pytz 2018.3 Uninstalling pytz-2018.3: Successfully uninstalled pytz-2018.3 Found existing installation: Babel 2.5.3 Uninstalling Babel-2.5.3: Successfully uninstalled Babel-2.5.3 Found existing installation: certifi 2018.1.18 Uninstalling certifi-2018.1.18: Successfully uninstalled certifi-2018.1.18 Found existing installation: idna 2.6 Uninstalling idna-2.6: Successfully uninstalled idna-2.6 Found existing installation: imagesize 1.0.0 Uninstalling imagesize-1.0.0: Successfully uninstalled imagesize-1.0.0 Found existing installation: Jinja2 2.10 Uninstalling Jinja2-2.10: Successfully uninstalled Jinja2-2.10 Found existing installation: six 1.11.0 Uninstalling six-1.11.0: Successfully uninstalled six-1.11.0 Found existing installation: urllib3 1.22 Uninstalling urllib3-1.22: Successfully uninstalled urllib3-1.22 Found existing installation: requests 2.18.4 Uninstalling requests-2.18.4: Successfully uninstalled requests-2.18.4 Found existing installation: Sphinx 1.6.5 Uninstalling Sphinx-1.6.5: Successfully uninstalled Sphinx-1.6.5 Successfully installed Babel-2.4.0 Jinja2-2.9.6 PyYAML-3.12 Sphinx-1.6.3 argh-0.26.2 certifi-2017.4.17 idna-2.5 imagesize-0.7.1 livereload-2.5.1 pathtools-0.1.2 port-for-0.3.1 pytz-2017.2 requests-2.18.1 six-1.10.0 sphinx-autobuild-0.7.1 tornado-4.5.1 urllib3-1.21.1 watchdog-0.8.3 You are using pip version 9.0.1, however version 9.0.3 is available. You should consider upgrading via the 'pip install --upgrade pip' command. [rtd-command-info] start-time: 2018-04-05T22:34:48.009631Z, end-time: 2018-04-05T22:34:48.112361Z, duration: 0, exit-code: 0 cat docs/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # Narrativ API documentation build configuration file, created by # sphinx-quickstart on Mon Jul 24 11:48:40 2017. # # This file is execfile()d with the current directory set to its # containing dir. # # Note that not all possible configuration values are present in this # autogenerated file. # # All configuration values have a default; values that are commented out # serve to show the default. # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. # import os # import sys # sys.path.insert(0, os.path.abspath('.')) # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. # # needs_sphinx = '1.0' # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['sphinx.ext.ifconfig'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # The suffix(es) of source filenames. # You can specify multiple suffix as a list of string: # # source_suffix = ['.rst', '.md'] source_suffix = '.rst' # The master toctree document. master_doc = 'index' # General information about the project. project = 'Narrativ API' copyright = '2018, Narrativ AI, Inc.' author = 'Narrativ' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. (major version 1 corresponds to /api/v1/) version = '1.4.0' # The full version, including alpha/beta/rc tags. release = '1.4.0' # 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_table_style.css') ########################################################################### # auto-created readthedocs.org specific configuration # ########################################################################### # # The following code was added during an automated build on readthedocs.org # It is auto created and injected for every build. The result is based on the # conf.py.tmpl file found in the readthedocs.org codebase: # https://github.com/rtfd/readthedocs.org/blob/master/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # import sys import os.path from six import string_types from sphinx import version_info # Get suffix for proper linking to GitHub # This is deprecated in Sphinx 1.3+, # as each page can have its own suffix if globals().get('source_suffix', False): if isinstance(source_suffix, string_types): SUFFIX = source_suffix else: SUFFIX = source_suffix[0] else: SUFFIX = '.rst' # Add RTD Static Path. Add to the end because it overwrites previous files. if not 'html_static_path' in globals(): html_static_path = [] if os.path.exists('_static'): html_static_path.append('_static') html_static_path.append('/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static') # Add RTD Theme only if they aren't overriding it already using_rtd_theme = False if 'html_theme' in globals(): if html_theme in ['default']: # Allow people to bail with a hack of having an html_style if not 'html_style' in globals(): import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True else: import sphinx_rtd_theme html_theme = 'sphinx_rtd_theme' html_style = None html_theme_options = {} if 'html_theme_path' in globals(): html_theme_path.append(sphinx_rtd_theme.get_html_theme_path()) else: html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] using_rtd_theme = True if globals().get('websupport2_base_url', False): websupport2_base_url = 'https://readthedocs.com/websupport' if 'http' not in settings.MEDIA_URL: websupport2_static_url = 'https://media.readthedocs.com/' else: websupport2_static_url = 'https://media.readthedocs.com/media//static' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "1.4.0", 'version_slug': "1.4.0", 'MEDIA_URL': "https://media.readthedocs.com/media/", 'PRODUCTION_DOMAIN': "readthedocs.com", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("1.4.0", "/en/1.4.0/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'narrativ-narrativ', 'name': u'Narrativ', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'https://narrativ-narrativ.readthedocs-hosted.com/en/stable/', 'analytics_code': '', 'single_version': False, 'conf_py_path': '/docs/', 'api_host': 'https://readthedocs.com', 'github_user': 'hellonarrativ', 'github_repo': 'api-docs', 'github_version': '1.4.0', 'display_github': True, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': '1.4.0', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': '1.4.0', 'display_gitlab': False, 'READTHEDOCS': True, 'using_theme': (html_theme == "default"), 'new_theme': (html_theme == "sphinx_rtd_theme"), 'source_suffix': SUFFIX, 'user_analytics_code': '', 'global_analytics_code': 'UA-17997319-2', 'commit': '2e72666a', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): extensions.append("readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] [rtd-command-info] start-time: 2018-04-05T22:34:48.180325Z, end-time: 2018-04-05T22:34:50.468155Z, duration: 2, exit-code: 0 python sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.6.3 making output directory... loading translations [en]... done loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [readthedocs]: targets for 14 source files that are out of date updating environment: 14 added, 0 changed, 0 removed reading sources... [ 7%] auction reading sources... [ 14%] auth reading sources... [ 21%] events reading sources... [ 28%] extensionbasics reading sources... [ 35%] extensionuse reading sources... [ 42%] index reading sources... [ 50%] linkmate reading sources... [ 57%] requests reading sources... [ 64%] smartlink reading sources... [ 71%] smartshopbuild reading sources... [ 78%] tagbasics reading sources... [ 85%] tagmerchant reading sources... [ 92%] tagpublisher reading sources... [100%] tagpublishercustom looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 7%] auction writing output... [ 14%] auth writing output... [ 21%] events writing output... [ 28%] extensionbasics writing output... [ 35%] extensionuse writing output... [ 42%] index writing output... [ 50%] linkmate writing output... [ 57%] requests writing output... [ 64%] smartlink writing output... [ 71%] smartshopbuild writing output... [ 78%] tagbasics writing output... [ 85%] tagmerchant writing output... [ 92%] tagpublisher writing output... [100%] tagpublishercustom generating indices... genindex writing additional pages... search copying images... [ 3%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 6%] _static/extension_instructions/8.png copying images... [ 10%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 13%] _static/extension_instructions/7.png copying images... [ 16%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 20%] _static/builder_instructions/Builder4.png copying images... [ 23%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 26%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 30%] _static/builder_instructions/Builder2.png copying images... [ 33%] _static/builder_instructions/Builder1.png copying images... [ 36%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 40%] _static/builder_instructions/Builder3.png copying images... [ 43%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 46%] _static/extension_instructions/Dynamic.png copying images... [ 50%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 53%] _static/extension_instructions/1.png copying images... [ 56%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 60%] _static/extension_instructions/3.png copying images... [ 63%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 66%] _static/extension_instructions/2.png copying images... [ 70%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 73%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 76%] _static/extension_instructions/4.png copying images... [ 80%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 83%] _static/extension_instructions/6.png copying images... [ 86%] _static/extension_instructions/5.png copying images... [ 90%] _static/builder_instructions/Builder5.png copying images... [ 93%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 96%] _static/extension_instructions/Exclusive.png copying images... [100%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying static files... WARNING: html_static_path entry '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static' does not exist done copying readthedocs static files... done copying searchtools... done copying extra files... done dumping search index in English (code: en) ... done dumping object inventory... done build succeeded, 1 warning. [rtd-command-info] start-time: 2018-04-05T22:34:50.573001Z, end-time: 2018-04-05T22:34:52.348564Z, duration: 1, exit-code: 0 python sphinx-build -T -b json -d _build/doctrees-json -D language=en . _build/json Running Sphinx v1.6.3 making output directory... loading translations [en]... done loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [json]: targets for 14 source files that are out of date updating environment: 14 added, 0 changed, 0 removed reading sources... [ 7%] auction reading sources... [ 14%] auth reading sources... [ 21%] events reading sources... [ 28%] extensionbasics reading sources... [ 35%] extensionuse reading sources... [ 42%] index reading sources... [ 50%] linkmate reading sources... [ 57%] requests reading sources... [ 64%] smartlink reading sources... [ 71%] smartshopbuild reading sources... [ 78%] tagbasics reading sources... [ 85%] tagmerchant reading sources... [ 92%] tagpublisher reading sources... [100%] tagpublishercustom looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 7%] auction writing output... [ 14%] auth writing output... [ 21%] events writing output... [ 28%] extensionbasics writing output... [ 35%] extensionuse writing output... [ 42%] index writing output... [ 50%] linkmate writing output... [ 57%] requests writing output... [ 64%] smartlink writing output... [ 71%] smartshopbuild writing output... [ 78%] tagbasics writing output... [ 85%] tagmerchant writing output... [ 92%] tagpublisher writing output... [100%] tagpublishercustom generating indices... genindex writing additional pages... search copying images... [ 3%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 6%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 10%] _static/extension_instructions/5.png copying images... [ 13%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 16%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 20%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 23%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 26%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 30%] _static/extension_instructions/7.png copying images... [ 33%] _static/builder_instructions/Builder2.png copying images... [ 36%] _static/extension_instructions/Dynamic.png copying images... [ 40%] _static/builder_instructions/Builder3.png copying images... [ 43%] _static/extension_instructions/2.png copying images... [ 46%] _static/extension_instructions/1.png copying images... [ 50%] _static/extension_instructions/8.png copying images... [ 53%] _static/builder_instructions/Builder4.png copying images... [ 56%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 60%] _static/pixel_implementation_screenshots/5_final_product.png copying images... [ 63%] _static/builder_instructions/Builder5.png copying images... [ 66%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 70%] _static/extension_instructions/6.png copying images... [ 73%] _static/extension_instructions/3.png copying images... [ 76%] _static/extension_instructions/Exclusive.png copying images... [ 80%] _static/builder_instructions/Builder1.png copying images... [ 83%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 86%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 90%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 93%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 96%] _static/extension_instructions/4.png copying images... [100%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying static files... WARNING: html_static_path entry '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static' does not exist done copying extra files... done dumping search index in English (code: en) ... done dumping object inventory... done build succeeded, 1 warning. [rtd-command-info] start-time: 2018-04-05T22:34:52.451112Z, end-time: 2018-04-05T22:34:54.094561Z, duration: 1, exit-code: 0 python sphinx-build -T -b readthedocssinglehtmllocalmedia -d _build/doctrees-readthedocssinglehtmllocalmedia -D language=en . _build/localmedia Running Sphinx v1.6.3 making output directory... loading translations [en]... done loading pickled environment... not yet created building [mo]: targets for 0 po files that are out of date building [readthedocssinglehtmllocalmedia]: all documents updating environment: 14 added, 0 changed, 0 removed reading sources... [ 7%] auction reading sources... [ 14%] auth reading sources... [ 21%] events reading sources... [ 28%] extensionbasics reading sources... [ 35%] extensionuse reading sources... [ 42%] index reading sources... [ 50%] linkmate reading sources... [ 57%] requests reading sources... [ 64%] smartlink reading sources... [ 71%] smartshopbuild reading sources... [ 78%] tagbasics reading sources... [ 85%] tagmerchant reading sources... [ 92%] tagpublisher reading sources... [100%] tagpublishercustom looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done assembling single document... auth requests smartlink linkmate auction events tagbasics tagpublisher tagmerchant tagpublishercustom extensionbasics extensionuse smartshopbuild writing... done writing additional files... copying images... [ 3%] _static/extension_instructions/6.png copying images... [ 6%] _static/pixel_implementation_screenshots/checkout_3_add_trigger.png copying images... [ 10%] _static/builder_instructions/Builder3.png copying images... [ 13%] _static/pixel_implementation_screenshots/submit_2_review.png copying images... [ 16%] _static/builder_instructions/Builder5.png copying images... [ 20%] _static/pixel_implementation_screenshots/2_choose_custom_html.png copying images... [ 23%] _static/extension_instructions/3.png copying images... [ 26%] _static/pixel_implementation_screenshots/checkout_4_add_confirmation_page_trigger.png copying images... [ 30%] _static/pixel_implementation_screenshots/checkout_1_open_editor.png copying images... [ 33%] _static/extension_instructions/1.png copying images... [ 36%] _static/extension_instructions/4.png copying images... [ 40%] _static/pixel_implementation_screenshots/3_enter_tag_html.png copying images... [ 43%] _static/pixel_implementation_screenshots/checkout_5_double_check.png copying images... [ 46%] _static/extension_instructions/8.png copying images... [ 50%] _static/pixel_implementation_screenshots/submit_3_submit_changes.png copying images... [ 53%] _static/extension_instructions/2.png copying images... [ 56%] _static/pixel_implementation_screenshots/1_tap_configuration.png copying images... [ 60%] _static/extension_instructions/Dynamic.png copying images... [ 63%] _static/pixel_implementation_screenshots/submit_4_title_the_changes.png copying images... [ 66%] _static/pixel_implementation_screenshots/checkout_2_confirm_code_product_info.png copying images... [ 70%] _static/pixel_implementation_screenshots/submit_1_tag_confirmation.png copying images... [ 73%] _static/builder_instructions/Builder2.png copying images... [ 76%] _static/pixel_implementation_screenshots/4_select_trigger.png copying images... [ 80%] _static/builder_instructions/Builder1.png copying images... [ 83%] _static/pixel_implementation_screenshots/checkout_4.1_add_confirmation_rules.png copying images... [ 86%] _static/builder_instructions/Builder4.png copying images... [ 90%] _static/extension_instructions/7.png copying images... [ 93%] _static/extension_instructions/Exclusive.png copying images... [ 96%] _static/extension_instructions/5.png copying images... [100%] _static/pixel_implementation_screenshots/5_final_product.png copying static files... WARNING: html_static_path entry '/home/docs/checkouts/readthedocs.org/readthedocs/templates/sphinx/_static' does not exist done copying readthedocs static files... done copying extra files... done dumping object inventory... done build succeeded, 1 warning.