Read the Docs build information Build id: 1740955 Project: narrativ-narrativ Version: latest Commit: 340d4d947520c292a183152eeaf21e37bb924967 Date: 2023-09-25T16:34:35.969123Z State: finished Success: True [rtd-command-info] start-time: 2023-09-25T16:34:50.538802Z, end-time: 2023-09-25T16:34:52.557128Z, duration: 2, exit-code: 0 git clone --depth 1 https://github.com/hellonarrativ/api-docs.git . Cloning into '.'... [rtd-command-info] start-time: 2023-09-25T16:34:53.126497Z, end-time: 2023-09-25T16:34:55.529545Z, duration: 2, exit-code: 0 git fetch origin --force --prune --prune-tags --depth 50 refs/heads/master:refs/remotes/origin/master From https://github.com/hellonarrativ/api-docs * [new tag] 1.9.10 -> 1.9.10 * [new tag] 1.9.11 -> 1.9.11 * [new tag] 1.9.12 -> 1.9.12 * [new tag] 1.9.13 -> 1.9.13 * [new tag] 1.9.14 -> 1.9.14 * [new tag] 1.9.15 -> 1.9.15 * [new tag] 1.9.16 -> 1.9.16 * [new tag] 1.9.17 -> 1.9.17 * [new tag] 1.9.18 -> 1.9.18 * [new tag] 1.9.19 -> 1.9.19 * [new tag] 1.9.20 -> 1.9.20 * [new tag] 1.9.21 -> 1.9.21 * [new tag] 1.9.22 -> 1.9.22 * [new tag] 1.9.23 -> 1.9.23 * [new tag] 1.9.24 -> 1.9.24 * [new tag] 1.9.25 -> 1.9.25 * [new tag] 1.9.26 -> 1.9.26 * [new tag] 1.9.27 -> 1.9.27 * [new tag] 1.9.28 -> 1.9.28 * [new tag] 1.9.3 -> 1.9.3 * [new tag] 1.9.4 -> 1.9.4 * [new tag] 1.9.5 -> 1.9.5 * [new tag] 1.9.6 -> 1.9.6 * [new tag] 2.0.0 -> 2.0.0 * [new tag] 2.0.1 -> 2.0.1 * [new tag] 2.0.2 -> 2.0.2 * [new tag] 2.0.3 -> 2.0.3 * [new tag] 2.0.4 -> 2.0.4 * [new tag] 2.0.5 -> 2.0.5 * [new tag] 2.0.6 -> 2.0.6 * [new tag] 2.0.7 -> 2.0.7 [rtd-command-info] start-time: 2023-09-25T16:34:56.176093Z, end-time: 2023-09-25T16:34:56.388530Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: switching to '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 switching back to a branch. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -c with the switch command. Example: git switch -c Or undo this operation with: git switch - Turn off this advice by setting config variable advice.detachedHead to false HEAD is now at 340d4d9 Merge pull request #181 from hellonarrativ/BAM-21341 [rtd-command-info] start-time: 2023-09-25T16:34:56.896490Z, end-time: 2023-09-25T16:34:56.951838Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2023-09-25T16:34:57.389562Z, end-time: 2023-09-25T16:34:57.446737Z, duration: 0, exit-code: 0 cat .readthedocs.yaml # .readthedocs.yaml # Read the Docs configuration file # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details # Required version: 2 # Set the version of Python and other tools you might need build: os: ubuntu-22.04 tools: python: "3.11" # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/conf.py # We recommend specifying your dependencies to enable reproducible builds: # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html # python: # install: # - requirements: docs/requirements.txt [rtd-command-info] start-time: 2023-09-25T16:35:06.536615Z, end-time: 2023-09-25T16:35:06.622194Z, duration: 0, exit-code: 0 asdf global python 3.11.4 [rtd-command-info] start-time: 2023-09-25T16:35:08.339585Z, end-time: 2023-09-25T16:35:09.330058Z, duration: 0, exit-code: 0 python -mvirtualenv $READTHEDOCS_VIRTUALENV_PATH created virtual environment CPython3.11.4.final.0-64 in 656ms creator CPython3Posix(dest=/home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest, clear=False, no_vcs_ignore=False, global=False) seeder FromAppData(download=False, pip=bundle, setuptools=bundle, wheel=bundle, via=copy, app_data_dir=/home/docs/.local/share/virtualenv) added seed packages: pip==21.2.3, setuptools==57.4.0, wheel==0.37.0 activators BashActivator,CShellActivator,FishActivator,PowerShellActivator,PythonActivator [rtd-command-info] start-time: 2023-09-25T16:35:09.795645Z, end-time: 2023-09-25T16:35:19.445186Z, duration: 9, 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.11/site-packages (21.2.3) Collecting pip Downloading pip-23.2.1-py3-none-any.whl (2.1 MB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.11/site-packages (57.4.0) Collecting setuptools Downloading setuptools-68.2.2-py3-none-any.whl (807 kB) Installing collected packages: setuptools, pip Attempting uninstall: setuptools Found existing installation: setuptools 57.4.0 Uninstalling setuptools-57.4.0: Successfully uninstalled setuptools-57.4.0 Attempting uninstall: pip Found existing installation: pip 21.2.3 Uninstalling pip-21.2.3: Successfully uninstalled pip-21.2.3 Successfully installed pip-23.2.1 setuptools-68.2.2 [rtd-command-info] start-time: 2023-09-25T16:35:20.359239Z, end-time: 2023-09-25T16:35:29.369112Z, duration: 9, exit-code: 0 python -m pip install --upgrade --no-cache-dir pillow mock==1.0.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.9.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<2.3 jinja2<3.1.0 Collecting pillow Obtaining dependency information for pillow from https://files.pythonhosted.org/packages/3c/49/f87cecbdec4b00cc1187f01196d48c08828204cd861915fab44972dc705c/Pillow-10.0.1-cp311-cp311-manylinux_2_28_x86_64.whl.metadata Downloading Pillow-10.0.1-cp311-cp311-manylinux_2_28_x86_64.whl.metadata (9.5 kB) Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 kB 7.4 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting alabaster!=0.7.5,<0.8,>=0.7 Downloading alabaster-0.7.13-py3-none-any.whl (13 kB) Collecting commonmark==0.9.1 Downloading commonmark-0.9.1-py2.py3-none-any.whl (51 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 51.1/51.1 kB 74.6 MB/s eta 0:00:00 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.6-py2.py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 21.0 MB/s eta 0:00:00 Collecting sphinx-rtd-theme<0.5 Downloading sphinx_rtd_theme-0.4.3-py2.py3-none-any.whl (6.4 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.4/6.4 MB 53.6 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<2.3 Obtaining dependency information for readthedocs-sphinx-ext<2.3 from https://files.pythonhosted.org/packages/8c/f1/3d783ebfc084a9d556123d54669116101760e5e0dbb894b006745bcb59ea/readthedocs_sphinx_ext-2.2.2-py2.py3-none-any.whl.metadata Downloading readthedocs_sphinx_ext-2.2.2-py2.py3-none-any.whl.metadata (1.5 kB) Collecting jinja2<3.1.0 Downloading Jinja2-3.0.3-py3-none-any.whl (133 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 133.6/133.6 kB 176.4 MB/s eta 0:00:00 Collecting docutils>=0.11 (from recommonmark==0.5.0) Obtaining dependency information for docutils>=0.11 from https://files.pythonhosted.org/packages/26/87/f238c0670b94533ac0353a4e2a1a771a0cc73277b88bff23d3ae35a256c1/docutils-0.20.1-py3-none-any.whl.metadata Downloading docutils-0.20.1-py3-none-any.whl.metadata (2.8 kB) Collecting six>=1.5 (from sphinx<2) Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting Pygments>=2.0 (from sphinx<2) Obtaining dependency information for Pygments>=2.0 from https://files.pythonhosted.org/packages/43/88/29adf0b44ba6ac85045e63734ae0997d3c58d8b1a91c914d240828d0d73d/Pygments-2.16.1-py3-none-any.whl.metadata Downloading Pygments-2.16.1-py3-none-any.whl.metadata (2.5 kB) Collecting docutils>=0.11 (from recommonmark==0.5.0) Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 kB 89.9 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 (from sphinx<2) Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 kB 165.5 MB/s eta 0:00:00 Collecting babel!=2.0,>=1.3 (from sphinx<2) Downloading Babel-2.12.1-py3-none-any.whl (10.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 10.1/10.1 MB 116.2 MB/s eta 0:00:00 Collecting imagesize (from sphinx<2) Downloading imagesize-1.4.1-py2.py3-none-any.whl (8.8 kB) Collecting requests>=2.0.0 (from sphinx<2) Obtaining dependency information for requests>=2.0.0 from https://files.pythonhosted.org/packages/70/8e/0e2d847013cb52cd35b38c009bb167a1a26b2ce6cd6965bf26b47bc0bf44/requests-2.31.0-py3-none-any.whl.metadata Downloading requests-2.31.0-py3-none-any.whl.metadata (4.6 kB) Requirement already satisfied: setuptools in /home/docs/checkouts/readthedocs.org/user_builds/narrativ-narrativ/envs/latest/lib/python3.11/site-packages (from sphinx<2) (68.2.2) Collecting packaging (from sphinx<2) Downloading packaging-23.1-py3-none-any.whl (48 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 48.9/48.9 kB 149.3 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport (from sphinx<2) Obtaining dependency information for sphinxcontrib-websupport from https://files.pythonhosted.org/packages/40/d2/fd1c52203f1385bc95775d36e9f334358cc457ea3e44046fc6d78a868d10/sphinxcontrib_websupport-1.2.6-py3-none-any.whl.metadata Downloading sphinxcontrib_websupport-1.2.6-py3-none-any.whl.metadata (2.5 kB) Collecting MarkupSafe>=2.0 (from jinja2<3.1.0) Obtaining dependency information for MarkupSafe>=2.0 from https://files.pythonhosted.org/packages/fe/21/2eff1de472ca6c99ec3993eab11308787b9879af9ca8bbceb4868cf4f2ca/MarkupSafe-2.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata Downloading MarkupSafe-2.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (3.0 kB) Collecting charset-normalizer<4,>=2 (from requests>=2.0.0->sphinx<2) Obtaining dependency information for charset-normalizer<4,>=2 from https://files.pythonhosted.org/packages/bc/85/ef25d4ba14c7653c3020a1c6e1a7413e6791ef36a0ac177efa605fc2c737/charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata Downloading charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl.metadata (31 kB) Collecting idna<4,>=2.5 (from requests>=2.0.0->sphinx<2) Downloading idna-3.4-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.5/61.5 kB 145.8 MB/s eta 0:00:00 Collecting urllib3<3,>=1.21.1 (from requests>=2.0.0->sphinx<2) Obtaining dependency information for urllib3<3,>=1.21.1 from https://files.pythonhosted.org/packages/37/dc/399e63f5d1d96bb643404ee830657f4dfcf8503f5ba8fa3c6d465d0c57fe/urllib3-2.0.5-py3-none-any.whl.metadata Downloading urllib3-2.0.5-py3-none-any.whl.metadata (6.6 kB) Collecting certifi>=2017.4.17 (from requests>=2.0.0->sphinx<2) Obtaining dependency information for certifi>=2017.4.17 from https://files.pythonhosted.org/packages/4c/dd/2234eab22353ffc7d94e8d13177aaa050113286e93e7b40eae01fbf7c3d9/certifi-2023.7.22-py3-none-any.whl.metadata Downloading certifi-2023.7.22-py3-none-any.whl.metadata (2.2 kB) INFO: pip is looking at multiple versions of sphinxcontrib-websupport to determine which version is compatible with other requirements. This could take a while. Collecting sphinxcontrib-websupport (from sphinx<2) Obtaining dependency information for sphinxcontrib-websupport from https://files.pythonhosted.org/packages/1d/5b/b6f6d68a2478654bf9120bc04430551cf5011a9288c88d38c6541c36086e/sphinxcontrib_websupport-1.2.5-py3-none-any.whl.metadata Downloading sphinxcontrib_websupport-1.2.5-py3-none-any.whl.metadata (2.5 kB) Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting sphinxcontrib-serializinghtml (from sphinxcontrib-websupport->sphinx<2) Obtaining dependency information for sphinxcontrib-serializinghtml from https://files.pythonhosted.org/packages/95/d6/2e0bda62b2a808070ac922d21a950aa2cb5e4fcfb87e5ff5f86bc43a2201/sphinxcontrib_serializinghtml-1.1.9-py3-none-any.whl.metadata Downloading sphinxcontrib_serializinghtml-1.1.9-py3-none-any.whl.metadata (2.3 kB) INFO: pip is looking at multiple versions of sphinxcontrib-serializinghtml to determine which version is compatible with other requirements. This could take a while. Obtaining dependency information for sphinxcontrib-serializinghtml from https://files.pythonhosted.org/packages/dc/85/ea34b6be0494eff8ae281107bb4a83f6c83066b358f2525a251dc852817c/sphinxcontrib_serializinghtml-1.1.8-py3-none-any.whl.metadata Downloading sphinxcontrib_serializinghtml-1.1.8-py3-none-any.whl.metadata (2.3 kB) Obtaining dependency information for sphinxcontrib-serializinghtml from https://files.pythonhosted.org/packages/36/c6/0d5b3f258fdb107558163e88607eb6c245d8785fbd707e027f2da7fbc795/sphinxcontrib_serializinghtml-1.1.7-py3-none-any.whl.metadata Downloading sphinxcontrib_serializinghtml-1.1.7-py3-none-any.whl.metadata (2.3 kB) Obtaining dependency information for sphinxcontrib-serializinghtml from https://files.pythonhosted.org/packages/82/a2/962548d13ceddff95eac7843c9ff37b451c02b69429007b93d6a10a353d3/sphinxcontrib_serializinghtml-1.1.6-py3-none-any.whl.metadata Downloading sphinxcontrib_serializinghtml-1.1.6-py3-none-any.whl.metadata (2.3 kB) Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 kB 166.4 MB/s eta 0:00:00 Downloading Pillow-10.0.1-cp311-cp311-manylinux_2_28_x86_64.whl (3.6 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.6/3.6 MB 143.2 MB/s eta 0:00:00 Downloading readthedocs_sphinx_ext-2.2.2-py2.py3-none-any.whl (11 kB) Downloading MarkupSafe-2.1.3-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (28 kB) Downloading Pygments-2.16.1-py3-none-any.whl (1.2 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 1.2/1.2 MB 171.0 MB/s eta 0:00:00 Downloading requests-2.31.0-py3-none-any.whl (62 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.6/62.6 kB 239.5 MB/s eta 0:00:00 Downloading certifi-2023.7.22-py3-none-any.whl (158 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 158.3/158.3 kB 283.1 MB/s eta 0:00:00 Downloading charset_normalizer-3.2.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (199 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 199.6/199.6 kB 291.6 MB/s eta 0:00:00 Downloading urllib3-2.0.5-py3-none-any.whl (123 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 123.8/123.8 kB 275.6 MB/s eta 0:00:00 Building wheels for collected packages: mock 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=23753 sha256=d547dc2c332988c443645767c3182323b5ded18fc6a6b4f4740ed0d00d85d946 Stored in directory: /tmp/pip-ephem-wheel-cache-5x8orvu0/wheels/80/c2/c8/630c9eb889f0be0202cb11bf30b47aa54bf7588e8d50b70005 Successfully built mock Installing collected packages: snowballstemmer, mock, commonmark, urllib3, sphinxcontrib-serializinghtml, six, Pygments, pillow, packaging, MarkupSafe, imagesize, idna, docutils, charset-normalizer, certifi, babel, alabaster, sphinxcontrib-websupport, requests, jinja2, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed MarkupSafe-2.1.3 Pygments-2.16.1 alabaster-0.7.13 babel-2.12.1 certifi-2023.7.22 charset-normalizer-3.2.0 commonmark-0.9.1 docutils-0.17.1 idna-3.4 imagesize-1.4.1 jinja2-3.0.3 mock-1.0.1 packaging-23.1 pillow-10.0.1 readthedocs-sphinx-ext-2.2.2 recommonmark-0.5.0 requests-2.31.0 six-1.16.0 snowballstemmer-2.2.0 sphinx-1.8.6 sphinx-rtd-theme-0.4.3 sphinxcontrib-serializinghtml-1.1.5 sphinxcontrib-websupport-1.2.4 urllib3-2.0.5 [rtd-command-info] start-time: 2023-09-25T16:35:35.830150Z, end-time: 2023-09-25T16:35:35.882520Z, 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 = 'Howl API' copyright = '2022, Howl Technologies, Inc ' author = 'Howl' # 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 = '2.0.8' # The full version, including alpha/beta/rc tags. release = '2.0.8' # 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/howl-logo-large.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/main/readthedocs/doc_builder/templates/doc_builder/conf.py.tmpl # # Note: this file shouldn't rely on extra dependencies. 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') # Define this variable in case it's not defined by the user. # It defaults to `alabaster` which is the default from Sphinx. # https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme html_theme = globals().get('html_theme', 'alabaster') #Add project information to the template context. context = { '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", 'proxied_static_path': "/_/static/", 'versions': [ ("latest", "/en/latest/"), ("stable", "/en/stable/"), ("2.0.0", "/en/2.0.0/"), ("1.9.28", "/en/1.9.28/"), ("1.9.27", "/en/1.9.27/"), ("1.9.26", "/en/1.9.26/"), ("1.9.24", "/en/1.9.24/"), ("1.9.23", "/en/1.9.23/"), ("1.9.22", "/en/1.9.22/"), ("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.planethowl.com/_/downloads/en/latest/htmlzip/"), ], 'subprojects': [ ], 'slug': 'narrativ-narrativ', 'name': u'Narrativ', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': '', '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': '340d4d94', } # 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(): for key in context: if key not in html_context: html_context[key] = context[key] 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/1740955/' 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: 2023-09-25T16:35:36.451614Z, end-time: 2023-09-25T16:35:37.865703Z, duration: 1, exit-code: 0 python -m sphinx -T -E -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/html Running Sphinx v1.8.6 loading translations [en]... done making output directory... building [mo]: targets for 0 po files that are out of date building [html]: targets for 12 source files that are out of date updating environment: 12 added, 0 changed, 0 removed reading sources... [ 8%] auth reading sources... [ 16%] clickmate reading sources... [ 25%] feeds reading sources... [ 33%] index reading sources... [ 41%] merchantfeeds reading sources... [ 50%] pubreport reading sources... [ 58%] requests reading sources... [ 66%] smartlink reading sources... [ 75%] statistics reading sources... [ 83%] tagbrand reading sources... [ 91%] tagpublisher reading sources... [100%] utmsourcetracking looking for now-outdated files... none found pickling environment... done checking consistency... done preparing documents... done writing output... [ 8%] auth writing output... [ 16%] clickmate writing output... [ 25%] feeds writing output... [ 33%] index writing output... [ 41%] merchantfeeds writing output... [ 50%] pubreport writing output... [ 58%] requests writing output... [ 66%] smartlink writing output... [ 75%] statistics writing output... [ 83%] tagbrand writing output... [ 91%] tagpublisher writing output... [100%] utmsourcetracking generating indices... genindex writing additional pages... search copying images... [ 5%] _static/pixel_implementation_screenshots/test_page_impression_2.png copying images... [ 11%] _static/pixel_implementation_screenshots/test_checkouts_2.png copying images... [ 17%] _static/pixel_implementation_screenshots/discount_1.png copying images... [ 23%] _static/pixel_implementation_screenshots/discount_2.png copying images... [ 29%] _static/pixel_implementation_screenshots/discount_3.png copying images... [ 35%] _static/pixel_implementation_screenshots/shopify_implementation_1.png copying images... [ 41%] _static/pixel_implementation_screenshots/shopify_implementation_2.png copying images... [ 47%] _static/pixel_implementation_screenshots/shopify_implementation_4.png copying images... [ 52%] _static/pixel_implementation_screenshots/shopify_implementation_5.png copying images... [ 58%] _static/pixel_implementation_screenshots/shopify_implementation_6.png copying images... [ 64%] _static/pixel_implementation_screenshots/shopify_implementation_7.png copying images... [ 70%] _static/pixel_implementation_screenshots/shopify_implementation_8.png copying images... [ 76%] _static/pixel_implementation_screenshots/gtm_1.png copying images... [ 82%] _static/pixel_implementation_screenshots/gtm_2.png copying images... [ 88%] _static/pixel_implementation_screenshots/gtm_3.png copying images... [ 94%] _static/pixel_implementation_screenshots/gtm_4.png copying images... [100%] _static/pixel_implementation_screenshots/gtm_6.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 ../_readthedocs/html. Updating searchtools for Read the Docs search...