Read the Docs build information Build id: 23449 Project: imagesourcepy Version: latest Commit: 4236b6e0a769054d50eba4251facf2e2f6f6662c Date: 2022-04-14T12:54:25.555237Z State: finished Success: False [rtd-command-info] start-time: 2022-04-14T12:54:26.751595Z, end-time: 2022-04-14T12:54:28.136581Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/gitlab/karaboDevices/imageSourcePy.git . Cloning into '.'... [rtd-command-info] start-time: 2022-04-14T12:54:28.537802Z, end-time: 2022-04-14T12:54:28.623266Z, duration: 0, exit-code: 0 git checkout --force origin/master Note: checking out 'origin/master'. You are in 'detached HEAD' state. You can look around, make experimental changes and commit them, and you can discard any commits you make in this state without impacting any branches by performing another checkout. If you want to create a new branch to retain commits you create, you may do so (now or later) by using -b with the checkout command again. Example: git checkout -b HEAD is now at 4236b6e Add code quality test [rtd-command-info] start-time: 2022-04-14T12:54:28.757751Z, end-time: 2022-04-14T12:54:28.835166Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-04-14T12:54:30.132861Z, end-time: 2022-04-14T12:54:38.369003Z, duration: 8, exit-code: 0 python3.7 -mvirtualenv --system-site-packages /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest Using base prefix '/home/docs/.pyenv/versions/3.7.3' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python3.7 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-04-14T12:54:38.499993Z, end-time: 2022-04-14T12:54:40.084983Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (22.0.4) [rtd-command-info] start-time: 2022-04-14T12:54:40.218706Z, end-time: 2022-04-14T12:54:56.885283Z, duration: 16, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python -m pip install --upgrade --no-cache-dir -I 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) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 849.5/849.5 KB 11.0 MB/s eta 0:00:00 Collecting setuptools==41.0.1 Downloading setuptools-41.0.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 576.0/576.0 KB 128.5 MB/s eta 0:00:00 Collecting docutils==0.14 Downloading docutils-0.14-py3-none-any.whl (543 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 543.2/543.2 KB 127.4 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 KB 119.8 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting pillow==5.4.1 Downloading Pillow-5.4.1-cp37-cp37m-manylinux1_x86_64.whl (2.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.0/2.0 MB 96.3 MB/s eta 0:00:00 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) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 47.4/47.4 KB 119.0 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 120.1 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 118.7 MB/s eta 0:00:00 Collecting readthedocs-sphinx-ext<1.1 Downloading readthedocs_sphinx_ext-1.0.4-py2.py3-none-any.whl (28 kB) Collecting future Downloading future-0.18.2.tar.gz (829 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 829.2/829.2 KB 139.5 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.8/8.8 MB 121.4 MB/s eta 0:00:00 Collecting snowballstemmer>=1.1 Downloading snowballstemmer-2.2.0-py2.py3-none-any.whl (93 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 93.0/93.0 KB 125.6 MB/s eta 0:00:00 Collecting requests>=2.0.0 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 63.1/63.1 KB 98.4 MB/s eta 0:00:00 Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 KB 125.8 MB/s eta 0:00:00 Collecting imagesize Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.1.1-py3-none-any.whl (132 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 132.6/132.6 KB 127.2 MB/s eta 0:00:00 Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting pytz>=2015.7 Downloading pytz-2022.1-py2.py3-none-any.whl (503 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 503.5/503.5 KB 135.6 MB/s eta 0:00:00 Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting charset-normalizer~=2.0.0 Downloading charset_normalizer-2.0.12-py3-none-any.whl (39 kB) Collecting idna<4,>=2.5 Downloading idna-3.3-py3-none-any.whl (61 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 61.2/61.2 KB 94.4 MB/s eta 0:00:00 Collecting certifi>=2017.4.17 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 149.2/149.2 KB 134.7 MB/s eta 0:00:00 Collecting urllib3<1.27,>=1.21.1 Downloading urllib3-1.26.9-py2.py3-none-any.whl (138 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 139.0/139.0 KB 124.8 MB/s eta 0:00:00 Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.8-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.5/98.5 KB 122.0 MB/s eta 0:00:00 Collecting sphinxcontrib-serializinghtml Downloading sphinxcontrib_serializinghtml-1.1.5-py2.py3-none-any.whl (94 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 94.0/94.0 KB 117.5 MB/s eta 0:00:00 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=23773 sha256=fc04797238f4995a37a0f77af8ab4336832175ad4791da86550bde6af838e819 Stored in directory: /tmp/pip-ephem-wheel-cache-s25j8ipy/wheels/7a/94/b1/0fdc5339a5bd487a5cc15421ec200d9ba3e2aa7190e4a727f1 Building wheel for future (setup.py): started Building wheel for future (setup.py): finished with status 'done' Created wheel for future: filename=future-0.18.2-py3-none-any.whl size=491070 sha256=4f1a62d81066dc47d10d04b9de2571fe7c7818ce78e861fea26a80bbadc31993 Stored in directory: /tmp/pip-ephem-wheel-cache-s25j8ipy/wheels/56/b0/fe/4410d17b32f1f0c3cf54cdfb2bc04d7b4b8f4ae377e2229ba0 Successfully built mock future Installing collected packages: snowballstemmer, pytz, Pygments, mock, docutils, certifi, alabaster, urllib3, sphinxcontrib-serializinghtml, six, setuptools, pyparsing, pillow, MarkupSafe, imagesize, idna, future, charset-normalizer, babel, sphinxcontrib-websupport, requests, packaging, Jinja2, commonmark, sphinx, readthedocs-sphinx-ext, sphinx-rtd-theme, recommonmark Successfully installed Jinja2-3.1.1 MarkupSafe-2.1.1 Pygments-2.3.1 alabaster-0.7.12 babel-2.9.1 certifi-2021.10.8 charset-normalizer-2.0.12 commonmark-0.8.1 docutils-0.14 future-0.18.2 idna-3.3 imagesize-1.3.0 mock-1.0.1 packaging-21.3 pillow-5.4.1 pyparsing-3.0.8 pytz-2022.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.27.1 setuptools-62.1.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-1.26.9 [rtd-command-info] start-time: 2022-04-14T12:54:57.022059Z, end-time: 2022-04-14T12:55:01.058698Z, duration: 4, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt Collecting git+https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git (from -r doc/requirements.txt (line 1)) Cloning https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to /tmp/pip-req-build-j9b4688u Running command git clone --filter=blob:none --quiet https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git /tmp/pip-req-build-j9b4688u Resolved https://git.xfel.eu/gitlab/xfel-rtd/rtd-conf.git to commit 3d66246db37045eaa716d206b13441613c1b413e Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting slumber Downloading slumber-0.7.1.tar.gz (10 kB) Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting traits Downloading traits-6.3.2-cp37-cp37m-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (5.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 5.1/5.1 MB 38.2 MB/s eta 0:00:00 Collecting future-fstrings Downloading future_fstrings-1.2.0-py2.py3-none-any.whl (6.1 kB) Requirement already satisfied: numpy in /home/docs/.pyenv/versions/3.7.3/lib/python3.7/site-packages (from -r doc/requirements.txt (line 5)) (1.18.1) Requirement already satisfied: requests in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (from slumber->-r doc/requirements.txt (line 2)) (2.27.1) Requirement already satisfied: charset-normalizer~=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (from requests->slumber->-r doc/requirements.txt (line 2)) (2.0.12) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (from requests->slumber->-r doc/requirements.txt (line 2)) (2021.10.8) Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (from requests->slumber->-r doc/requirements.txt (line 2)) (3.3) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages (from requests->slumber->-r doc/requirements.txt (line 2)) (1.26.9) Building wheels for collected packages: RTDConf, slumber Building wheel for RTDConf (setup.py): started Building wheel for RTDConf (setup.py): finished with status 'done' Created wheel for RTDConf: filename=RTDConf-0.1-py3-none-any.whl size=2648 sha256=cf6f078e670e007437bab603bf3954a15526c53bfd840adc81ce328d5007c6ad Stored in directory: /tmp/pip-ephem-wheel-cache-hwrmerzm/wheels/17/a3/d4/e42b943fdbccc9aa92ab080ea1739cd6987c6c6d000fb359e4 Building wheel for slumber (setup.py): started Building wheel for slumber (setup.py): finished with status 'done' Created wheel for slumber: filename=slumber-0.7.1-py3-none-any.whl size=8098 sha256=3a164532e0b45bf4d70291d94997ce1ddede6f79cf136f2779232e6b87ad4bd8 Stored in directory: /tmp/pip-ephem-wheel-cache-hwrmerzm/wheels/eb/d6/67/f165e383ef89df4d90f29343f2e120543adc1886663e9f139b Successfully built RTDConf slumber Installing collected packages: RTDConf, traits, future-fstrings, slumber Successfully installed RTDConf-0.1 future-fstrings-1.2.0 slumber-0.7.1 traits-6.3.2 [rtd-command-info] start-time: 2022-04-14T12:55:01.186892Z, end-time: 2022-04-14T12:55:01.701430Z, duration: 0, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/python /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/checkouts/latest/setup.py install --force WARNING: Karabo framework not found! Version will be blank! running install running bdist_egg running egg_info creating src/imageSource.egg-info writing src/imageSource.egg-info/PKG-INFO writing dependency_links to src/imageSource.egg-info/dependency_links.txt writing top-level names to src/imageSource.egg-info/top_level.txt writing manifest file 'src/imageSource.egg-info/SOURCES.txt' reading manifest file 'src/imageSource.egg-info/SOURCES.txt' writing manifest file 'src/imageSource.egg-info/SOURCES.txt' installing library code to build/bdist.linux-x86_64/egg running install_lib running build_py creating build creating build/lib creating build/lib/imageSource copying src/imageSource/utils.py -> build/lib/imageSource copying src/imageSource/__init__.py -> build/lib/imageSource copying src/imageSource/CameraImageSource.py -> build/lib/imageSource copying src/imageSource/ImageSource.py -> build/lib/imageSource copying src/imageSource/scenes.py -> build/lib/imageSource creating build/lib/imageSource/tests copying src/imageSource/tests/__init__.py -> build/lib/imageSource/tests copying src/imageSource/tests/code_quality_test.py -> build/lib/imageSource/tests copying src/imageSource/tests/test_utils.py -> build/lib/imageSource/tests copying src/imageSource/tests/image_source_test.py -> build/lib/imageSource/tests creating build/bdist.linux-x86_64 creating build/bdist.linux-x86_64/egg creating build/bdist.linux-x86_64/egg/imageSource copying build/lib/imageSource/utils.py -> build/bdist.linux-x86_64/egg/imageSource copying build/lib/imageSource/__init__.py -> build/bdist.linux-x86_64/egg/imageSource copying build/lib/imageSource/CameraImageSource.py -> build/bdist.linux-x86_64/egg/imageSource copying build/lib/imageSource/ImageSource.py -> build/bdist.linux-x86_64/egg/imageSource copying build/lib/imageSource/scenes.py -> build/bdist.linux-x86_64/egg/imageSource creating build/bdist.linux-x86_64/egg/imageSource/tests copying build/lib/imageSource/tests/__init__.py -> build/bdist.linux-x86_64/egg/imageSource/tests copying build/lib/imageSource/tests/code_quality_test.py -> build/bdist.linux-x86_64/egg/imageSource/tests copying build/lib/imageSource/tests/test_utils.py -> build/bdist.linux-x86_64/egg/imageSource/tests copying build/lib/imageSource/tests/image_source_test.py -> build/bdist.linux-x86_64/egg/imageSource/tests byte-compiling build/bdist.linux-x86_64/egg/imageSource/utils.py to utils.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/__init__.py to __init__.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/CameraImageSource.py to CameraImageSource.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/ImageSource.py to ImageSource.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/scenes.py to scenes.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/tests/__init__.py to __init__.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/tests/code_quality_test.py to code_quality_test.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/tests/test_utils.py to test_utils.cpython-37.pyc byte-compiling build/bdist.linux-x86_64/egg/imageSource/tests/image_source_test.py to image_source_test.cpython-37.pyc creating build/bdist.linux-x86_64/egg/EGG-INFO copying src/imageSource.egg-info/PKG-INFO -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/imageSource.egg-info/SOURCES.txt -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/imageSource.egg-info/dependency_links.txt -> build/bdist.linux-x86_64/egg/EGG-INFO copying src/imageSource.egg-info/top_level.txt -> build/bdist.linux-x86_64/egg/EGG-INFO /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/setuptools/config/__init__.py:28: SetuptoolsDeprecationWarning: As setuptools moves its configuration towards `pyproject.toml`, `setuptools.config.parse_configuration` became deprecated. For the time being, you can use the `setuptools.config.setupcfg` module to access a backward compatible API, but this module is provisional and might be removed in the future. warnings.warn(dedent(msg), SetuptoolsDeprecationWarning) /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/setuptools/dist.py:481: UserWarning: The version specified ('') is an invalid version, this may not work as expected with newer versions of setuptools, pip, and PyPI. Please see PEP 440 for more details. "details." % self.metadata.version zip_safe flag not set; analyzing archive contents... imageSource.tests.__pycache__.code_quality_test.cpython-37: module references __file__ creating dist creating 'dist/imageSource-0.0.0-py3.7.egg' and adding 'build/bdist.linux-x86_64/egg' to it removing 'build/bdist.linux-x86_64/egg' (and everything under it) Processing imageSource-0.0.0-py3.7.egg creating /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/imageSource-0.0.0-py3.7.egg Extracting imageSource-0.0.0-py3.7.egg to /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages Adding imageSource 0.0.0 to easy-install.pth file Installed /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/imageSource-0.0.0-py3.7.egg Processing dependencies for imageSource==0.0.0 Finished processing dependencies for imageSource==0.0.0 [rtd-command-info] start-time: 2022-04-14T12:55:02.786736Z, end-time: 2022-04-14T12:55:02.864741Z, duration: 0, exit-code: 0 cat doc/source/conf.py #!/usr/bin/env python3 # -*- coding: utf-8 -*- # # ImageSourcePy documentation build configuration file, created by # sphinx-quickstart on Wed Jan 8 12:38:44 2020. # # 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 subprocess import sys from rtd_conf import global_conf # Copy source files to temporary location, and by doing so prepend to them # future_fstrings coding subprocess.call(["./preprocessor.py", "../../src", "../build/tmp"]) sys.path.insert(0, os.path.abspath('../build/tmp')) # -- 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.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.mathjax', 'sphinx.ext.ifconfig', 'sphinx.ext.viewcode', ] # 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 encoding of source files. # # source_encoding = 'utf-8-sig' # The master toctree document. master_doc = 'index' # General information about the project. project = 'ImageSourcePy' copyright = '2020, A. Parenti' author = 'A. Parenti' # 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. version = '1.0' # The full version, including alpha/beta/rc tags. release = '1.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 # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: # # today = '' # # Else, today_fmt is used as the format for a strftime call. # # today_fmt = '%B %d, %Y' # 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 = [] # The reST default role (used for this markup: `text`) to use for all # documents. # # default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. # # add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). # # add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. # # show_authors = False # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' # A list of ignored prefixes for module index sorting. # modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. # keep_warnings = False # 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. # html_theme = 'default' # 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. # # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. # html_theme_path = [] # The name for this set of Sphinx documents. # " v documentation" by default. # # html_title = 'ImageSourcePy v1.0' # A shorter title for the navigation bar. Default is the same as html_title. # # html_short_title = None # The name of an image file (relative to this directory) to place at the top # of the sidebar. # # html_logo = None # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # # html_favicon = None # 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". html_static_path = ['_static'] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. # # html_extra_path = [] # If not None, a 'Last updated on:' timestamp is inserted at every page # bottom, using the given strftime format. # The empty string is equivalent to '%b %d, %Y'. # # html_last_updated_fmt = None # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # # html_use_smartypants = True # Custom sidebar templates, maps document names to template names. # # html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. # # html_additional_pages = {} # If false, no module index is generated. # # html_domain_indices = True # If false, no index is generated. # # html_use_index = True # If true, the index is split into individual pages for each letter. # # html_split_index = False # If true, links to the reST sources are added to the pages. # # html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. # # html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. # # html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. # # html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None # Language to be used for generating the HTML full-text search index. # Sphinx supports the following languages: # 'da', 'de', 'en', 'es', 'fi', 'fr', 'h', 'it', 'ja' # 'nl', 'no', 'pt', 'ro', 'r', 'sv', 'tr', 'zh' # # html_search_language = 'en' # A dictionary with options for the search language support, empty by default. # 'ja' uses this config value. # 'zh' user can custom change `jieba` dictionary path. # # html_search_options = {'type': 'default'} # The name of a javascript file (relative to the configuration directory) that # implements a search results scorer. If empty, the default will be used. # # html_search_scorer = 'scorer.js' # Output file base name for HTML help builder. htmlhelp_basename = 'ImageSourcePydoc' # -- 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, 'ImageSourcePy.tex', 'ImageSourcePy Documentation', 'A. Parenti', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of # the title page. # # latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. # # latex_use_parts = False # If true, show page references after internal links. # # latex_show_pagerefs = False # If true, show URL addresses after external links. # # latex_show_urls = False # Documents to append as an appendix to all manuals. # # latex_appendices = [] # It false, will not define \strong, \code, itleref, \crossref ... but only # \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added # packages. # # latex_keep_old_macro_names = True # If false, no module index is generated. # # latex_domain_indices = True # -- 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, 'imagesourcepy', 'ImageSourcePy Documentation', [author], 1) ] # If true, show URL addresses after external links. # # man_show_urls = False # -- 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, 'ImageSourcePy', 'ImageSourcePy Documentation', author, 'ImageSourcePy', 'One line description of project.', 'Miscellaneous'), ] # Documents to append as an appendix to all manuals. # # texinfo_appendices = [] # If false, no module index is generated. # # texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. # # texinfo_show_urls = 'footnote' # If true, do not generate a @detailmenu in the "Top" node's menu. # # texinfo_no_detailmenu = False # Example configuration for intersphinx: refer to the Python standard library. # intersphinx_mapping = {'https://docs.python.org/': None} # We've already set this in global_conf. Don't set it here ########################################################################### # 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 = 'http://rtd.xfel.eu/websupport' websupport2_static_url = '/static/' #Add project information to the template context. context = { 'using_theme': using_rtd_theme, 'html_theme': html_theme, 'current_version': "latest", 'version_slug': "latest", 'MEDIA_URL': "media/", 'STATIC_URL': "/static/", 'PRODUCTION_DOMAIN': "rtd.xfel.eu", 'versions': [ ("latest", "/en/latest/"), ], 'downloads': [ ("pdf", "//rtd.xfel.eu/downloads/imagesourcepy/latest/pdf/"), ("html", "//rtd.xfel.eu/downloads/imagesourcepy/latest/htmlzip/"), ("epub", "//rtd.xfel.eu/downloads/imagesourcepy/latest/epub/"), ], 'subprojects': [ ], 'slug': 'imagesourcepy', 'name': u'ImageSourcePy', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/imagesourcepy/en/latest/', 'analytics_code': '', 'single_version': False, 'conf_py_path': '/doc/source/', 'api_host': 'http://rtd.xfel.eu', 'github_user': 'None', 'proxied_api_host': '/_', 'github_repo': 'None', 'github_version': 'master', 'display_github': False, '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': 'None', 'commit': '4236b6e0', } if 'html_context' in globals(): html_context.update(context) else: html_context = context # Add custom RTD extension if 'extensions' in globals(): # Insert at the beginning because it can interfere # with other extensions. # See https://github.com/rtfd/readthedocs.org/pull/4054 extensions.insert(0, "readthedocs_ext.readthedocs") else: extensions = ["readthedocs_ext.readthedocs"] # Add External version warning banner to the external version documentation if 'branch' == 'external': extensions.insert(1, "readthedocs_ext.external_version_warning") 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: 2022-04-14T12:55:02.994221Z, end-time: 2022-04-14T12:55:05.217994Z, duration: 2, exit-code: 2 python /usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/bin/sphinx-build -T -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Running Sphinx v1.8.6 loading translations [en]... done Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/registry.py", line 472, in load_extension mod = __import__(extname, None, None, ['setup']) File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/builders/latex/__init__.py", line 37, in from sphinx.writers.latex import DEFAULT_SETTINGS, LaTeXWriter, LaTeXTranslator File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/writers/latex.py", line 33, in from sphinx.util.template import LaTeXRenderer File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/util/template.py", line 17, in from sphinx.jinja2glue import SphinxFileSystemLoader File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/jinja2glue.py", line 16, in from jinja2 import FileSystemLoader, BaseLoader, TemplateNotFound, \ ImportError: cannot import name 'contextfunction' from 'jinja2' (/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/jinja2/__init__.py) During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/cmd/build.py", line 303, in build_main args.tags, args.verbosity, args.jobs, args.keep_going) File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 224, in __init__ self.setup_extension(extension) File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/application.py", line 449, in setup_extension self.registry.load_extension(self, extname) File "/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/sphinx/registry.py", line 475, in load_extension raise ExtensionError(__('Could not import extension %s') % extname, err) sphinx.errors.ExtensionError: Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/jinja2/__init__.py)) Extension error: Could not import extension sphinx.builders.latex (exception: cannot import name 'contextfunction' from 'jinja2' (/usr/src/app/checkouts/readthedocs.org/user_builds/imagesourcepy/envs/latest/lib/python3.7/site-packages/jinja2/__init__.py))