Read the Docs build information Build id: 23346 Project: recovery-portal Version: basic-user-docs Commit: 68c175326692c489bef6563bc8fa7dd90b9afe8a Date: 2022-03-30T13:18:04.189903Z State: finished Success: False [rtd-command-info] start-time: 2022-03-30T13:18:05.140925Z, end-time: 2022-03-30T13:18:07.003651Z, duration: 1, exit-code: 0 git clone --no-single-branch --depth 50 http://git.xfel.eu/karaboDevices/recoveryPortal.git . Cloning into '.'... [rtd-command-info] start-time: 2022-03-30T13:18:07.342979Z, end-time: 2022-03-30T13:18:07.431038Z, duration: 0, exit-code: 0 git checkout --force origin/basic-user-docs Note: checking out 'origin/basic-user-docs'. 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 68c1753 add reqs [rtd-command-info] start-time: 2022-03-30T13:18:07.563471Z, end-time: 2022-03-30T13:18:07.647395Z, duration: 0, exit-code: 0 git clean -d -f -f [rtd-command-info] start-time: 2022-03-30T13:18:09.326754Z, end-time: 2022-03-30T13:18:15.148251Z, duration: 5, exit-code: 0 python3.8 -mvirtualenv /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs Using base prefix '/home/docs/.pyenv/versions/3.8.0' New python executable in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/python3.8 Also creating executable in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/python Installing setuptools, pip, wheel... done. [rtd-command-info] start-time: 2022-03-30T13:18:15.280540Z, end-time: 2022-03-30T13:18:16.297354Z, duration: 1, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/python -m pip install --upgrade --no-cache-dir pip Requirement already satisfied: pip in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (22.0.4) [rtd-command-info] start-time: 2022-03-30T13:18:16.428722Z, end-time: 2022-03-30T13:18:56.399398Z, duration: 39, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/python -m pip install --upgrade --no-cache-dir Pygments==2.3.1 setuptools==41.0.1 docutils==0.14 mock==1.0.1 pillow==5.4.1 alabaster>=0.7,<0.8,!=0.7.5 commonmark==0.8.1 recommonmark==0.5.0 sphinx<2 sphinx-rtd-theme<0.5 readthedocs-sphinx-ext<1.1 Collecting Pygments==2.3.1 Downloading Pygments-2.3.1-py2.py3-none-any.whl (849 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 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 111.7 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 124.1 MB/s eta 0:00:00 Collecting mock==1.0.1 Downloading mock-1.0.1.zip (861 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 861.9/861.9 KB 109.3 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.tar.gz (16.0 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 16.0/16.0 MB 117.8 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.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 104.8 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 99.8 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 99.6 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 104.8 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting requests>=2.0.0 Downloading requests-2.27.1-py2.py3-none-any.whl (63 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 63.1/63.1 KB 123.1 MB/s eta 0:00:00 Collecting imagesize Downloading imagesize-1.3.0-py2.py3-none-any.whl (5.2 kB) Collecting Jinja2>=2.3 Downloading Jinja2-3.1.1-py3-none-any.whl (132 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 132.6/132.6 KB 127.3 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 133.4 MB/s eta 0:00:00 Collecting six>=1.5 Downloading six-1.16.0-py2.py3-none-any.whl (11 kB) Collecting babel!=2.0,>=1.3 Downloading Babel-2.9.1-py2.py3-none-any.whl (8.8 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 8.8/8.8 MB 116.4 MB/s eta 0:00:00 Collecting packaging Downloading packaging-21.3-py3-none-any.whl (40 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 40.8/40.8 KB 126.0 MB/s eta 0:00:00 Collecting sphinxcontrib-websupport Downloading sphinxcontrib_websupport-1.2.4-py2.py3-none-any.whl (39 kB) Collecting pytz>=2015.7 Downloading pytz-2022.1-py2.py3-none-any.whl (503 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 503.5/503.5 KB 138.5 MB/s eta 0:00:00 Collecting MarkupSafe>=2.0 Downloading MarkupSafe-2.1.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (25 kB) Collecting certifi>=2017.4.17 Downloading certifi-2021.10.8-py2.py3-none-any.whl (149 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 149.2/149.2 KB 144.6 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 122.4 MB/s eta 0:00:00 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 101.2 MB/s eta 0:00:00 Collecting pyparsing!=3.0.5,>=2.0.2 Downloading pyparsing-3.0.7-py3-none-any.whl (98 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 98.0/98.0 KB 13.7 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 80.2 MB/s eta 0:00:00 Building wheels for collected packages: mock, pillow, 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=d23eeb4ff8fa0b02d1ae4bc727020f3ced8b470091bf84f5bc10b9573d5d05a0 Stored in directory: /tmp/pip-ephem-wheel-cache-k8qged7o/wheels/41/7c/21/90057f91c6ead7c77a90c52d6e85ca48bf82d8b0d3f8dfbb65 Building wheel for pillow (setup.py): started Building wheel for pillow (setup.py): finished with status 'done' Created wheel for pillow: filename=Pillow-5.4.1-cp38-cp38-linux_x86_64.whl size=1262963 sha256=19531d046e4720abb4b8f8a12ab7f84b5189ac82ec494160075e8e3c359cec59 Stored in directory: /tmp/pip-ephem-wheel-cache-k8qged7o/wheels/5f/a8/6b/5b7b3f764d879214eb03570f74d2b086201eb514e6ffa68d6d 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=825103634d0e50d9de2e04ee837dbc26cb4f800243716247fcac8efb5288684a Stored in directory: /tmp/pip-ephem-wheel-cache-k8qged7o/wheels/8e/70/28/3d6ccd6e315f65f245da085482a2e1c7d14b90b30f239e2cf4 Successfully built mock pillow 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 Attempting uninstall: setuptools Found existing installation: setuptools 61.2.0 Uninstalling setuptools-61.2.0: Successfully uninstalled setuptools-61.2.0 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.7 pytz-2022.1 readthedocs-sphinx-ext-1.0.4 recommonmark-0.5.0 requests-2.27.1 setuptools-41.0.1 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-03-30T13:18:56.530732Z, end-time: 2022-03-30T13:19:02.636470Z, duration: 6, exit-code: 0 /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/python -m pip install --exists-action=w --no-cache-dir -r doc/requirements.txt Requirement already satisfied: MarkupSafe in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from -r doc/requirements.txt (line 4)) (2.1.1) Collecting myst_parser Downloading myst_parser-0.17.0-py3-none-any.whl (52 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 52.8/52.8 KB 2.4 MB/s eta 0:00:00 Collecting Jinja2==2.7.2 Downloading Jinja2-2.7.2.tar.gz (378 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 378.3/378.3 KB 9.3 MB/s eta 0:00:00 Preparing metadata (setup.py): started Preparing metadata (setup.py): finished with status 'done' Collecting markdown-it-py<3.0.0,>=1.0.0 Downloading markdown_it_py-2.0.1-py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.1/84.1 KB 51.9 MB/s eta 0:00:00 Collecting mdit-py-plugins~=0.3.0 Downloading mdit_py_plugins-0.3.0-py3-none-any.whl (43 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 43.7/43.7 KB 96.6 MB/s eta 0:00:00 Collecting sphinx<5,>=3.1 Downloading Sphinx-4.5.0-py3-none-any.whl (3.1 MB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 56.0 MB/s eta 0:00:00 Collecting typing-extensions Downloading typing_extensions-4.1.1-py3-none-any.whl (26 kB) Collecting docutils<0.18,>=0.15 Downloading docutils-0.17.1-py2.py3-none-any.whl (575 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 575.5/575.5 KB 142.5 MB/s eta 0:00:00 Collecting pyyaml Downloading PyYAML-6.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_12_x86_64.manylinux2010_x86_64.whl (701 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 701.2/701.2 KB 86.4 MB/s eta 0:00:00 Collecting mdurl~=0.1 Downloading mdurl-0.1.0-py3-none-any.whl (11 kB) Collecting attrs<22,>=19 Downloading attrs-21.4.0-py2.py3-none-any.whl (60 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 60.6/60.6 KB 132.2 MB/s eta 0:00:00 Requirement already satisfied: Pygments>=2.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2.3.1) Collecting sphinxcontrib-devhelp Downloading sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl (84 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 84.7/84.7 KB 116.0 MB/s eta 0:00:00 Collecting sphinxcontrib-jsmath Downloading sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl (5.1 kB) Collecting sphinxcontrib-applehelp Downloading sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl (121 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 121.2/121.2 KB 118.2 MB/s eta 0:00:00 Requirement already satisfied: babel>=1.3 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2.9.1) Collecting importlib-metadata>=4.4 Downloading importlib_metadata-4.11.3-py3-none-any.whl (18 kB) Requirement already satisfied: imagesize in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (1.3.0) Requirement already satisfied: snowballstemmer>=1.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2.2.0) Collecting sphinxcontrib-qthelp Downloading sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl (90 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 90.6/90.6 KB 126.1 MB/s eta 0:00:00 Requirement already satisfied: alabaster<0.8,>=0.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (0.7.12) Requirement already satisfied: packaging in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (21.3) Requirement already satisfied: sphinxcontrib-serializinghtml>=1.1.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (1.1.5) Collecting sphinxcontrib-htmlhelp>=2.0.0 Downloading sphinxcontrib_htmlhelp-2.0.0-py2.py3-none-any.whl (100 kB) ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 100.5/100.5 KB 123.6 MB/s eta 0:00:00 Requirement already satisfied: requests>=2.5.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2.27.1) Requirement already satisfied: pytz>=2015.7 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from babel>=1.3->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2022.1) Collecting zipp>=0.5 Downloading zipp-3.7.0-py3-none-any.whl (5.3 kB) Requirement already satisfied: charset-normalizer~=2.0.0 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from requests>=2.5.0->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2.0.12) Requirement already satisfied: urllib3<1.27,>=1.21.1 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from requests>=2.5.0->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (1.26.9) Requirement already satisfied: certifi>=2017.4.17 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from requests>=2.5.0->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (2021.10.8) Requirement already satisfied: idna<4,>=2.5 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from requests>=2.5.0->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (3.3) Requirement already satisfied: pyparsing!=3.0.5,>=2.0.2 in /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages (from packaging->sphinx<5,>=3.1->myst_parser->-r doc/requirements.txt (line 5)) (3.0.7) Building wheels for collected packages: Jinja2 Building wheel for Jinja2 (setup.py): started Building wheel for Jinja2 (setup.py): finished with status 'done' Created wheel for Jinja2: filename=Jinja2-2.7.2-py3-none-any.whl size=296980 sha256=4789e35d35ae6616d7d78a69ba092c427e6623a8adcddb0f52c5ac5acaf9cfcc Stored in directory: /tmp/pip-ephem-wheel-cache-r1wmbp9c/wheels/e4/93/70/f6cdc9e2f2433e8375c53e1f90c6df87dc57b92d8f6c106caf Successfully built Jinja2 Installing collected packages: zipp, typing-extensions, sphinxcontrib-qthelp, sphinxcontrib-jsmath, sphinxcontrib-htmlhelp, sphinxcontrib-devhelp, sphinxcontrib-applehelp, pyyaml, mdurl, Jinja2, docutils, attrs, markdown-it-py, importlib-metadata, sphinx, mdit-py-plugins, myst_parser Attempting uninstall: Jinja2 Found existing installation: Jinja2 3.1.1 Uninstalling Jinja2-3.1.1: Successfully uninstalled Jinja2-3.1.1 Attempting uninstall: docutils Found existing installation: docutils 0.14 Uninstalling docutils-0.14: Successfully uninstalled docutils-0.14 Attempting uninstall: sphinx Found existing installation: Sphinx 1.8.6 Uninstalling Sphinx-1.8.6: Successfully uninstalled Sphinx-1.8.6 ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts. readthedocs-sphinx-ext 1.0.4 requires Jinja2>=2.9, but you have jinja2 2.7.2 which is incompatible. Successfully installed Jinja2-2.7.2 attrs-21.4.0 docutils-0.17.1 importlib-metadata-4.11.3 markdown-it-py-2.0.1 mdit-py-plugins-0.3.0 mdurl-0.1.0 myst_parser-0.17.0 pyyaml-6.0 sphinx-4.5.0 sphinxcontrib-applehelp-1.0.2 sphinxcontrib-devhelp-1.0.2 sphinxcontrib-htmlhelp-2.0.0 sphinxcontrib-jsmath-1.0.1 sphinxcontrib-qthelp-1.0.3 typing-extensions-4.1.1 zipp-3.7.0 [rtd-command-info] start-time: 2022-03-30T13:19:05.048803Z, end-time: 2022-03-30T13:19:05.123965Z, duration: 0, exit-code: 0 cat doc/source/conf.py # Configuration file for the Sphinx documentation builder. # # This file only contains a selection of the most common options. For a full # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- # 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('.')) # -- Project information ----------------------------------------------------- project = 'recoveryPortal' copyright = '2022, Michael Smith' author = 'Michael Smith' # The full version, including alpha/beta/rc tags release = '1.0.0' # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = ['myst_parser' ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This pattern also affects html_static_path and html_extra_path. exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] # -- 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 = 'alabaster' # 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'] ########################################################################### # 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': "basic-user-docs", 'version_slug': "basic-user-docs", 'MEDIA_URL': "media/", 'STATIC_URL': "/static/", 'PRODUCTION_DOMAIN': "rtd.xfel.eu", 'versions': [ ("latest", "/en/latest/"), ("basic-user-docs", "/en/basic-user-docs/"), ], 'downloads': [ ], 'subprojects': [ ], 'slug': 'recovery-portal', 'name': u'Recovery Portal', 'rtd_language': u'en', 'programming_language': u'words', 'canonical_url': 'http://rtd.xfel.eu/docs/recovery-portal/en/latest/', 'analytics_code': 'None', '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': 'basic-user-docs', 'display_github': False, 'bitbucket_user': 'None', 'bitbucket_repo': 'None', 'bitbucket_version': 'basic-user-docs', 'display_bitbucket': False, 'gitlab_user': 'None', 'gitlab_repo': 'None', 'gitlab_version': 'basic-user-docs', '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': '68c17532', } 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-03-30T13:19:05.255774Z, end-time: 2022-03-30T13:19:05.536522Z, duration: 0, exit-code: 1 python /usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/sphinx-build -T -E -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html Traceback (most recent call last): File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/bin/sphinx-build", line 5, in from sphinx.cmd.build import main File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/sphinx/cmd/build.py", line 18, in from sphinx.application import Sphinx File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/sphinx/application.py", line 24, in from sphinx.config import Config File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/sphinx/config.py", line 16, in from sphinx.util.tags import Tags File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/sphinx/util/tags.py", line 3, in from jinja2 import nodes File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/jinja2/__init__.py", line 33, in from jinja2.environment import Environment, Template File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/jinja2/environment.py", line 13, in from jinja2 import nodes File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/jinja2/nodes.py", line 18, in from jinja2.utils import Markup File "/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/jinja2/utils.py", line 520, in from markupsafe import Markup, escape, soft_unicode ImportError: cannot import name 'soft_unicode' from 'markupsafe' (/usr/src/app/checkouts/readthedocs.org/user_builds/recovery-portal/envs/basic-user-docs/lib/python3.8/site-packages/markupsafe/__init__.py)